Skip to content

Latest commit

 

History

History
1679 lines (1042 loc) · 68.7 KB

dataAwsDbInstance.csharp.md

File metadata and controls

1679 lines (1042 loc) · 68.7 KB

dataAwsDbInstance Submodule

Constructs

DataAwsDbInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/db_instance aws_db_instance}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsDbInstance(Construct Scope, string Id, DataAwsDbInstanceConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataAwsDbInstanceConfig 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


ConfigOptional

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 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.
ResetDbInstanceIdentifier No description.
ResetId No description.
ResetTags 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()

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)
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 TerraformAttribute)
TerraformAttributeRequired
  • Type: string

ResetDbInstanceIdentifier
private void ResetDbInstanceIdentifier()
ResetId
private void ResetId()
ResetTags
private void ResetTags()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

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

DataAwsDbInstance.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Aws;

DataAwsDbInstance.IsTerraformDataSource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

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


ImportFromIdRequired
  • Type: string

The id of the existing DataAwsDbInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/db_instance#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 DataAwsDbInstance 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.
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.
Address string No description.
AllocatedStorage double No description.
AutoMinorVersionUpgrade HashiCorp.Cdktf.IResolvable No description.
AvailabilityZone string No description.
BackupRetentionPeriod double No description.
CaCertIdentifier string No description.
DbClusterIdentifier string No description.
DbInstanceArn string No description.
DbInstanceClass string No description.
DbInstancePort double No description.
DbName string No description.
DbParameterGroups string[] No description.
DbSubnetGroup string No description.
EnabledCloudwatchLogsExports string[] No description.
Endpoint string No description.
Engine string No description.
EngineVersion string No description.
HostedZoneId string No description.
Iops double No description.
KmsKeyId string No description.
LicenseModel string No description.
MasterUsername string No description.
MasterUserSecret DataAwsDbInstanceMasterUserSecretList No description.
MaxAllocatedStorage double No description.
MonitoringInterval double No description.
MonitoringRoleArn string No description.
MultiAz HashiCorp.Cdktf.IResolvable No description.
NetworkType string No description.
OptionGroupMemberships string[] No description.
Port double No description.
PreferredBackupWindow string No description.
PreferredMaintenanceWindow string No description.
PubliclyAccessible HashiCorp.Cdktf.IResolvable No description.
ReplicateSourceDb string No description.
ResourceId string No description.
StorageEncrypted HashiCorp.Cdktf.IResolvable No description.
StorageThroughput double No description.
StorageType string No description.
Timezone string No description.
VpcSecurityGroups string[] No description.
DbInstanceIdentifierInput string No description.
IdInput string No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
DbInstanceIdentifier string No description.
Id string No description.
Tags System.Collections.Generic.IDictionary<string, 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

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

AddressRequired
public string Address { get; }
  • Type: string

AllocatedStorageRequired
public double AllocatedStorage { get; }
  • Type: double

AutoMinorVersionUpgradeRequired
public IResolvable AutoMinorVersionUpgrade { get; }
  • Type: HashiCorp.Cdktf.IResolvable

AvailabilityZoneRequired
public string AvailabilityZone { get; }
  • Type: string

BackupRetentionPeriodRequired
public double BackupRetentionPeriod { get; }
  • Type: double

CaCertIdentifierRequired
public string CaCertIdentifier { get; }
  • Type: string

DbClusterIdentifierRequired
public string DbClusterIdentifier { get; }
  • Type: string

DbInstanceArnRequired
public string DbInstanceArn { get; }
  • Type: string

DbInstanceClassRequired
public string DbInstanceClass { get; }
  • Type: string

DbInstancePortRequired
public double DbInstancePort { get; }
  • Type: double

DbNameRequired
public string DbName { get; }
  • Type: string

DbParameterGroupsRequired
public string[] DbParameterGroups { get; }
  • Type: string[]

DbSubnetGroupRequired
public string DbSubnetGroup { get; }
  • Type: string

EnabledCloudwatchLogsExportsRequired
public string[] EnabledCloudwatchLogsExports { get; }
  • Type: string[]

EndpointRequired
public string Endpoint { get; }
  • Type: string

EngineRequired
public string Engine { get; }
  • Type: string

EngineVersionRequired
public string EngineVersion { get; }
  • Type: string

HostedZoneIdRequired
public string HostedZoneId { get; }
  • Type: string

IopsRequired
public double Iops { get; }
  • Type: double

KmsKeyIdRequired
public string KmsKeyId { get; }
  • Type: string

LicenseModelRequired
public string LicenseModel { get; }
  • Type: string

MasterUsernameRequired
public string MasterUsername { get; }
  • Type: string

MasterUserSecretRequired
public DataAwsDbInstanceMasterUserSecretList MasterUserSecret { get; }

MaxAllocatedStorageRequired
public double MaxAllocatedStorage { get; }
  • Type: double

MonitoringIntervalRequired
public double MonitoringInterval { get; }
  • Type: double

MonitoringRoleArnRequired
public string MonitoringRoleArn { get; }
  • Type: string

MultiAzRequired
public IResolvable MultiAz { get; }
  • Type: HashiCorp.Cdktf.IResolvable

NetworkTypeRequired
public string NetworkType { get; }
  • Type: string

OptionGroupMembershipsRequired
public string[] OptionGroupMemberships { get; }
  • Type: string[]

PortRequired
public double Port { get; }
  • Type: double

PreferredBackupWindowRequired
public string PreferredBackupWindow { get; }
  • Type: string

PreferredMaintenanceWindowRequired
public string PreferredMaintenanceWindow { get; }
  • Type: string

PubliclyAccessibleRequired
public IResolvable PubliclyAccessible { get; }
  • Type: HashiCorp.Cdktf.IResolvable

ReplicateSourceDbRequired
public string ReplicateSourceDb { get; }
  • Type: string

ResourceIdRequired
public string ResourceId { get; }
  • Type: string

StorageEncryptedRequired
public IResolvable StorageEncrypted { get; }
  • Type: HashiCorp.Cdktf.IResolvable

StorageThroughputRequired
public double StorageThroughput { get; }
  • Type: double

StorageTypeRequired
public string StorageType { get; }
  • Type: string

TimezoneRequired
public string Timezone { get; }
  • Type: string

VpcSecurityGroupsRequired
public string[] VpcSecurityGroups { get; }
  • Type: string[]

DbInstanceIdentifierInputOptional
public string DbInstanceIdentifierInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

DbInstanceIdentifierRequired
public string DbInstanceIdentifier { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DataAwsDbInstanceConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsDbInstanceConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string DbInstanceIdentifier = null,
    string Id = null,
    System.Collections.Generic.IDictionary<string, string> Tags = 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.
DbInstanceIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/db_instance#id DataAwsDbInstance#id}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.

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

DbInstanceIdentifierOptional
public string DbInstanceIdentifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.


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

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


TagsOptional
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/5.52.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.


DataAwsDbInstanceMasterUserSecret

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsDbInstanceMasterUserSecret {

};

Classes

DataAwsDbInstanceMasterUserSecretList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsDbInstanceMasterUserSecretList(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 DataAwsDbInstanceMasterUserSecretOutputReference 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

DataAwsDbInstanceMasterUserSecretOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsDbInstanceMasterUserSecretOutputReference(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.
KmsKeyId string No description.
SecretArn string No description.
SecretStatus string No description.
InternalValue DataAwsDbInstanceMasterUserSecret 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

KmsKeyIdRequired
public string KmsKeyId { get; }
  • Type: string

SecretArnRequired
public string SecretArn { get; }
  • Type: string

SecretStatusRequired
public string SecretStatus { get; }
  • Type: string

InternalValueOptional
public DataAwsDbInstanceMasterUserSecret InternalValue { get; }