kmsCryptoKey.go.md

kmsCryptoKey Submodule

Constructs

KmsCryptoKey

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

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.NewKmsCryptoKey(scope Construct, id *string, config KmsCryptoKeyConfig) KmsCryptoKey

Name	Type	Description
scope	github.com/aws/constructs-go/constructs/v10.Construct	The scope in which to define this construct.
id	*string	The scoped construct ID.
config	KmsCryptoKeyConfig	No description.

---

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.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: KmsCryptoKeyConfig

---

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

func ToString() *string

Returns a string representation of this construct.

AddOverride

func AddOverride(path *string, value interface{})

path^Required

• Type: *string

---

value^Required

• Type: interface{}

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

func ResetOverrideLogicalId()

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

ToHclTerraform

func ToHclTerraform() interface{}

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget

func AddMoveTarget(moveTarget *string)

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

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

HasResourceMove

func HasResourceMove() interface{}

ImportFrom

func ImportFrom(id *string, provider TerraformProvider)

id^Required

• Type: *string

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

InterpolationForAttribute

func InterpolationForAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

MoveFromId

func MoveFromId(id *string)

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

func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

---

MoveToId

func MoveToId(id *string)

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

---

PutTimeouts

func PutTimeouts(value KmsCryptoKeyTimeouts)

value^Required

• Type: KmsCryptoKeyTimeouts

---

PutVersionTemplate

func PutVersionTemplate(value KmsCryptoKeyVersionTemplate)

value^Required

• Type: KmsCryptoKeyVersionTemplate

---

ResetCryptoKeyBackend

func ResetCryptoKeyBackend()

ResetDestroyScheduledDuration

func ResetDestroyScheduledDuration()

ResetId

func ResetId()

ResetImportOnly

func ResetImportOnly()

ResetLabels

func ResetLabels()

ResetPurpose

func ResetPurpose()

ResetRotationPeriod

func ResetRotationPeriod()

ResetSkipInitialVersionCreation

func ResetSkipInitialVersionCreation()

ResetTimeouts

func ResetTimeouts()

ResetVersionTemplate

func ResetVersionTemplate()

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 "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.KmsCryptoKey_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

---

IsTerraformElement

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.KmsCryptoKey_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

---

IsTerraformResource

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.KmsCryptoKey_IsTerraformResource(x interface{}) *bool

x^Required

• Type: interface{}

---

GenerateConfigForImport

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.KmsCryptoKey_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: *string

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

---

importFromId^Required

• Type: *string

The id of the existing KmsCryptoKey that should be imported.

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

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	github.com/aws/constructs-go/constructs/v10.Node	The tree node.
CdktfStack	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack	No description.
Fqn	*string	No description.
FriendlyUniqueId	*string	No description.
TerraformMetaArguments	*map[string]interface{}	No description.
TerraformResourceType	*string	No description.
TerraformGeneratorMetadata	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]*string	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	No description.
EffectiveLabels	github.com/hashicorp/terraform-cdk-go/cdktf.StringMap	No description.
Primary	KmsCryptoKeyPrimaryList	No description.
TerraformLabels	github.com/hashicorp/terraform-cdk-go/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	interface{}	No description.
KeyRingInput	*string	No description.
LabelsInput	*map[string]*string	No description.
NameInput	*string	No description.
PurposeInput	*string	No description.
RotationPeriodInput	*string	No description.
SkipInitialVersionCreationInput	interface{}	No description.
TimeoutsInput	interface{}	No description.
VersionTemplateInput	KmsCryptoKeyVersionTemplate	No description.
CryptoKeyBackend	*string	No description.
DestroyScheduledDuration	*string	No description.
Id	*string	No description.
ImportOnly	interface{}	No description.
KeyRing	*string	No description.
Labels	*map[string]*string	No description.
Name	*string	No description.
Purpose	*string	No description.
RotationPeriod	*string	No description.
SkipInitialVersionCreation	interface{}	No description.

---

Node^Required

func Node() Node

• Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

---

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

---

Fqn^Required

func Fqn() *string

• Type: *string

---

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

---

TerraformMetaArguments^Required

func TerraformMetaArguments() *map[string]interface{}

• Type: *map[string]interface{}

---

TerraformResourceType^Required

func TerraformResourceType() *string

• Type: *string

---

TerraformGeneratorMetadata^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

func Connection() interface{}

• Type: interface{}

---

Count^Optional

func Count() interface{}

• Type: interface{}

---

DependsOn^Optional

func DependsOn() *[]*string

• Type: *[]*string

---

ForEach^Optional

func ForEach() ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

func Lifecycle() TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

func Provider() TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

func Provisioners() *[]interface{}

• Type: *[]interface{}

---

EffectiveLabels^Required

func EffectiveLabels() StringMap

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

---

Primary^Required

func Primary() KmsCryptoKeyPrimaryList

• Type: KmsCryptoKeyPrimaryList

---

TerraformLabels^Required

func TerraformLabels() StringMap

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

---

Timeouts^Required

func Timeouts() KmsCryptoKeyTimeoutsOutputReference

• Type: KmsCryptoKeyTimeoutsOutputReference

---

VersionTemplate^Required

func VersionTemplate() KmsCryptoKeyVersionTemplateOutputReference

• Type: KmsCryptoKeyVersionTemplateOutputReference

---

CryptoKeyBackendInput^Optional

func CryptoKeyBackendInput() *string

• Type: *string

---

DestroyScheduledDurationInput^Optional

func DestroyScheduledDurationInput() *string

• Type: *string

---

IdInput^Optional

func IdInput() *string

• Type: *string

---

ImportOnlyInput^Optional

func ImportOnlyInput() interface{}

• Type: interface{}

---

KeyRingInput^Optional

func KeyRingInput() *string

• Type: *string

---

LabelsInput^Optional

func LabelsInput() *map[string]*string

• Type: *map[string]*string

---

NameInput^Optional

func NameInput() *string

• Type: *string

---

PurposeInput^Optional

func PurposeInput() *string

• Type: *string

---

RotationPeriodInput^Optional

func RotationPeriodInput() *string

• Type: *string

---

SkipInitialVersionCreationInput^Optional

func SkipInitialVersionCreationInput() interface{}

• Type: interface{}

---

TimeoutsInput^Optional

func TimeoutsInput() interface{}

• Type: interface{}

---

VersionTemplateInput^Optional

func VersionTemplateInput() KmsCryptoKeyVersionTemplate

• Type: KmsCryptoKeyVersionTemplate

---

CryptoKeyBackend^Required

func CryptoKeyBackend() *string

• Type: *string

---

DestroyScheduledDuration^Required

func DestroyScheduledDuration() *string

• Type: *string

---

Id^Required

func Id() *string

• Type: *string

---

ImportOnly^Required

func ImportOnly() interface{}

• Type: interface{}

---

KeyRing^Required

func KeyRing() *string

• Type: *string

---

Labels^Required

func Labels() *map[string]*string

• Type: *map[string]*string

---

Name^Required

func Name() *string

• Type: *string

---

Purpose^Required

func Purpose() *string

• Type: *string

---

RotationPeriod^Required

func RotationPeriod() *string

• Type: *string

---

SkipInitialVersionCreation^Required

func SkipInitialVersionCreation() interface{}

• Type: interface{}

---

Constants

Name	Type	Description
TfResourceType	*string	No description.

---

TfResourceType^Required

func TfResourceType() *string

• Type: *string

---

Structs

KmsCryptoKeyConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

&kmscryptokey.KmsCryptoKeyConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	KeyRing: *string,
	Name: *string,
	CryptoKeyBackend: *string,
	DestroyScheduledDuration: *string,
	Id: *string,
	ImportOnly: interface{},
	Labels: *map[string]*string,
	Purpose: *string,
	RotationPeriod: *string,
	SkipInitialVersionCreation: interface{},
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.kmsCryptoKey.KmsCryptoKeyTimeouts,
	VersionTemplate: github.com/cdktf/cdktf-provider-google-go/google/v14.kmsCryptoKey.KmsCryptoKeyVersionTemplate,
}

Properties

Name	Type	Description
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	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.14.1/docs/resources/kms_crypto_key#id KmsCryptoKey#id}.
ImportOnly	interface{}	Whether this key may contain imported versions only.
Labels	*map[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	interface{}	If set to true, the request will create a CryptoKey without any CryptoKeyVersions.
Timeouts	KmsCryptoKeyTimeouts	timeouts block.
VersionTemplate	KmsCryptoKeyVersionTemplate	version_template block.

---

Connection^Optional

Connection interface{}

• Type: interface{}

---

Count^Optional

Count interface{}

• Type: interface{}

---

DependsOn^Optional

DependsOn *[]ITerraformDependable

• Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

---

ForEach^Optional

ForEach ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

Lifecycle TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

Provider TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

Provisioners *[]interface{}

• Type: *[]interface{}

---

KeyRing^Required

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.14.1/docs/resources/kms_crypto_key#key_ring KmsCryptoKey#key_ring}

---

Name^Required

Name *string

• Type: *string

The resource name for the CryptoKey.

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

---

CryptoKeyBackend^Optional

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.14.1/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.

---

DestroyScheduledDuration^Optional

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.14.1/docs/resources/kms_crypto_key#destroy_scheduled_duration KmsCryptoKey#destroy_scheduled_duration}

---

Id^Optional

Id *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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.

---

ImportOnly^Optional

ImportOnly interface{}

• Type: interface{}

Whether this key may contain imported versions only.

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

---

Labels^Optional

Labels *map[string]*string

• Type: *map[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.14.1/docs/resources/kms_crypto_key#labels KmsCryptoKey#labels}

---

Purpose^Optional

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.14.1/docs/resources/kms_crypto_key#purpose KmsCryptoKey#purpose}

---

RotationPeriod^Optional

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.14.1/docs/resources/kms_crypto_key#rotation_period KmsCryptoKey#rotation_period}

---

SkipInitialVersionCreation^Optional

SkipInitialVersionCreation interface{}

• Type: interface{}

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.14.1/docs/resources/kms_crypto_key#skip_initial_version_creation KmsCryptoKey#skip_initial_version_creation}

---

Timeouts^Optional

Timeouts KmsCryptoKeyTimeouts

• Type: KmsCryptoKeyTimeouts

timeouts block.

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

---

VersionTemplate^Optional

VersionTemplate KmsCryptoKeyVersionTemplate

• Type: KmsCryptoKeyVersionTemplate

version_template block.

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

---

KmsCryptoKeyPrimary

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

&kmscryptokey.KmsCryptoKeyPrimary {

}

KmsCryptoKeyTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

&kmscryptokey.KmsCryptoKeyTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

Name	Type	Description
Create	*string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/kms_crypto_key#create KmsCryptoKey#create}.
Delete	*string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/kms_crypto_key#delete KmsCryptoKey#delete}.
Update	*string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/kms_crypto_key#update KmsCryptoKey#update}.

---

Create^Optional

Create *string

• Type: *string

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

---

Delete^Optional

Delete *string

• Type: *string

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

---

Update^Optional

Update *string

• Type: *string

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

---

KmsCryptoKeyVersionTemplate

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

&kmscryptokey.KmsCryptoKeyVersionTemplate {
	Algorithm: *string,
	ProtectionLevel: *string,
}

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.

---

Algorithm^Required

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.14.1/docs/resources/kms_crypto_key#algorithm KmsCryptoKey#algorithm}

---

ProtectionLevel^Optional

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.14.1/docs/resources/kms_crypto_key#protection_level KmsCryptoKey#protection_level}

---

Classes

KmsCryptoKeyPrimaryList

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.NewKmsCryptoKeyPrimaryList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) KmsCryptoKeyPrimaryList

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
wrapsSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: *bool

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

func 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

func ComputeFqn() *string

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get

func Get(index *f64) KmsCryptoKeyPrimaryOutputReference

index^Required

• Type: *f64

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.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

KmsCryptoKeyPrimaryOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.NewKmsCryptoKeyPrimaryOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) KmsCryptoKeyPrimaryOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
complexObjectIndex	*f64	the index of this item in the list.
complexObjectIsFromSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: *f64

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: *bool

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

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

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

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

State^Required

func State() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() KmsCryptoKeyPrimary

• Type: KmsCryptoKeyPrimary

---

KmsCryptoKeyTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.NewKmsCryptoKeyTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) KmsCryptoKeyTimeoutsOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/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.
ResetUpdate	No description.

---

ComputeFqn

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate

func ResetCreate()

ResetDelete

func ResetDelete()

ResetUpdate

func ResetUpdate()

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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

CreateInput^Optional

func CreateInput() *string

• Type: *string

---

DeleteInput^Optional

func DeleteInput() *string

• Type: *string

---

UpdateInput^Optional

func UpdateInput() *string

• Type: *string

---

Create^Required

func Create() *string

• Type: *string

---

Delete^Required

func Delete() *string

• Type: *string

---

Update^Required

func Update() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---

KmsCryptoKeyVersionTemplateOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/kmscryptokey"

kmscryptokey.NewKmsCryptoKeyVersionTemplateOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) KmsCryptoKeyVersionTemplateOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/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.
ResetProtectionLevel	No description.

---

ComputeFqn

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetProtectionLevel

func ResetProtectionLevel()

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.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

AlgorithmInput^Optional

func AlgorithmInput() *string

• Type: *string

---

ProtectionLevelInput^Optional

func ProtectionLevelInput() *string

• Type: *string

---

Algorithm^Required

func Algorithm() *string

• Type: *string

---

ProtectionLevel^Required

func ProtectionLevel() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() KmsCryptoKeyVersionTemplate

• Type: KmsCryptoKeyVersionTemplate

---