`googleLoggingProjectBucketConfig` Submodule

Constructs

GoogleLoggingProjectBucketConfig

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config google_logging_project_bucket_config}.

Initializers

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

new googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfig(scope: Construct, id: string, config: GoogleLoggingProjectBucketConfigConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GoogleLoggingProjectBucketConfigConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GoogleLoggingProjectBucketConfigConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putCmekSettings`	No description.
`putIndexConfigs`	No description.
`resetCmekSettings`	No description.
`resetDescription`	No description.
`resetEnableAnalytics`	No description.
`resetId`	No description.
`resetIndexConfigs`	No description.
`resetLocked`	No description.
`resetRetentionDays`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putCmekSettings`

public putCmekSettings(value: GoogleLoggingProjectBucketConfigCmekSettings): void

`value`^Required

Type: GoogleLoggingProjectBucketConfigCmekSettings

`putIndexConfigs`

public putIndexConfigs(value: IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[]): void

`value`^Required

Type: cdktf.IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[]

`resetCmekSettings`

public resetCmekSettings(): void

`resetDescription`

public resetDescription(): void

`resetEnableAnalytics`

public resetEnableAnalytics(): void

`resetId`

public resetId(): void

`resetIndexConfigs`

public resetIndexConfigs(): void

`resetLocked`

public resetLocked(): void

`resetRetentionDays`

public resetRetentionDays(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a GoogleLoggingProjectBucketConfig resource upon running "cdktf plan ".

`isConstruct`

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfig.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfig.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfig.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfig.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleLoggingProjectBucketConfig resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the GoogleLoggingProjectBucketConfig to import.

`importFromId`^Required

Type: string

The id of the existing GoogleLoggingProjectBucketConfig that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleLoggingProjectBucketConfig to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`cmekSettings`	`GoogleLoggingProjectBucketConfigCmekSettingsOutputReference`	No description.
`indexConfigs`	`GoogleLoggingProjectBucketConfigIndexConfigsList`	No description.
`lifecycleState`	`string`	No description.
`name`	`string`	No description.
`bucketIdInput`	`string`	No description.
`cmekSettingsInput`	`GoogleLoggingProjectBucketConfigCmekSettings`	No description.
`descriptionInput`	`string`	No description.
`enableAnalyticsInput`	`boolean \| cdktf.IResolvable`	No description.
`idInput`	`string`	No description.
`indexConfigsInput`	`cdktf.IResolvable \| GoogleLoggingProjectBucketConfigIndexConfigs[]`	No description.
`locationInput`	`string`	No description.
`lockedInput`	`boolean \| cdktf.IResolvable`	No description.
`projectInput`	`string`	No description.
`retentionDaysInput`	`number`	No description.
`bucketId`	`string`	No description.
`description`	`string`	No description.
`enableAnalytics`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`location`	`string`	No description.
`locked`	`boolean \| cdktf.IResolvable`	No description.
`project`	`string`	No description.
`retentionDays`	`number`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`cmekSettings`^Required

public readonly cmekSettings: GoogleLoggingProjectBucketConfigCmekSettingsOutputReference;

Type: GoogleLoggingProjectBucketConfigCmekSettingsOutputReference

`indexConfigs`^Required

public readonly indexConfigs: GoogleLoggingProjectBucketConfigIndexConfigsList;

Type: GoogleLoggingProjectBucketConfigIndexConfigsList

`lifecycleState`^Required

public readonly lifecycleState: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`bucketIdInput`^Optional

public readonly bucketIdInput: string;

Type: string

`cmekSettingsInput`^Optional

public readonly cmekSettingsInput: GoogleLoggingProjectBucketConfigCmekSettings;

Type: GoogleLoggingProjectBucketConfigCmekSettings

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`enableAnalyticsInput`^Optional

public readonly enableAnalyticsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`idInput`^Optional

public readonly idInput: string;

Type: string

`indexConfigsInput`^Optional

public readonly indexConfigsInput: IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[];

Type: cdktf.IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[]

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`lockedInput`^Optional

public readonly lockedInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`retentionDaysInput`^Optional

public readonly retentionDaysInput: number;

Type: number

`bucketId`^Required

public readonly bucketId: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`enableAnalytics`^Required

public readonly enableAnalytics: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`location`^Required

public readonly location: string;

Type: string

`locked`^Required

public readonly locked: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`project`^Required

public readonly project: string;

Type: string

`retentionDays`^Required

public readonly retentionDays: number;

Type: number

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleLoggingProjectBucketConfigCmekSettings

Initializer

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

const googleLoggingProjectBucketConfigCmekSettings: googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfigCmekSettings = { ... }

Properties

Name	Type	Description
`kmsKeyName`	`string`	The resource name for the configured Cloud KMS key.

`kmsKeyName`^Required

public readonly kmsKeyName: string;

Type: string

The resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#kms_key_name GoogleLoggingProjectBucketConfig#kms_key_name}

GoogleLoggingProjectBucketConfigConfig

Initializer

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

const googleLoggingProjectBucketConfigConfig: googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfigConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`bucketId`	`string`	The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
`location`	`string`	The location of the bucket.
`project`	`string`	The parent project that contains the logging bucket.
`cmekSettings`	`GoogleLoggingProjectBucketConfigCmekSettings`	cmek_settings block.
`description`	`string`	An optional description for this bucket.
`enableAnalytics`	`boolean \| cdktf.IResolvable`	Enable log analytics for the bucket. Cannot be disabled once enabled.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#id GoogleLoggingProjectBucketConfig#id}.
`indexConfigs`	`cdktf.IResolvable \| GoogleLoggingProjectBucketConfigIndexConfigs[]`	index_configs block.
`locked`	`boolean \| cdktf.IResolvable`	Whether the bucket is locked.
`retentionDays`	`number`	Logs will be retained by default for this amount of time, after which they will automatically be deleted.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`bucketId`^Required

public readonly bucketId: string;

Type: string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#bucket_id GoogleLoggingProjectBucketConfig#bucket_id}

`location`^Required

public readonly location: string;

Type: string

The location of the bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#location GoogleLoggingProjectBucketConfig#location}

`project`^Required

public readonly project: string;

Type: string

The parent project that contains the logging bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#project GoogleLoggingProjectBucketConfig#project}

`cmekSettings`^Optional

public readonly cmekSettings: GoogleLoggingProjectBucketConfigCmekSettings;

Type: GoogleLoggingProjectBucketConfigCmekSettings

cmek_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#cmek_settings GoogleLoggingProjectBucketConfig#cmek_settings}

`description`^Optional

public readonly description: string;

Type: string

An optional description for this bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#description GoogleLoggingProjectBucketConfig#description}

`enableAnalytics`^Optional

public readonly enableAnalytics: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable log analytics for the bucket. Cannot be disabled once enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#enable_analytics GoogleLoggingProjectBucketConfig#enable_analytics}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#id GoogleLoggingProjectBucketConfig#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`indexConfigs`^Optional

public readonly indexConfigs: IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[];

Type: cdktf.IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[]

index_configs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#index_configs GoogleLoggingProjectBucketConfig#index_configs}

`locked`^Optional

public readonly locked: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Whether the bucket is locked.

The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#locked GoogleLoggingProjectBucketConfig#locked}

`retentionDays`^Optional

public readonly retentionDays: number;

Type: number

Logs will be retained by default for this amount of time, after which they will automatically be deleted.

The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#retention_days GoogleLoggingProjectBucketConfig#retention_days}

GoogleLoggingProjectBucketConfigIndexConfigs

Initializer

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

const googleLoggingProjectBucketConfigIndexConfigs: googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfigIndexConfigs = { ... }

Properties

Name	Type	Description
`fieldPath`	`string`	The LogEntry field path to index.
`type`	`string`	The type of data in this index Note that some paths are automatically indexed, and other paths are not eligible for indexing.

`fieldPath`^Required

public readonly fieldPath: string;

Type: string

The LogEntry field path to index.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#field_path GoogleLoggingProjectBucketConfig#field_path}

`type`^Required

public readonly type: string;

Type: string

The type of data in this index Note that some paths are automatically indexed, and other paths are not eligible for indexing.

See indexing documentation for details. For example: jsonPayload.request.status

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_logging_project_bucket_config#type GoogleLoggingProjectBucketConfig#type}

Classes

GoogleLoggingProjectBucketConfigCmekSettingsOutputReference

Initializers

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

new googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfigCmekSettingsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`kmsKeyVersionName`	`string`	No description.
`name`	`string`	No description.
`serviceAccountId`	`string`	No description.
`kmsKeyNameInput`	`string`	No description.
`kmsKeyName`	`string`	No description.
`internalValue`	`GoogleLoggingProjectBucketConfigCmekSettings`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`kmsKeyVersionName`^Required

public readonly kmsKeyVersionName: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`serviceAccountId`^Required

public readonly serviceAccountId: string;

Type: string

`kmsKeyNameInput`^Optional

public readonly kmsKeyNameInput: string;

Type: string

`kmsKeyName`^Required

public readonly kmsKeyName: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleLoggingProjectBucketConfigCmekSettings;

Type: GoogleLoggingProjectBucketConfigCmekSettings

GoogleLoggingProjectBucketConfigIndexConfigsList

Initializers

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

new googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfigIndexConfigsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): GoogleLoggingProjectBucketConfigIndexConfigsOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleLoggingProjectBucketConfigIndexConfigs[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[];

Type: cdktf.IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs[]

GoogleLoggingProjectBucketConfigIndexConfigsOutputReference

Initializers

import { googleLoggingProjectBucketConfig } from '@cdktf/provider-google-beta'

new googleLoggingProjectBucketConfig.GoogleLoggingProjectBucketConfigIndexConfigsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`fieldPathInput`	`string`	No description.
`typeInput`	`string`	No description.
`fieldPath`	`string`	No description.
`type`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleLoggingProjectBucketConfigIndexConfigs`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`fieldPathInput`^Optional

public readonly fieldPathInput: string;

Type: string

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`fieldPath`^Required

public readonly fieldPath: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs;

Type: cdktf.IResolvable | GoogleLoggingProjectBucketConfigIndexConfigs

Files

googleLoggingProjectBucketConfig.typescript.md

Latest commit

History

googleLoggingProjectBucketConfig.typescript.md

File metadata and controls

googleLoggingProjectBucketConfig Submodule

Constructs