Package-level declarations

Types

Link copied to clipboard
class BillingAccountBucketConfig : KotlinCustomResource

Manages a billing account level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
data class BillingAccountBucketConfigArgs(val billingAccount: Output<String>? = null, val bucketId: Output<String>? = null, val cmekSettings: Output<BillingAccountBucketConfigCmekSettingsArgs>? = null, val description: Output<String>? = null, val location: Output<String>? = null, val retentionDays: Output<Int>? = null) : ConvertibleToJava<BillingAccountBucketConfigArgs>

Manages a billing account level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
class BillingAccountExclusion : KotlinCustomResource

Billing account logging exclusions can be imported using their URI, e.g.

Link copied to clipboard
data class BillingAccountExclusionArgs(val billingAccount: Output<String>? = null, val description: Output<String>? = null, val disabled: Output<Boolean>? = null, val filter: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<BillingAccountExclusionArgs>

Billing account logging exclusions can be imported using their URI, e.g.

Link copied to clipboard
Link copied to clipboard
class BillingAccountSink : KotlinCustomResource

Billing account logging sinks can be imported using this format:

Link copied to clipboard
data class BillingAccountSinkArgs(val bigqueryOptions: Output<BillingAccountSinkBigqueryOptionsArgs>? = null, val billingAccount: Output<String>? = null, val description: Output<String>? = null, val destination: Output<String>? = null, val disabled: Output<Boolean>? = null, val exclusions: Output<List<BillingAccountSinkExclusionArgs>>? = null, val filter: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<BillingAccountSinkArgs>

Billing account logging sinks can be imported using this format:

Link copied to clipboard
Link copied to clipboard
class FolderBucketConfig : KotlinCustomResource

Manages a folder-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
data class FolderBucketConfigArgs(val bucketId: Output<String>? = null, val cmekSettings: Output<FolderBucketConfigCmekSettingsArgs>? = null, val description: Output<String>? = null, val folder: Output<String>? = null, val location: Output<String>? = null, val retentionDays: Output<Int>? = null) : ConvertibleToJava<FolderBucketConfigArgs>

Manages a folder-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
Link copied to clipboard
class FolderExclusion : KotlinCustomResource

Manages a folder-level logging exclusion. For more information see:

Link copied to clipboard
data class FolderExclusionArgs(val description: Output<String>? = null, val disabled: Output<Boolean>? = null, val filter: Output<String>? = null, val folder: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<FolderExclusionArgs>

Manages a folder-level logging exclusion. For more information see:

Link copied to clipboard
object FolderExclusionMapper : ResourceMapper<FolderExclusion>
Link copied to clipboard
class FolderSink : KotlinCustomResource

Manages a folder-level logging sink. For more information see:

Link copied to clipboard
data class FolderSinkArgs(val bigqueryOptions: Output<FolderSinkBigqueryOptionsArgs>? = null, val description: Output<String>? = null, val destination: Output<String>? = null, val disabled: Output<Boolean>? = null, val exclusions: Output<List<FolderSinkExclusionArgs>>? = null, val filter: Output<String>? = null, val folder: Output<String>? = null, val includeChildren: Output<Boolean>? = null, val name: Output<String>? = null) : ConvertibleToJava<FolderSinkArgs>

Manages a folder-level logging sink. For more information see:

Link copied to clipboard
Link copied to clipboard
object FolderSinkMapper : ResourceMapper<FolderSink>
Link copied to clipboard
Link copied to clipboard
class LinkedDataset : KotlinCustomResource

Describes a BigQuery linked dataset To get more information about LinkedDataset, see:

Link copied to clipboard
data class LinkedDatasetArgs(val bigqueryDatasets: Output<List<LinkedDatasetBigqueryDatasetArgs>>? = null, val bucket: Output<String>? = null, val description: Output<String>? = null, val linkId: Output<String>? = null, val location: Output<String>? = null, val parent: Output<String>? = null) : ConvertibleToJava<LinkedDatasetArgs>

Describes a BigQuery linked dataset To get more information about LinkedDataset, see:

Link copied to clipboard
Link copied to clipboard
object LinkedDatasetMapper : ResourceMapper<LinkedDataset>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class LogView : KotlinCustomResource

Describes a view over log entries in a bucket. To get more information about LogView, see:

Link copied to clipboard
data class LogViewArgs(val bucket: Output<String>? = null, val description: Output<String>? = null, val filter: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val parent: Output<String>? = null) : ConvertibleToJava<LogViewArgs>

Describes a view over log entries in a bucket. To get more information about LogView, see:

Link copied to clipboard
Link copied to clipboard
object LogViewMapper : ResourceMapper<LogView>
Link copied to clipboard
Link copied to clipboard
class Metric : KotlinCustomResource

Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options. To get more information about Metric, see:

Link copied to clipboard
data class MetricArgs(val bucketName: Output<String>? = null, val bucketOptions: Output<MetricBucketOptionsArgs>? = null, val description: Output<String>? = null, val disabled: Output<Boolean>? = null, val filter: Output<String>? = null, val labelExtractors: Output<Map<String, String>>? = null, val metricDescriptor: Output<MetricMetricDescriptorArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val valueExtractor: Output<String>? = null) : ConvertibleToJava<MetricArgs>

Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options. To get more information about Metric, see:

Link copied to clipboard

Builder for MetricArgs.

Link copied to clipboard
object MetricMapper : ResourceMapper<Metric>
Link copied to clipboard

Builder for Metric.

Link copied to clipboard
class OrganizationBucketConfig : KotlinCustomResource

Manages a organization-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
data class OrganizationBucketConfigArgs(val bucketId: Output<String>? = null, val cmekSettings: Output<OrganizationBucketConfigCmekSettingsArgs>? = null, val description: Output<String>? = null, val location: Output<String>? = null, val organization: Output<String>? = null, val retentionDays: Output<Int>? = null) : ConvertibleToJava<OrganizationBucketConfigArgs>

Manages a organization-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
class OrganizationExclusion : KotlinCustomResource

Manages an organization-level logging exclusion. For more information see:

Link copied to clipboard
data class OrganizationExclusionArgs(val description: Output<String>? = null, val disabled: Output<Boolean>? = null, val filter: Output<String>? = null, val name: Output<String>? = null, val orgId: Output<String>? = null) : ConvertibleToJava<OrganizationExclusionArgs>

Manages an organization-level logging exclusion. For more information see:

Link copied to clipboard
Link copied to clipboard
class OrganizationSink : KotlinCustomResource

Manages a organization-level logging sink. For more information see:

Link copied to clipboard
data class OrganizationSinkArgs(val bigqueryOptions: Output<OrganizationSinkBigqueryOptionsArgs>? = null, val description: Output<String>? = null, val destination: Output<String>? = null, val disabled: Output<Boolean>? = null, val exclusions: Output<List<OrganizationSinkExclusionArgs>>? = null, val filter: Output<String>? = null, val includeChildren: Output<Boolean>? = null, val name: Output<String>? = null, val orgId: Output<String>? = null) : ConvertibleToJava<OrganizationSinkArgs>

Manages a organization-level logging sink. For more information see:

Link copied to clipboard
object OrganizationSinkMapper : ResourceMapper<OrganizationSink>
Link copied to clipboard
class ProjectBucketConfig : KotlinCustomResource

Manages a project-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
data class ProjectBucketConfigArgs(val bucketId: Output<String>? = null, val cmekSettings: Output<ProjectBucketConfigCmekSettingsArgs>? = null, val description: Output<String>? = null, val enableAnalytics: Output<Boolean>? = null, val location: Output<String>? = null, val locked: Output<Boolean>? = null, val project: Output<String>? = null, val retentionDays: Output<Int>? = null) : ConvertibleToJava<ProjectBucketConfigArgs>

Manages a project-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Link copied to clipboard
Link copied to clipboard
class ProjectExclusion : KotlinCustomResource

Manages a project-level logging exclusion. For more information see:

Link copied to clipboard
data class ProjectExclusionArgs(val description: Output<String>? = null, val disabled: Output<Boolean>? = null, val filter: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ProjectExclusionArgs>

Manages a project-level logging exclusion. For more information see:

Link copied to clipboard
object ProjectExclusionMapper : ResourceMapper<ProjectExclusion>
Link copied to clipboard
class ProjectSink : KotlinCustomResource

Project-level logging sinks can be imported using their URI, e.g.

Link copied to clipboard
data class ProjectSinkArgs(val bigqueryOptions: Output<ProjectSinkBigqueryOptionsArgs>? = null, val description: Output<String>? = null, val destination: Output<String>? = null, val disabled: Output<Boolean>? = null, val exclusions: Output<List<ProjectSinkExclusionArgs>>? = null, val filter: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val uniqueWriterIdentity: Output<Boolean>? = null) : ConvertibleToJava<ProjectSinkArgs>

Project-level logging sinks can be imported using their URI, e.g.

Link copied to clipboard
Link copied to clipboard
object ProjectSinkMapper : ResourceMapper<ProjectSink>
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
suspend fun folderSink(name: String, block: suspend FolderSinkResourceBuilder.() -> Unit): FolderSink
Link copied to clipboard
Link copied to clipboard
fun logView(name: String): LogView
suspend fun logView(name: String, block: suspend LogViewResourceBuilder.() -> Unit): LogView
Link copied to clipboard
fun metric(name: String): Metric
suspend fun metric(name: String, block: suspend MetricResourceBuilder.() -> Unit): Metric
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun projectSink(name: String, block: suspend ProjectSinkResourceBuilder.() -> Unit): ProjectSink