Skip to content

Latest commit

 

History

History
3112 lines (1919 loc) · 131 KB

alloydbBackup.csharp.md

File metadata and controls

3112 lines (1919 loc) · 131 KB
Raw

alloydbBackup Submodule

Constructs

AlloydbBackup

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup google_alloydb_backup}.

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackup(Construct Scope, string Id, AlloydbBackupConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config AlloydbBackupConfig 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".
PutEncryptionConfig No description.
PutTimeouts No description.
ResetAnnotations No description.
ResetDescription No description.
ResetDisplayName No description.
ResetEncryptionConfig No description.
ResetId No description.
ResetLabels No description.
ResetProject No description.
ResetTimeouts No description.
ResetType No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

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

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • 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.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

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

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

IdRequired
  • Type: string

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

PutEncryptionConfig 
private void PutEncryptionConfig(AlloydbBackupEncryptionConfig Value)
ValueRequired
PutTimeouts 
private void PutTimeouts(AlloydbBackupTimeouts Value)
ValueRequired
ResetAnnotations 
private void ResetAnnotations()
ResetDescription 
private void ResetDescription()
ResetDisplayName 
private void ResetDisplayName()
ResetEncryptionConfig 
private void ResetEncryptionConfig()
ResetId 
private void ResetId()
ResetLabels 
private void ResetLabels()
ResetProject 
private void ResetProject()
ResetTimeouts 
private void ResetTimeouts()
ResetType 
private void ResetType()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a AlloydbBackup resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Google;

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

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Google;

AlloydbBackup.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Google;

AlloydbBackup.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Google;

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

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

ImportFromIdRequired
  • Type: string

The id of the existing AlloydbBackup that should be imported.

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

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.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 HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ClusterUid string No description.
CreateTime string No description.
DeleteTime string No description.
EffectiveAnnotations HashiCorp.Cdktf.StringMap No description.
EffectiveLabels HashiCorp.Cdktf.StringMap No description.
EncryptionConfig AlloydbBackupEncryptionConfigOutputReference No description.
EncryptionInfo AlloydbBackupEncryptionInfoList No description.
Etag string No description.
ExpiryQuantity AlloydbBackupExpiryQuantityList No description.
ExpiryTime string No description.
Name string No description.
Reconciling HashiCorp.Cdktf.IResolvable No description.
SizeBytes string No description.
State string No description.
TerraformLabels HashiCorp.Cdktf.StringMap No description.
Timeouts AlloydbBackupTimeoutsOutputReference No description.
Uid string No description.
UpdateTime string No description.
AnnotationsInput System.Collections.Generic.IDictionary<string, string> No description.
BackupIdInput string No description.
ClusterNameInput string No description.
DescriptionInput string No description.
DisplayNameInput string No description.
EncryptionConfigInput AlloydbBackupEncryptionConfig No description.
IdInput string No description.
LabelsInput System.Collections.Generic.IDictionary<string, string> No description.
LocationInput string No description.
ProjectInput string No description.
TimeoutsInput object No description.
TypeInput string No description.
Annotations System.Collections.Generic.IDictionary<string, string> No description.
BackupId string No description.
ClusterName string No description.
Description string No description.
DisplayName string No description.
Id string No description.
Labels System.Collections.Generic.IDictionary<string, string> No description.
Location string No description.
Project string No description.
Type string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
ClusterUidRequired 
public string ClusterUid { get; }
  • Type: string
CreateTimeRequired 
public string CreateTime { get; }
  • Type: string
DeleteTimeRequired 
public string DeleteTime { get; }
  • Type: string
EffectiveAnnotationsRequired 
public StringMap EffectiveAnnotations { get; }
  • Type: HashiCorp.Cdktf.StringMap
EffectiveLabelsRequired 
public StringMap EffectiveLabels { get; }
  • Type: HashiCorp.Cdktf.StringMap
EncryptionConfigRequired 
public AlloydbBackupEncryptionConfigOutputReference EncryptionConfig { get; }
EncryptionInfoRequired 
public AlloydbBackupEncryptionInfoList EncryptionInfo { get; }
EtagRequired 
public string Etag { get; }
  • Type: string
ExpiryQuantityRequired 
public AlloydbBackupExpiryQuantityList ExpiryQuantity { get; }
ExpiryTimeRequired 
public string ExpiryTime { get; }
  • Type: string
NameRequired 
public string Name { get; }
  • Type: string
ReconcilingRequired 
public IResolvable Reconciling { get; }
  • Type: HashiCorp.Cdktf.IResolvable
SizeBytesRequired 
public string SizeBytes { get; }
  • Type: string
StateRequired 
public string State { get; }
  • Type: string
TerraformLabelsRequired 
public StringMap TerraformLabels { get; }
  • Type: HashiCorp.Cdktf.StringMap
TimeoutsRequired 
public AlloydbBackupTimeoutsOutputReference Timeouts { get; }
UidRequired 
public string Uid { get; }
  • Type: string
UpdateTimeRequired 
public string UpdateTime { get; }
  • Type: string
AnnotationsInputOptional 
public System.Collections.Generic.IDictionary<string, string> AnnotationsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
BackupIdInputOptional 
public string BackupIdInput { get; }
  • Type: string
ClusterNameInputOptional 
public string ClusterNameInput { get; }
  • Type: string
DescriptionInputOptional 
public string DescriptionInput { get; }
  • Type: string
DisplayNameInputOptional 
public string DisplayNameInput { get; }
  • Type: string
EncryptionConfigInputOptional 
public AlloydbBackupEncryptionConfig EncryptionConfigInput { get; }
IdInputOptional 
public string IdInput { get; }
  • Type: string
LabelsInputOptional 
public System.Collections.Generic.IDictionary<string, string> LabelsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
LocationInputOptional 
public string LocationInput { get; }
  • Type: string
ProjectInputOptional 
public string ProjectInput { get; }
  • Type: string
TimeoutsInputOptional 
public object TimeoutsInput { get; }
  • Type: object
TypeInputOptional 
public string TypeInput { get; }
  • Type: string
AnnotationsRequired 
public System.Collections.Generic.IDictionary<string, string> Annotations { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
BackupIdRequired 
public string BackupId { get; }
  • Type: string
ClusterNameRequired 
public string ClusterName { get; }
  • Type: string
DescriptionRequired 
public string Description { get; }
  • Type: string
DisplayNameRequired 
public string DisplayName { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
LabelsRequired 
public System.Collections.Generic.IDictionary<string, string> Labels { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
LocationRequired 
public string Location { get; }
  • Type: string
ProjectRequired 
public string Project { get; }
  • Type: string
TypeRequired 
public string Type { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

AlloydbBackupConfig

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string BackupId,
    string ClusterName,
    string Location,
    System.Collections.Generic.IDictionary<string, string> Annotations = null,
    string Description = null,
    string DisplayName = null,
    AlloydbBackupEncryptionConfig EncryptionConfig = null,
    string Id = null,
    System.Collections.Generic.IDictionary<string, string> Labels = null,
    string Project = null,
    AlloydbBackupTimeouts Timeouts = null,
    string Type = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
BackupId string The ID of the alloydb backup.
ClusterName string The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).
Location string The location where the alloydb backup should reside.
Annotations System.Collections.Generic.IDictionary<string, string> Annotations to allow client tools to store small amount of arbitrary data.
Description string User-provided description of the backup.
DisplayName string User-settable and human-readable display name for the Backup.
EncryptionConfig AlloydbBackupEncryptionConfig encryption_config block.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#id AlloydbBackup#id}.
Labels System.Collections.Generic.IDictionary<string, string> User-defined labels for the alloydb backup.
Project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#project AlloydbBackup#project}.
Timeouts AlloydbBackupTimeouts timeouts block.
Type string The backup type, which suggests the trigger for the backup. Possible values: ["TYPE_UNSPECIFIED", "ON_DEMAND", "AUTOMATED", "CONTINUOUS"].
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
BackupIdRequired 
public string BackupId { get; set; }
  • Type: string

The ID of the alloydb backup.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#backup_id AlloydbBackup#backup_id}

ClusterNameRequired 
public string ClusterName { get; set; }
  • Type: string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#cluster_name AlloydbBackup#cluster_name}

LocationRequired 
public string Location { get; set; }
  • Type: string

The location where the alloydb backup should reside.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#location AlloydbBackup#location}

AnnotationsOptional 
public System.Collections.Generic.IDictionary<string, string> Annotations { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Annotations to allow client tools to store small amount of arbitrary data.

This is distinct from labels. https://google.aip.dev/128 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#annotations AlloydbBackup#annotations}

DescriptionOptional 
public string Description { get; set; }
  • Type: string

User-provided description of the backup.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#description AlloydbBackup#description}

DisplayNameOptional 
public string DisplayName { get; set; }
  • Type: string

User-settable and human-readable display name for the Backup.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#display_name AlloydbBackup#display_name}

EncryptionConfigOptional 
public AlloydbBackupEncryptionConfig EncryptionConfig { get; set; }

encryption_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#encryption_config AlloydbBackup#encryption_config}

IdOptional 
public string Id { get; set; }
  • Type: string

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

LabelsOptional 
public System.Collections.Generic.IDictionary<string, string> Labels { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

User-defined labels for the alloydb backup.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.11.2/docs/resources/alloydb_backup#labels AlloydbBackup#labels}

ProjectOptional 
public string Project { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#project AlloydbBackup#project}.

TimeoutsOptional 
public AlloydbBackupTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#timeouts AlloydbBackup#timeouts}

TypeOptional 
public string Type { get; set; }
  • Type: string

The backup type, which suggests the trigger for the backup. Possible values: ["TYPE_UNSPECIFIED", "ON_DEMAND", "AUTOMATED", "CONTINUOUS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#type AlloydbBackup#type}

AlloydbBackupEncryptionConfig

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupEncryptionConfig {
    string KmsKeyName = null
};

Properties

Name Type Description
KmsKeyName string The fully-qualified resource name of the KMS key.
KmsKeyNameOptional 
public string KmsKeyName { get; set; }
  • Type: string

The fully-qualified resource name of the KMS key.

Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#kms_key_name AlloydbBackup#kms_key_name}

AlloydbBackupEncryptionInfo

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupEncryptionInfo {

};

AlloydbBackupExpiryQuantity

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupExpiryQuantity {

};

AlloydbBackupTimeouts

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

Name Type Description
Create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#create AlloydbBackup#create}.
Delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#delete AlloydbBackup#delete}.
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#update AlloydbBackup#update}.
CreateOptional 
public string Create { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#create AlloydbBackup#create}.

DeleteOptional 
public string Delete { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#delete AlloydbBackup#delete}.

UpdateOptional 
public string Update { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/alloydb_backup#update AlloydbBackup#update}.

Classes

AlloydbBackupEncryptionConfigOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupEncryptionConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.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.
ResetKmsKeyName No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetKmsKeyName 
private void ResetKmsKeyName()

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.
KmsKeyNameInput string No description.
KmsKeyName string No description.
InternalValue AlloydbBackupEncryptionConfig No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string
KmsKeyNameInputOptional 
public string KmsKeyNameInput { get; }
  • Type: string
KmsKeyNameRequired 
public string KmsKeyName { get; }
  • Type: string
InternalValueOptional 
public AlloydbBackupEncryptionConfig InternalValue { get; }

AlloydbBackupEncryptionInfoList

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupEncryptionInfoList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.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).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

WrapsSetRequired
  • 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 
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

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 
private string ComputeFqn()
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
private AlloydbBackupEncryptionInfoOutputReference Get(double Index)
IndexRequired
  • Type: double

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 string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string

AlloydbBackupEncryptionInfoOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupEncryptionInfoOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double 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).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.

ComplexObjectIsFromSetRequired
  • 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 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

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.
EncryptionType string No description.
KmsKeyVersions string[] No description.
InternalValue AlloydbBackupEncryptionInfo No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string
EncryptionTypeRequired 
public string EncryptionType { get; }
  • Type: string
KmsKeyVersionsRequired 
public string[] KmsKeyVersions { get; }
  • Type: string[]
InternalValueOptional 
public AlloydbBackupEncryptionInfo InternalValue { get; }

AlloydbBackupExpiryQuantityList

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupExpiryQuantityList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.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).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

WrapsSetRequired
  • 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 
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

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 
private string ComputeFqn()
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
private AlloydbBackupExpiryQuantityOutputReference Get(double Index)
IndexRequired
  • Type: double

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 string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string

AlloydbBackupExpiryQuantityOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupExpiryQuantityOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double 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).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.

ComplexObjectIsFromSetRequired
  • 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 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

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.
RetentionCount double No description.
TotalRetentionCount double No description.
InternalValue AlloydbBackupExpiryQuantity No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string
RetentionCountRequired 
public double RetentionCount { get; }
  • Type: double
TotalRetentionCountRequired 
public double TotalRetentionCount { get; }
  • Type: double
InternalValueOptional 
public AlloydbBackupExpiryQuantity InternalValue { get; }

AlloydbBackupTimeoutsOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new AlloydbBackupTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.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 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate 
private void ResetCreate()
ResetDelete 
private void ResetDelete()
ResetUpdate 
private void 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 object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string
CreateInputOptional 
public string CreateInput { get; }
  • Type: string
DeleteInputOptional 
public string DeleteInput { get; }
  • Type: string
UpdateInputOptional 
public string UpdateInput { get; }
  • Type: string
CreateRequired 
public string Create { get; }
  • Type: string
DeleteRequired 
public string Delete { get; }
  • Type: string
UpdateRequired 
public string Update { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object