`googleServiceAccountKey` Submodule

Constructs

GoogleServiceAccountKey

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

Initializers

using Io.Cdktn.Providers.GoogleBeta;

new GoogleServiceAccountKey(Construct Scope, string Id, GoogleServiceAccountKeyConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`GoogleServiceAccountKeyConfig`	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: GoogleServiceAccountKeyConfig

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`

private string ToString()

Returns a string representation of this construct.

`With`

private IConstruct With(params IMixin[] Mixins)

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: params Constructs.IMixin[]

The mixins to apply.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

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`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

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`

private void MoveTo(string MoveTarget, string|double Index = null)

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|double

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

`MoveToId`

private void MoveToId(string Id)

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`

private void ResetDeletionPolicy()

`ResetId`

private void ResetId()

`ResetKeepers`

private void ResetKeepers()

`ResetKeyAlgorithm`

private void ResetKeyAlgorithm()

`ResetPrivateKeyType`

private void ResetPrivateKeyType()

`ResetPublicKeyData`

private void ResetPublicKeyData()

`ResetPublicKeyType`

private void ResetPublicKeyType()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTN code for importing a GoogleServiceAccountKey resource upon running "cdktn plan ".

`IsConstruct`

using Io.Cdktn.Providers.GoogleBeta;

GoogleServiceAccountKey.IsConstruct(object X);

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: object

Any object.

`IsTerraformElement`

using Io.Cdktn.Providers.GoogleBeta;

GoogleServiceAccountKey.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using Io.Cdktn.Providers.GoogleBeta;

GoogleServiceAccountKey.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using Io.Cdktn.Providers.GoogleBeta;

GoogleServiceAccountKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

`ImportFromId`^Required

Type: string

The id of the existing GoogleServiceAccountKey that should be imported.

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

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`Io.Cdktn.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`Io.Cdktn.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Provisioners`	`Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.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`	`System.Collections.Generic.IDictionary<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`	`System.Collections.Generic.IDictionary<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 Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: Io.Cdktn.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: Io.Cdktn.TerraformProviderGeneratorMetadata

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`Name`^Required

public string Name { get; }

Type: string

`PrivateKey`^Required

public string PrivateKey { get; }

Type: string

`PublicKey`^Required

public string PublicKey { get; }

Type: string

`ValidAfter`^Required

public string ValidAfter { get; }

Type: string

`ValidBefore`^Required

public string ValidBefore { get; }

Type: string

`DeletionPolicyInput`^Optional

public string DeletionPolicyInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`KeepersInput`^Optional

public System.Collections.Generic.IDictionary<string, string> KeepersInput { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`KeyAlgorithmInput`^Optional

public string KeyAlgorithmInput { get; }

Type: string

`PrivateKeyTypeInput`^Optional

public string PrivateKeyTypeInput { get; }

Type: string

`PublicKeyDataInput`^Optional

public string PublicKeyDataInput { get; }

Type: string

`PublicKeyTypeInput`^Optional

public string PublicKeyTypeInput { get; }

Type: string

`ServiceAccountIdInput`^Optional

public string ServiceAccountIdInput { get; }

Type: string

`DeletionPolicy`^Required

public string DeletionPolicy { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`Keepers`^Required

public System.Collections.Generic.IDictionary<string, string> Keepers { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`KeyAlgorithm`^Required

public string KeyAlgorithm { get; }

Type: string

`PrivateKeyType`^Required

public string PrivateKeyType { get; }

Type: string

`PublicKeyData`^Required

public string PublicKeyData { get; }

Type: string

`PublicKeyType`^Required

public string PublicKeyType { get; }

Type: string

`ServiceAccountId`^Required

public string ServiceAccountId { get; }

Type: string

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

GoogleServiceAccountKeyConfig

Initializer

using Io.Cdktn.Providers.GoogleBeta;

new GoogleServiceAccountKeyConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string ServiceAccountId,
    string DeletionPolicy = null,
    string Id = null,
    System.Collections.Generic.IDictionary<string, string> Keepers = null,
    string KeyAlgorithm = null,
    string PrivateKeyType = null,
    string PublicKeyData = null,
    string PublicKeyType = null
};

Properties

Name	Type	Description
`Connection`	`Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`Io.Cdktn.ITerraformDependable[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Provisioners`	`Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.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-beta/7.36.0/docs/resources/google_service_account_key#id GoogleServiceAccountKey#id}.
`Keepers`	`System.Collections.Generic.IDictionary<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-beta/7.36.0/docs/resources/google_service_account_key#private_key_type GoogleServiceAccountKey#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-beta/7.36.0/docs/resources/google_service_account_key#public_key_type GoogleServiceAccountKey#public_key_type}.

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; set; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: Io.Cdktn.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`ServiceAccountId`^Required

public string ServiceAccountId { get; set; }

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-beta/7.36.0/docs/resources/google_service_account_key#service_account_id GoogleServiceAccountKey#service_account_id}

`DeletionPolicy`^Optional

public string DeletionPolicy { get; set; }

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-beta/7.36.0/docs/resources/google_service_account_key#deletion_policy GoogleServiceAccountKey#deletion_policy}

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_service_account_key#id GoogleServiceAccountKey#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 System.Collections.Generic.IDictionary<string, string> Keepers { get; set; }

Type: System.Collections.Generic.IDictionary<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-beta/7.36.0/docs/resources/google_service_account_key#keepers GoogleServiceAccountKey#keepers}

`KeyAlgorithm`^Optional

public string KeyAlgorithm { get; set; }

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-beta/7.36.0/docs/resources/google_service_account_key#key_algorithm GoogleServiceAccountKey#key_algorithm}

`PrivateKeyType`^Optional

public string PrivateKeyType { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_service_account_key#private_key_type GoogleServiceAccountKey#private_key_type}.

`PublicKeyData`^Optional

public string PublicKeyData { get; set; }

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-beta/7.36.0/docs/resources/google_service_account_key#public_key_data GoogleServiceAccountKey#public_key_data}

`PublicKeyType`^Optional

public string PublicKeyType { get; set; }

Type: string

FilesExpand file tree

googleServiceAccountKey.csharp.md

Latest commit

History

googleServiceAccountKey.csharp.md

File metadata and controls

googleServiceAccountKey Submodule

Constructs