dataAwsDbClusterSnapshot.csharp.md

dataAwsDbClusterSnapshot Submodule

Constructs

DataAwsDbClusterSnapshot

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot aws_db_cluster_snapshot}.

Initializers

using Io.Cdktn.Providers.Aws;

new DataAwsDbClusterSnapshot(Construct Scope, string Id, DataAwsDbClusterSnapshotConfig Config = null);

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

• Type: DataAwsDbClusterSnapshotConfig

---

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	Adds this resource to the terraform JSON output.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
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.
ResetDbClusterIdentifier	No description.
ResetDbClusterSnapshotIdentifier	No description.
ResetId	No description.
ResetIncludePublic	No description.
ResetIncludeShared	No description.
ResetMostRecent	No description.
ResetRegion	No description.
ResetSnapshotType	No description.
ResetTags	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()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

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

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetDbClusterIdentifier

private void ResetDbClusterIdentifier()

ResetDbClusterSnapshotIdentifier

private void ResetDbClusterSnapshotIdentifier()

ResetId

private void ResetId()

ResetIncludePublic

private void ResetIncludePublic()

ResetIncludeShared

private void ResetIncludeShared()

ResetMostRecent

private void ResetMostRecent()

ResetRegion

private void ResetRegion()

ResetSnapshotType

private void ResetSnapshotType()

ResetTags

private void ResetTags()

Static Functions

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

---

IsConstruct

using Io.Cdktn.Providers.Aws;

DataAwsDbClusterSnapshot.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.Aws;

DataAwsDbClusterSnapshot.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using Io.Cdktn.Providers.Aws;

DataAwsDbClusterSnapshot.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using Io.Cdktn.Providers.Aws;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing DataAwsDbClusterSnapshot that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#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 DataAwsDbClusterSnapshot 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.
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.
AllocatedStorage	double	No description.
AvailabilityZones	string[]	No description.
DbClusterSnapshotArn	string	No description.
Engine	string	No description.
EngineVersion	string	No description.
KmsKeyId	string	No description.
LicenseModel	string	No description.
Port	double	No description.
SnapshotCreateTime	string	No description.
SourceDbClusterSnapshotArn	string	No description.
Status	string	No description.
StorageEncrypted	Io.Cdktn.IResolvable	No description.
VpcId	string	No description.
DbClusterIdentifierInput	string	No description.
DbClusterSnapshotIdentifierInput	string	No description.
IdInput	string	No description.
IncludePublicInput	bool|Io.Cdktn.IResolvable	No description.
IncludeSharedInput	bool|Io.Cdktn.IResolvable	No description.
MostRecentInput	bool|Io.Cdktn.IResolvable	No description.
RegionInput	string	No description.
SnapshotTypeInput	string	No description.
TagsInput	System.Collections.Generic.IDictionary<string, string>	No description.
DbClusterIdentifier	string	No description.
DbClusterSnapshotIdentifier	string	No description.
Id	string	No description.
IncludePublic	bool|Io.Cdktn.IResolvable	No description.
IncludeShared	bool|Io.Cdktn.IResolvable	No description.
MostRecent	bool|Io.Cdktn.IResolvable	No description.
Region	string	No description.
SnapshotType	string	No description.
Tags	System.Collections.Generic.IDictionary<string, 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

---

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

---

AllocatedStorage^Required

public double AllocatedStorage { get; }

• Type: double

---

AvailabilityZones^Required

public string[] AvailabilityZones { get; }

• Type: string[]

---

DbClusterSnapshotArn^Required

public string DbClusterSnapshotArn { get; }

• Type: string

---

Engine^Required

public string Engine { get; }

• Type: string

---

EngineVersion^Required

public string EngineVersion { get; }

• Type: string

---

KmsKeyId^Required

public string KmsKeyId { get; }

• Type: string

---

LicenseModel^Required

public string LicenseModel { get; }

• Type: string

---

Port^Required

public double Port { get; }

• Type: double

---

SnapshotCreateTime^Required

public string SnapshotCreateTime { get; }

• Type: string

---

SourceDbClusterSnapshotArn^Required

public string SourceDbClusterSnapshotArn { get; }

• Type: string

---

Status^Required

public string Status { get; }

• Type: string

---

StorageEncrypted^Required

public IResolvable StorageEncrypted { get; }

• Type: Io.Cdktn.IResolvable

---

VpcId^Required

public string VpcId { get; }

• Type: string

---

DbClusterIdentifierInput^Optional

public string DbClusterIdentifierInput { get; }

• Type: string

---

DbClusterSnapshotIdentifierInput^Optional

public string DbClusterSnapshotIdentifierInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

IncludePublicInput^Optional

public bool|IResolvable IncludePublicInput { get; }

• Type: bool|Io.Cdktn.IResolvable

---

IncludeSharedInput^Optional

public bool|IResolvable IncludeSharedInput { get; }

• Type: bool|Io.Cdktn.IResolvable

---

MostRecentInput^Optional

public bool|IResolvable MostRecentInput { get; }

• Type: bool|Io.Cdktn.IResolvable

---

RegionInput^Optional

public string RegionInput { get; }

• Type: string

---

SnapshotTypeInput^Optional

public string SnapshotTypeInput { get; }

• Type: string

---

TagsInput^Optional

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

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

---

DbClusterIdentifier^Required

public string DbClusterIdentifier { get; }

• Type: string

---

DbClusterSnapshotIdentifier^Required

public string DbClusterSnapshotIdentifier { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

IncludePublic^Required

public bool|IResolvable IncludePublic { get; }

• Type: bool|Io.Cdktn.IResolvable

---

IncludeShared^Required

public bool|IResolvable IncludeShared { get; }

• Type: bool|Io.Cdktn.IResolvable

---

MostRecent^Required

public bool|IResolvable MostRecent { get; }

• Type: bool|Io.Cdktn.IResolvable

---

Region^Required

public string Region { get; }

• Type: string

---

SnapshotType^Required

public string SnapshotType { get; }

• Type: string

---

Tags^Required

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

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

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataAwsDbClusterSnapshotConfig

Initializer

using Io.Cdktn.Providers.Aws;

new DataAwsDbClusterSnapshotConfig {
    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 DbClusterIdentifier = null,
    string DbClusterSnapshotIdentifier = null,
    string Id = null,
    bool|IResolvable IncludePublic = null,
    bool|IResolvable IncludeShared = null,
    bool|IResolvable MostRecent = null,
    string Region = null,
    string SnapshotType = null,
    System.Collections.Generic.IDictionary<string, string> Tags = 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.
DbClusterIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#db_cluster_identifier DataAwsDbClusterSnapshot#db_cluster_identifier}.
DbClusterSnapshotIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#db_cluster_snapshot_identifier DataAwsDbClusterSnapshot#db_cluster_snapshot_identifier}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#id DataAwsDbClusterSnapshot#id}.
IncludePublic	bool|Io.Cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#include_public DataAwsDbClusterSnapshot#include_public}.
IncludeShared	bool|Io.Cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#include_shared DataAwsDbClusterSnapshot#include_shared}.
MostRecent	bool|Io.Cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#most_recent DataAwsDbClusterSnapshot#most_recent}.
Region	string	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
SnapshotType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#snapshot_type DataAwsDbClusterSnapshot#snapshot_type}.
Tags	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#tags DataAwsDbClusterSnapshot#tags}.

---

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[]

---

DbClusterIdentifier^Optional

public string DbClusterIdentifier { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#db_cluster_identifier DataAwsDbClusterSnapshot#db_cluster_identifier}.

---

DbClusterSnapshotIdentifier^Optional

public string DbClusterSnapshotIdentifier { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#db_cluster_snapshot_identifier DataAwsDbClusterSnapshot#db_cluster_snapshot_identifier}.

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#id DataAwsDbClusterSnapshot#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.

---

IncludePublic^Optional

public bool|IResolvable IncludePublic { get; set; }

• Type: bool|Io.Cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#include_public DataAwsDbClusterSnapshot#include_public}.

---

IncludeShared^Optional

public bool|IResolvable IncludeShared { get; set; }

• Type: bool|Io.Cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#include_shared DataAwsDbClusterSnapshot#include_shared}.

---

MostRecent^Optional

public bool|IResolvable MostRecent { get; set; }

• Type: bool|Io.Cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#most_recent DataAwsDbClusterSnapshot#most_recent}.

---

Region^Optional

public string Region { get; set; }

• Type: string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#region DataAwsDbClusterSnapshot#region}

---

SnapshotType^Optional

public string SnapshotType { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#snapshot_type DataAwsDbClusterSnapshot#snapshot_type}.

---

Tags^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/data-sources/db_cluster_snapshot#tags DataAwsDbClusterSnapshot#tags}.

---