serviceAccountKey.typescript.md

serviceAccountKey Submodule

Constructs

ServiceAccountKey

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key google_service_account_key}.

Initializers

import { serviceAccountKey } from '@cdktn/provider-google'

new serviceAccountKey.ServiceAccountKey(scope: Construct, id: string, config: ServiceAccountKeyConfig)

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

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to 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".
resetDeletionPolicy	No description.
resetId	No description.
resetKeepers	No description.
resetKeyAlgorithm	No description.
resetPrivateKeyType	No description.
resetPublicKeyData	No description.
resetPublicKeyType	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: ...constructs.IMixin[]

The mixins to apply.

---

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

---

resetDeletionPolicy

public resetDeletionPolicy(): void

resetId

public resetId(): void

resetKeepers

public resetKeepers(): void

resetKeyAlgorithm

public resetKeyAlgorithm(): void

resetPrivateKeyType

public resetPrivateKeyType(): void

resetPublicKeyData

public resetPublicKeyData(): void

resetPublicKeyType

public resetPublicKeyType(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTN code for importing a ServiceAccountKey resource upon running "cdktn plan ".

---

isConstruct

import { serviceAccountKey } from '@cdktn/provider-google'

serviceAccountKey.ServiceAccountKey.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 { serviceAccountKey } from '@cdktn/provider-google'

serviceAccountKey.ServiceAccountKey.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { serviceAccountKey } from '@cdktn/provider-google'

serviceAccountKey.ServiceAccountKey.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { serviceAccountKey } from '@cdktn/provider-google'

serviceAccountKey.ServiceAccountKey.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a ServiceAccountKey resource upon running "cdktn 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 ServiceAccountKey to import.

---

importFromId^Required

• Type: string

The id of the existing ServiceAccountKey that should be imported.

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

---

provider^Optional

• Type: cdktn.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktn.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktn.TerraformProviderGeneratorMetadata	No description.
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]	No description.
name	string	No description.
privateKey	string	No description.
publicKey	string	No description.
validAfter	string	No description.
validBefore	string	No description.
deletionPolicyInput	string	No description.
idInput	string	No description.
keepersInput	{[ key: string ]: string}	No description.
keyAlgorithmInput	string	No description.
privateKeyTypeInput	string	No description.
publicKeyDataInput	string	No description.
publicKeyTypeInput	string	No description.
serviceAccountIdInput	string	No description.
deletionPolicy	string	No description.
id	string	No description.
keepers	{[ key: string ]: string}	No description.
keyAlgorithm	string	No description.
privateKeyType	string	No description.
publicKeyData	string	No description.
publicKeyType	string	No description.
serviceAccountId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

provisioners^Optional

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

• Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

---

privateKey^Required

public readonly privateKey: string;

• Type: string

---

publicKey^Required

public readonly publicKey: string;

• Type: string

---

validAfter^Required

public readonly validAfter: string;

• Type: string

---

validBefore^Required

public readonly validBefore: string;

• Type: string

---

deletionPolicyInput^Optional

public readonly deletionPolicyInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

keepersInput^Optional

public readonly keepersInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

keyAlgorithmInput^Optional

public readonly keyAlgorithmInput: string;

• Type: string

---

privateKeyTypeInput^Optional

public readonly privateKeyTypeInput: string;

• Type: string

---

publicKeyDataInput^Optional

public readonly publicKeyDataInput: string;

• Type: string

---

publicKeyTypeInput^Optional

public readonly publicKeyTypeInput: string;

• Type: string

---

serviceAccountIdInput^Optional

public readonly serviceAccountIdInput: string;

• Type: string

---

deletionPolicy^Required

public readonly deletionPolicy: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

keepers^Required

public readonly keepers: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

keyAlgorithm^Required

public readonly keyAlgorithm: string;

• Type: string

---

privateKeyType^Required

public readonly privateKeyType: string;

• Type: string

---

publicKeyData^Required

public readonly publicKeyData: string;

• Type: string

---

publicKeyType^Required

public readonly publicKeyType: string;

• Type: string

---

serviceAccountId^Required

public readonly serviceAccountId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ServiceAccountKeyConfig

Initializer

import { serviceAccountKey } from '@cdktn/provider-google'

const serviceAccountKeyConfig: serviceAccountKey.ServiceAccountKeyConfig = { ... }

Properties

Name	Type	Description
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	cdktn.ITerraformDependable[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]	No description.
serviceAccountId	string	The ID of the parent service account of the key.
deletionPolicy	string	Whether Terraform will be prevented from destroying the instance.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#id ServiceAccountKey#id}.
keepers	{[ key: string ]: string}	Arbitrary map of values that, when changed, will trigger recreation of resource.
keyAlgorithm	string	The algorithm used to generate the key, used only on create.
privateKeyType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#private_key_type ServiceAccountKey#private_key_type}.
publicKeyData	string	A field that allows clients to upload their own public key.
publicKeyType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#public_key_type ServiceAccountKey#public_key_type}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktn.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

provisioners^Optional

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

• Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

---

serviceAccountId^Required

public readonly serviceAccountId: string;

• Type: string

The ID of the parent service account of the key.

This can be a string in the format {ACCOUNT} or projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}, where {ACCOUNT} is the email address or unique id of the service account. If the {ACCOUNT} syntax is used, the project will be inferred from the provider's configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#service_account_id ServiceAccountKey#service_account_id}

---

deletionPolicy^Optional

public readonly deletionPolicy: string;

• Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#deletion_policy ServiceAccountKey#deletion_policy}

---

id^Optional

public readonly id: string;

• Type: string

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

---

keepers^Optional

public readonly keepers: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Arbitrary map of values that, when changed, will trigger recreation of resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#keepers ServiceAccountKey#keepers}

---

keyAlgorithm^Optional

public readonly keyAlgorithm: string;

• Type: string

The algorithm used to generate the key, used only on create.

KEY_ALG_RSA_2048 is the default algorithm. Valid values are: "KEY_ALG_RSA_1024", "KEY_ALG_RSA_2048".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#key_algorithm ServiceAccountKey#key_algorithm}

---

privateKeyType^Optional

public readonly privateKeyType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#private_key_type ServiceAccountKey#private_key_type}.

---

publicKeyData^Optional

public readonly publicKeyData: string;

• Type: string

A field that allows clients to upload their own public key.

If set, use this public key data to create a service account key for given service account. Please note, the expected format for this field is a base64 encoded X509_PEM.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#public_key_data ServiceAccountKey#public_key_data}

---

publicKeyType^Optional

public readonly publicKeyType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/service_account_key#public_key_type ServiceAccountKey#public_key_type}.

---