Skip to content

Latest commit

 

History

History
2541 lines (1563 loc) · 108 KB

kmsCryptoKey.typescript.md

File metadata and controls

2541 lines (1563 loc) · 108 KB

kmsCryptoKey Submodule

Constructs

KmsCryptoKey

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key google_kms_crypto_key}.

Initializers 

import { kmsCryptoKey } from '@cdktf/provider-google'

new kmsCryptoKey.KmsCryptoKey(scope: Construct, id: string, config: KmsCryptoKeyConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config KmsCryptoKeyConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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".
putTimeouts No description.
putVersionTemplate No description.
resetCryptoKeyBackend No description.
resetDestroyScheduledDuration No description.
resetId No description.
resetImportOnly No description.
resetLabels No description.
resetPurpose No description.
resetRotationPeriod No description.
resetSkipInitialVersionCreation No description.
resetTimeouts No description.
resetVersionTemplate No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

putTimeouts 
public putTimeouts(value: KmsCryptoKeyTimeouts): void
valueRequired
putVersionTemplate 
public putVersionTemplate(value: KmsCryptoKeyVersionTemplate): void
valueRequired
resetCryptoKeyBackend 
public resetCryptoKeyBackend(): void
resetDestroyScheduledDuration 
public resetDestroyScheduledDuration(): void
resetId 
public resetId(): void
resetImportOnly 
public resetImportOnly(): void
resetLabels 
public resetLabels(): void
resetPurpose 
public resetPurpose(): void
resetRotationPeriod 
public resetRotationPeriod(): void
resetSkipInitialVersionCreation 
public resetSkipInitialVersionCreation(): void
resetTimeouts 
public resetTimeouts(): void
resetVersionTemplate 
public resetVersionTemplate(): 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 KmsCryptoKey resource upon running "cdktf plan ".
isConstruct 
import { kmsCryptoKey } from '@cdktf/provider-google'

kmsCryptoKey.KmsCryptoKey.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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { kmsCryptoKey } from '@cdktf/provider-google'

kmsCryptoKey.KmsCryptoKey.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { kmsCryptoKey } from '@cdktf/provider-google'

kmsCryptoKey.KmsCryptoKey.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { kmsCryptoKey } from '@cdktf/provider-google'

kmsCryptoKey.KmsCryptoKey.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing KmsCryptoKey that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the KmsCryptoKey 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.
effectiveLabels cdktf.StringMap No description.
primary KmsCryptoKeyPrimaryList No description.
terraformLabels cdktf.StringMap No description.
timeouts KmsCryptoKeyTimeoutsOutputReference No description.
versionTemplate KmsCryptoKeyVersionTemplateOutputReference No description.
cryptoKeyBackendInput string No description.
destroyScheduledDurationInput string No description.
idInput string No description.
importOnlyInput boolean | cdktf.IResolvable No description.
keyRingInput string No description.
labelsInput {[ key: string ]: string} No description.
nameInput string No description.
purposeInput string No description.
rotationPeriodInput string No description.
skipInitialVersionCreationInput boolean | cdktf.IResolvable No description.
timeoutsInput cdktf.IResolvable | KmsCryptoKeyTimeouts No description.
versionTemplateInput KmsCryptoKeyVersionTemplate No description.
cryptoKeyBackend string No description.
destroyScheduledDuration string No description.
id string No description.
importOnly boolean | cdktf.IResolvable No description.
keyRing string No description.
labels {[ key: string ]: string} No description.
name string No description.
purpose string No description.
rotationPeriod string No description.
skipInitialVersionCreation boolean | cdktf.IResolvable No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
effectiveLabelsRequired 
public readonly effectiveLabels: StringMap;
  • Type: cdktf.StringMap
primaryRequired 
public readonly primary: KmsCryptoKeyPrimaryList;
terraformLabelsRequired 
public readonly terraformLabels: StringMap;
  • Type: cdktf.StringMap
timeoutsRequired 
public readonly timeouts: KmsCryptoKeyTimeoutsOutputReference;
versionTemplateRequired 
public readonly versionTemplate: KmsCryptoKeyVersionTemplateOutputReference;
cryptoKeyBackendInputOptional 
public readonly cryptoKeyBackendInput: string;
  • Type: string
destroyScheduledDurationInputOptional 
public readonly destroyScheduledDurationInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
importOnlyInputOptional 
public readonly importOnlyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
keyRingInputOptional 
public readonly keyRingInput: string;
  • Type: string
labelsInputOptional 
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
nameInputOptional 
public readonly nameInput: string;
  • Type: string
purposeInputOptional 
public readonly purposeInput: string;
  • Type: string
rotationPeriodInputOptional 
public readonly rotationPeriodInput: string;
  • Type: string
skipInitialVersionCreationInputOptional 
public readonly skipInitialVersionCreationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | KmsCryptoKeyTimeouts;
versionTemplateInputOptional 
public readonly versionTemplateInput: KmsCryptoKeyVersionTemplate;
cryptoKeyBackendRequired 
public readonly cryptoKeyBackend: string;
  • Type: string
destroyScheduledDurationRequired 
public readonly destroyScheduledDuration: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
importOnlyRequired 
public readonly importOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
keyRingRequired 
public readonly keyRing: string;
  • Type: string
labelsRequired 
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
nameRequired 
public readonly name: string;
  • Type: string
purposeRequired 
public readonly purpose: string;
  • Type: string
rotationPeriodRequired 
public readonly rotationPeriod: string;
  • Type: string
skipInitialVersionCreationRequired 
public readonly skipInitialVersionCreation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

KmsCryptoKeyConfig

Initializer 

import { kmsCryptoKey } from '@cdktf/provider-google'

const kmsCryptoKeyConfig: kmsCryptoKey.KmsCryptoKeyConfig = { ... }

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.
keyRing string The KeyRing that this key belongs to. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.
name string The resource name for the CryptoKey.
cryptoKeyBackend string The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey.
destroyScheduledDuration string The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#id KmsCryptoKey#id}.
importOnly boolean | cdktf.IResolvable Whether this key may contain imported versions only.
labels {[ key: string ]: string} Labels with user-defined metadata to apply to this resource.
purpose string The immutable purpose of this CryptoKey. See the purpose reference for possible inputs. Default value is "ENCRYPT_DECRYPT".
rotationPeriod string Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.
skipInitialVersionCreation boolean | cdktf.IResolvable If set to true, the request will create a CryptoKey without any CryptoKeyVersions.
timeouts KmsCryptoKeyTimeouts timeouts block.
versionTemplate KmsCryptoKeyVersionTemplate version_template block.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
keyRingRequired 
public readonly keyRing: string;
  • Type: string

The KeyRing that this key belongs to. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#key_ring KmsCryptoKey#key_ring}

nameRequired 
public readonly name: string;
  • Type: string

The resource name for the CryptoKey.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#name KmsCryptoKey#name}

cryptoKeyBackendOptional 
public readonly cryptoKeyBackend: string;
  • Type: string

The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey.

The resource name is in the format "projects/* /locations/* /ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#crypto_key_backend KmsCryptoKey#crypto_key_backend}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

destroyScheduledDurationOptional 
public readonly destroyScheduledDuration: string;
  • Type: string

The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.

If not specified at creation time, the default duration is 30 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#destroy_scheduled_duration KmsCryptoKey#destroy_scheduled_duration}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#id KmsCryptoKey#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.

importOnlyOptional 
public readonly importOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether this key may contain imported versions only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#import_only KmsCryptoKey#import_only}

labelsOptional 
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Labels with user-defined metadata to apply to this resource.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#labels KmsCryptoKey#labels}

purposeOptional 
public readonly purpose: string;
  • Type: string

The immutable purpose of this CryptoKey. See the purpose reference for possible inputs. Default value is "ENCRYPT_DECRYPT".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#purpose KmsCryptoKey#purpose}

rotationPeriodOptional 
public readonly rotationPeriod: string;
  • Type: string

Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.

The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#rotation_period KmsCryptoKey#rotation_period}

skipInitialVersionCreationOptional 
public readonly skipInitialVersionCreation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If set to true, the request will create a CryptoKey without any CryptoKeyVersions.

You must use the 'google_kms_crypto_key_version' resource to create a new CryptoKeyVersion or 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#skip_initial_version_creation KmsCryptoKey#skip_initial_version_creation}

timeoutsOptional 
public readonly timeouts: KmsCryptoKeyTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#timeouts KmsCryptoKey#timeouts}

versionTemplateOptional 
public readonly versionTemplate: KmsCryptoKeyVersionTemplate;

version_template block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#version_template KmsCryptoKey#version_template}

KmsCryptoKeyPrimary

Initializer 

import { kmsCryptoKey } from '@cdktf/provider-google'

const kmsCryptoKeyPrimary: kmsCryptoKey.KmsCryptoKeyPrimary = { ... }

KmsCryptoKeyTimeouts

Initializer 

import { kmsCryptoKey } from '@cdktf/provider-google'

const kmsCryptoKeyTimeouts: kmsCryptoKey.KmsCryptoKeyTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#create KmsCryptoKey#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#delete KmsCryptoKey#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#update KmsCryptoKey#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#create KmsCryptoKey#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#delete KmsCryptoKey#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#update KmsCryptoKey#update}.

KmsCryptoKeyVersionTemplate

Initializer 

import { kmsCryptoKey } from '@cdktf/provider-google'

const kmsCryptoKeyVersionTemplate: kmsCryptoKey.KmsCryptoKeyVersionTemplate = { ... }

Properties

Name Type Description
algorithm string The algorithm to use when creating a version based on this template. See the algorithm reference for possible inputs.
protectionLevel string The protection level to use when creating a version based on this template.
algorithmRequired 
public readonly algorithm: string;
  • Type: string

The algorithm to use when creating a version based on this template. See the algorithm reference for possible inputs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#algorithm KmsCryptoKey#algorithm}

protectionLevelOptional 
public readonly protectionLevel: string;
  • Type: string

The protection level to use when creating a version based on this template.

Possible values include "SOFTWARE", "HSM", "EXTERNAL", "EXTERNAL_VPC". Defaults to "SOFTWARE".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/kms_crypto_key#protection_level KmsCryptoKey#protection_level}

Classes

KmsCryptoKeyPrimaryList

Initializers 

import { kmsCryptoKey } from '@cdktf/provider-google'

new kmsCryptoKey.KmsCryptoKeyPrimaryList(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).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): KmsCryptoKeyPrimaryOutputReference
indexRequired
  • 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.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string

KmsCryptoKeyPrimaryOutputReference

Initializers 

import { kmsCryptoKey } from '@cdktf/provider-google'

new kmsCryptoKey.KmsCryptoKeyPrimaryOutputReference(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).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
name string No description.
state string No description.
internalValue KmsCryptoKeyPrimary No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
stateRequired 
public readonly state: string;
  • Type: string
internalValueOptional 
public readonly internalValue: KmsCryptoKeyPrimary;

KmsCryptoKeyTimeoutsOutputReference

Initializers 

import { kmsCryptoKey } from '@cdktf/provider-google'

new kmsCryptoKey.KmsCryptoKeyTimeoutsOutputReference(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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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.
resetUpdate No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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
resetUpdate 
public resetUpdate(): 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.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | KmsCryptoKeyTimeouts No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | KmsCryptoKeyTimeouts;

KmsCryptoKeyVersionTemplateOutputReference

Initializers 

import { kmsCryptoKey } from '@cdktf/provider-google'

new kmsCryptoKey.KmsCryptoKeyVersionTemplateOutputReference(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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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.
resetProtectionLevel No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetProtectionLevel 
public resetProtectionLevel(): 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.
algorithmInput string No description.
protectionLevelInput string No description.
algorithm string No description.
protectionLevel string No description.
internalValue KmsCryptoKeyVersionTemplate No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
algorithmInputOptional 
public readonly algorithmInput: string;
  • Type: string
protectionLevelInputOptional 
public readonly protectionLevelInput: string;
  • Type: string
algorithmRequired 
public readonly algorithm: string;
  • Type: string
protectionLevelRequired 
public readonly protectionLevel: string;
  • Type: string
internalValueOptional 
public readonly internalValue: KmsCryptoKeyVersionTemplate;