`googleBigtableGcPolicy` Submodule

Constructs

GoogleBigtableGcPolicy

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

Initializers

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

new googleBigtableGcPolicy.GoogleBigtableGcPolicy(scope: Construct, id: string, config: GoogleBigtableGcPolicyConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GoogleBigtableGcPolicyConfig`	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: GoogleBigtableGcPolicyConfig

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".
`putMaxAge`	No description.
`putMaxVersion`	No description.
`putTimeouts`	No description.
`resetDeletionPolicy`	No description.
`resetGcRules`	No description.
`resetId`	No description.
`resetIgnoreWarnings`	No description.
`resetMaxAge`	No description.
`resetMaxVersion`	No description.
`resetMode`	No description.
`resetProject`	No description.
`resetTimeouts`	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".

`putMaxAge`

public putMaxAge(value: GoogleBigtableGcPolicyMaxAge): void

`value`^Required

Type: GoogleBigtableGcPolicyMaxAge

`putMaxVersion`

public putMaxVersion(value: IResolvable | GoogleBigtableGcPolicyMaxVersion[]): void

`value`^Required

Type: cdktf.IResolvable | GoogleBigtableGcPolicyMaxVersion[]

`putTimeouts`

public putTimeouts(value: GoogleBigtableGcPolicyTimeouts): void

`value`^Required

Type: GoogleBigtableGcPolicyTimeouts

`resetDeletionPolicy`

public resetDeletionPolicy(): void

`resetGcRules`

public resetGcRules(): void

`resetId`

public resetId(): void

`resetIgnoreWarnings`

public resetIgnoreWarnings(): void

`resetMaxAge`

public resetMaxAge(): void

`resetMaxVersion`

public resetMaxVersion(): void

`resetMode`

public resetMode(): void

`resetProject`

public resetProject(): void

`resetTimeouts`

public resetTimeouts(): 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 GoogleBigtableGcPolicy resource upon running "cdktf plan ".

`isConstruct`

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

googleBigtableGcPolicy.GoogleBigtableGcPolicy.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 { googleBigtableGcPolicy } from '@cdktf/provider-google-beta'

googleBigtableGcPolicy.GoogleBigtableGcPolicy.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

googleBigtableGcPolicy.GoogleBigtableGcPolicy.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

googleBigtableGcPolicy.GoogleBigtableGcPolicy.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleBigtableGcPolicy 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 GoogleBigtableGcPolicy to import.

`importFromId`^Required

Type: string

The id of the existing GoogleBigtableGcPolicy that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_bigtable_gc_policy#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 GoogleBigtableGcPolicy 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.
`maxAge`	`GoogleBigtableGcPolicyMaxAgeOutputReference`	No description.
`maxVersion`	`GoogleBigtableGcPolicyMaxVersionList`	No description.
`timeouts`	`GoogleBigtableGcPolicyTimeoutsOutputReference`	No description.
`columnFamilyInput`	`string`	No description.
`deletionPolicyInput`	`string`	No description.
`gcRulesInput`	`string`	No description.
`idInput`	`string`	No description.
`ignoreWarningsInput`	`boolean \| cdktf.IResolvable`	No description.
`instanceNameInput`	`string`	No description.
`maxAgeInput`	`GoogleBigtableGcPolicyMaxAge`	No description.
`maxVersionInput`	`cdktf.IResolvable \| GoogleBigtableGcPolicyMaxVersion[]`	No description.
`modeInput`	`string`	No description.
`projectInput`	`string`	No description.
`tableInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleBigtableGcPolicyTimeouts`	No description.
`columnFamily`	`string`	No description.
`deletionPolicy`	`string`	No description.
`gcRules`	`string`	No description.
`id`	`string`	No description.
`ignoreWarnings`	`boolean \| cdktf.IResolvable`	No description.
`instanceName`	`string`	No description.
`mode`	`string`	No description.
`project`	`string`	No description.
`table`	`string`	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[]

`maxAge`^Required

public readonly maxAge: GoogleBigtableGcPolicyMaxAgeOutputReference;

Type: GoogleBigtableGcPolicyMaxAgeOutputReference

`maxVersion`^Required

public readonly maxVersion: GoogleBigtableGcPolicyMaxVersionList;

Type: GoogleBigtableGcPolicyMaxVersionList

`timeouts`^Required

public readonly timeouts: GoogleBigtableGcPolicyTimeoutsOutputReference;

Type: GoogleBigtableGcPolicyTimeoutsOutputReference

`columnFamilyInput`^Optional

public readonly columnFamilyInput: string;

Type: string

`deletionPolicyInput`^Optional

public readonly deletionPolicyInput: string;

Type: string

`gcRulesInput`^Optional

public readonly gcRulesInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`ignoreWarningsInput`^Optional

public readonly ignoreWarningsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`instanceNameInput`^Optional

public readonly instanceNameInput: string;

Type: string

`maxAgeInput`^Optional

public readonly maxAgeInput: GoogleBigtableGcPolicyMaxAge;

Type: GoogleBigtableGcPolicyMaxAge

`maxVersionInput`^Optional

public readonly maxVersionInput: IResolvable | GoogleBigtableGcPolicyMaxVersion[];

Type: cdktf.IResolvable | GoogleBigtableGcPolicyMaxVersion[]

`modeInput`^Optional

public readonly modeInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`tableInput`^Optional

public readonly tableInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleBigtableGcPolicyTimeouts;

Type: cdktf.IResolvable | GoogleBigtableGcPolicyTimeouts

`columnFamily`^Required

public readonly columnFamily: string;

Type: string

`deletionPolicy`^Required

public readonly deletionPolicy: string;

Type: string

`gcRules`^Required

public readonly gcRules: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`ignoreWarnings`^Required

public readonly ignoreWarnings: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`instanceName`^Required

public readonly instanceName: string;

Type: string

`mode`^Required

public readonly mode: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`table`^Required

public readonly table: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleBigtableGcPolicyConfig

Initializer

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

const googleBigtableGcPolicyConfig: googleBigtableGcPolicy.GoogleBigtableGcPolicyConfig = { ... }

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.
`columnFamily`	`string`	The name of the column family.
`instanceName`	`string`	The name of the Bigtable instance.
`table`	`string`	The name of the table.
`deletionPolicy`	`string`	The deletion policy for the GC policy.
`gcRules`	`string`	Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version".
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_bigtable_gc_policy#id GoogleBigtableGcPolicy#id}.
`ignoreWarnings`	`boolean \| cdktf.IResolvable`	Allows ignoring warnings when updating the GC policy.
`maxAge`	`GoogleBigtableGcPolicyMaxAge`	max_age block.
`maxVersion`	`cdktf.IResolvable \| GoogleBigtableGcPolicyMaxVersion[]`	max_version block.
`mode`	`string`	NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources.
`project`	`string`	The ID of the project in which the resource belongs.
`timeouts`	`GoogleBigtableGcPolicyTimeouts`	timeouts block.

`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[]

`columnFamily`^Required

public readonly columnFamily: string;

Type: string

The name of the column family.

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

`instanceName`^Required

public readonly instanceName: string;

Type: string

The name of the Bigtable instance.

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

`table`^Required

public readonly table: string;

Type: string

The name of the table.

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

`deletionPolicy`^Optional

public readonly deletionPolicy: string;

Type: string

The deletion policy for the GC policy.

Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted in a replicated instance. Possible values are: "ABANDON".

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

`gcRules`^Optional

public readonly gcRules: string;

Type: string

Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version".

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

`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_bigtable_gc_policy#id GoogleBigtableGcPolicy#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.

`ignoreWarnings`^Optional

public readonly ignoreWarnings: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Allows ignoring warnings when updating the GC policy.

This can be used to increase the gc policy on replicated clusters. Doing this may make clusters be inconsistent for a longer period of time, before using this make sure you understand the risks listed at https://cloud.google.com/bigtable/docs/garbage-collection#increasing

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

`maxAge`^Optional

public readonly maxAge: GoogleBigtableGcPolicyMaxAge;

Type: GoogleBigtableGcPolicyMaxAge

max_age block.

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

`maxVersion`^Optional

public readonly maxVersion: IResolvable | GoogleBigtableGcPolicyMaxVersion[];

Type: cdktf.IResolvable | GoogleBigtableGcPolicyMaxVersion[]

max_version block.

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

`mode`^Optional

public readonly mode: string;

Type: string

NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources.

This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION.

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

`project`^Optional

public readonly project: string;

Type: string

The ID of the project in which the resource belongs.

If it is not provided, the provider project is used.

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

`timeouts`^Optional

public readonly timeouts: GoogleBigtableGcPolicyTimeouts;

Type: GoogleBigtableGcPolicyTimeouts

timeouts block.

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

GoogleBigtableGcPolicyMaxAge

Initializer

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

const googleBigtableGcPolicyMaxAge: googleBigtableGcPolicy.GoogleBigtableGcPolicyMaxAge = { ... }

Properties

Name	Type	Description
`days`	`number`	Number of days before applying GC policy.
`duration`	`string`	Duration before applying GC policy.

`days`^Optional

public readonly days: number;

Type: number

Number of days before applying GC policy.

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

`duration`^Optional

public readonly duration: string;

Type: string

Duration before applying GC policy.

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

GoogleBigtableGcPolicyMaxVersion

Initializer

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

const googleBigtableGcPolicyMaxVersion: googleBigtableGcPolicy.GoogleBigtableGcPolicyMaxVersion = { ... }

Properties

Name	Type	Description
`number`	`number`	Number of version before applying the GC policy.

`number`^Required

public readonly number: number;

Type: number

Number of version before applying the GC policy.

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

GoogleBigtableGcPolicyTimeouts

Initializer

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

const googleBigtableGcPolicyTimeouts: googleBigtableGcPolicy.GoogleBigtableGcPolicyTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_bigtable_gc_policy#create GoogleBigtableGcPolicy#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_bigtable_gc_policy#delete GoogleBigtableGcPolicy#delete}.

`create`^Optional

public readonly create: string;

Type: string

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

`delete`^Optional

public readonly delete: string;

Type: string

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

Classes

GoogleBigtableGcPolicyMaxAgeOutputReference

Initializers

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

new googleBigtableGcPolicy.GoogleBigtableGcPolicyMaxAgeOutputReference(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.
`resetDays`	No description.
`resetDuration`	No description.

`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.

`resetDays`

public resetDays(): void

`resetDuration`

public resetDuration(): void

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.
`daysInput`	`number`	No description.
`durationInput`	`string`	No description.
`days`	`number`	No description.
`duration`	`string`	No description.
`internalValue`	`GoogleBigtableGcPolicyMaxAge`	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

`daysInput`^Optional

public readonly daysInput: number;

Type: number

`durationInput`^Optional

public readonly durationInput: string;

Type: string

`days`^Required

public readonly days: number;

Type: number

`duration`^Required

public readonly duration: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleBigtableGcPolicyMaxAge;

Type: GoogleBigtableGcPolicyMaxAge

GoogleBigtableGcPolicyMaxVersionList

Initializers

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

new googleBigtableGcPolicy.GoogleBigtableGcPolicyMaxVersionList(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): GoogleBigtableGcPolicyMaxVersionOutputReference

`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 \| GoogleBigtableGcPolicyMaxVersion[]`	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 | GoogleBigtableGcPolicyMaxVersion[];

Type: cdktf.IResolvable | GoogleBigtableGcPolicyMaxVersion[]

GoogleBigtableGcPolicyMaxVersionOutputReference

Initializers

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

new googleBigtableGcPolicy.GoogleBigtableGcPolicyMaxVersionOutputReference(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.
`numberInput`	`number`	No description.
`number`	`number`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleBigtableGcPolicyMaxVersion`	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

`numberInput`^Optional

public readonly numberInput: number;

Type: number

`number`^Required

public readonly number: number;

Type: number

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableGcPolicyMaxVersion;

Type: cdktf.IResolvable | GoogleBigtableGcPolicyMaxVersion

GoogleBigtableGcPolicyTimeoutsOutputReference

Initializers

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

new googleBigtableGcPolicy.GoogleBigtableGcPolicyTimeoutsOutputReference(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.
`resetCreate`	No description.
`resetDelete`	No description.

`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.

`resetCreate`

public resetCreate(): void

`resetDelete`

public resetDelete(): void

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.
`createInput`	`string`	No description.
`deleteInput`	`string`	No description.
`create`	`string`	No description.
`delete`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleBigtableGcPolicyTimeouts`	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

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableGcPolicyTimeouts;

Type: cdktf.IResolvable | GoogleBigtableGcPolicyTimeouts

Files

googleBigtableGcPolicy.typescript.md

Latest commit

History

googleBigtableGcPolicy.typescript.md

File metadata and controls

googleBigtableGcPolicy Submodule

Constructs