Skip to content

Latest commit

 

History

History
2064 lines (1301 loc) · 91 KB

docdbClusterInstance.csharp.md

File metadata and controls

2064 lines (1301 loc) · 91 KB

docdbClusterInstance Submodule

Constructs

DocdbClusterInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance aws_docdb_cluster_instance}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterInstance(Construct Scope, string Id, DocdbClusterInstanceConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DocdbClusterInstanceConfig 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".
PutTimeouts No description.
ResetApplyImmediately No description.
ResetAutoMinorVersionUpgrade No description.
ResetAvailabilityZone No description.
ResetCaCertIdentifier No description.
ResetCopyTagsToSnapshot No description.
ResetEnablePerformanceInsights No description.
ResetEngine No description.
ResetId No description.
ResetIdentifier No description.
ResetIdentifierPrefix No description.
ResetPerformanceInsightsKmsKeyId No description.
ResetPreferredMaintenanceWindow No description.
ResetPromotionTier No description.
ResetTags No description.
ResetTagsAll No description.
ResetTimeouts 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".


PutTimeouts
private void PutTimeouts(DocdbClusterInstanceTimeouts Value)
ValueRequired

ResetApplyImmediately
private void ResetApplyImmediately()
ResetAutoMinorVersionUpgrade
private void ResetAutoMinorVersionUpgrade()
ResetAvailabilityZone
private void ResetAvailabilityZone()
ResetCaCertIdentifier
private void ResetCaCertIdentifier()
ResetCopyTagsToSnapshot
private void ResetCopyTagsToSnapshot()
ResetEnablePerformanceInsights
private void ResetEnablePerformanceInsights()
ResetEngine
private void ResetEngine()
ResetId
private void ResetId()
ResetIdentifier
private void ResetIdentifier()
ResetIdentifierPrefix
private void ResetIdentifierPrefix()
ResetPerformanceInsightsKmsKeyId
private void ResetPerformanceInsightsKmsKeyId()
ResetPreferredMaintenanceWindow
private void ResetPreferredMaintenanceWindow()
ResetPromotionTier
private void ResetPromotionTier()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()
ResetTimeouts
private void ResetTimeouts()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

DocdbClusterInstance.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;

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

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

DocdbClusterInstance.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

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


ImportFromIdRequired
  • Type: string

The id of the existing DocdbClusterInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_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 DocdbClusterInstance 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.
Arn string No description.
DbiResourceId string No description.
DbSubnetGroupName string No description.
Endpoint string No description.
EngineVersion string No description.
KmsKeyId string No description.
Port double No description.
PreferredBackupWindow string No description.
PubliclyAccessible HashiCorp.Cdktf.IResolvable No description.
StorageEncrypted HashiCorp.Cdktf.IResolvable No description.
Timeouts DocdbClusterInstanceTimeoutsOutputReference No description.
Writer HashiCorp.Cdktf.IResolvable No description.
ApplyImmediatelyInput object No description.
AutoMinorVersionUpgradeInput object No description.
AvailabilityZoneInput string No description.
CaCertIdentifierInput string No description.
ClusterIdentifierInput string No description.
CopyTagsToSnapshotInput object No description.
EnablePerformanceInsightsInput object No description.
EngineInput string No description.
IdentifierInput string No description.
IdentifierPrefixInput string No description.
IdInput string No description.
InstanceClassInput string No description.
PerformanceInsightsKmsKeyIdInput string No description.
PreferredMaintenanceWindowInput string No description.
PromotionTierInput double No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
TimeoutsInput object No description.
ApplyImmediately object No description.
AutoMinorVersionUpgrade object No description.
AvailabilityZone string No description.
CaCertIdentifier string No description.
ClusterIdentifier string No description.
CopyTagsToSnapshot object No description.
EnablePerformanceInsights object No description.
Engine string No description.
Id string No description.
Identifier string No description.
IdentifierPrefix string No description.
InstanceClass string No description.
PerformanceInsightsKmsKeyId string No description.
PreferredMaintenanceWindow string No description.
PromotionTier double No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll 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

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

ArnRequired
public string Arn { get; }
  • Type: string

DbiResourceIdRequired
public string DbiResourceId { get; }
  • Type: string

DbSubnetGroupNameRequired
public string DbSubnetGroupName { get; }
  • Type: string

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

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

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

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

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

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

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

TimeoutsRequired
public DocdbClusterInstanceTimeoutsOutputReference Timeouts { get; }

WriterRequired
public IResolvable Writer { get; }
  • Type: HashiCorp.Cdktf.IResolvable

ApplyImmediatelyInputOptional
public object ApplyImmediatelyInput { get; }
  • Type: object

AutoMinorVersionUpgradeInputOptional
public object AutoMinorVersionUpgradeInput { get; }
  • Type: object

AvailabilityZoneInputOptional
public string AvailabilityZoneInput { get; }
  • Type: string

CaCertIdentifierInputOptional
public string CaCertIdentifierInput { get; }
  • Type: string

ClusterIdentifierInputOptional
public string ClusterIdentifierInput { get; }
  • Type: string

CopyTagsToSnapshotInputOptional
public object CopyTagsToSnapshotInput { get; }
  • Type: object

EnablePerformanceInsightsInputOptional
public object EnablePerformanceInsightsInput { get; }
  • Type: object

EngineInputOptional
public string EngineInput { get; }
  • Type: string

IdentifierInputOptional
public string IdentifierInput { get; }
  • Type: string

IdentifierPrefixInputOptional
public string IdentifierPrefixInput { get; }
  • Type: string

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

InstanceClassInputOptional
public string InstanceClassInput { get; }
  • Type: string

PerformanceInsightsKmsKeyIdInputOptional
public string PerformanceInsightsKmsKeyIdInput { get; }
  • Type: string

PreferredMaintenanceWindowInputOptional
public string PreferredMaintenanceWindowInput { get; }
  • Type: string

PromotionTierInputOptional
public double PromotionTierInput { get; }
  • Type: double

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

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

TimeoutsInputOptional
public object TimeoutsInput { get; }
  • Type: object

ApplyImmediatelyRequired
public object ApplyImmediately { get; }
  • Type: object

AutoMinorVersionUpgradeRequired
public object AutoMinorVersionUpgrade { get; }
  • Type: object

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

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

ClusterIdentifierRequired
public string ClusterIdentifier { get; }
  • Type: string

CopyTagsToSnapshotRequired
public object CopyTagsToSnapshot { get; }
  • Type: object

EnablePerformanceInsightsRequired
public object EnablePerformanceInsights { get; }
  • Type: object

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

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

IdentifierRequired
public string Identifier { get; }
  • Type: string

IdentifierPrefixRequired
public string IdentifierPrefix { get; }
  • Type: string

InstanceClassRequired
public string InstanceClass { get; }
  • Type: string

PerformanceInsightsKmsKeyIdRequired
public string PerformanceInsightsKmsKeyId { get; }
  • Type: string

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

PromotionTierRequired
public double PromotionTier { get; }
  • Type: double

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

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

Constants

Name Type Description
TfResourceType string No description.

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

Structs

DocdbClusterInstanceConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterInstanceConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ClusterIdentifier,
    string InstanceClass,
    object ApplyImmediately = null,
    object AutoMinorVersionUpgrade = null,
    string AvailabilityZone = null,
    string CaCertIdentifier = null,
    object CopyTagsToSnapshot = null,
    object EnablePerformanceInsights = null,
    string Engine = null,
    string Id = null,
    string Identifier = null,
    string IdentifierPrefix = null,
    string PerformanceInsightsKmsKeyId = null,
    string PreferredMaintenanceWindow = null,
    double PromotionTier = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    DocdbClusterInstanceTimeouts Timeouts = 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.
ClusterIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.
InstanceClass string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.
ApplyImmediately object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.
AutoMinorVersionUpgrade object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.
AvailabilityZone string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.
CaCertIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.
CopyTagsToSnapshot object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.
EnablePerformanceInsights object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.
Engine string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#id}.
Identifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.
IdentifierPrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.
PerformanceInsightsKmsKeyId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.
PreferredMaintenanceWindow string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.
PromotionTier double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.
TagsAll System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.
Timeouts DocdbClusterInstanceTimeouts timeouts block.

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

ClusterIdentifierRequired
public string ClusterIdentifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.


InstanceClassRequired
public string InstanceClass { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.


ApplyImmediatelyOptional
public object ApplyImmediately { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.


AutoMinorVersionUpgradeOptional
public object AutoMinorVersionUpgrade { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.


AvailabilityZoneOptional
public string AvailabilityZone { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.


CaCertIdentifierOptional
public string CaCertIdentifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.


CopyTagsToSnapshotOptional
public object CopyTagsToSnapshot { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.


EnablePerformanceInsightsOptional
public object EnablePerformanceInsights { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.


EngineOptional
public string Engine { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.


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

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


IdentifierOptional
public string Identifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.


IdentifierPrefixOptional
public string IdentifierPrefix { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.


PerformanceInsightsKmsKeyIdOptional
public string PerformanceInsightsKmsKeyId { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.


PreferredMaintenanceWindowOptional
public string PreferredMaintenanceWindow { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.


PromotionTierOptional
public double PromotionTier { get; set; }
  • Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.


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/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.


TagsAllOptional
public System.Collections.Generic.IDictionary<string, string> TagsAll { 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/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.


TimeoutsOptional
public DocdbClusterInstanceTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#timeouts DocdbClusterInstance#timeouts}


DocdbClusterInstanceTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterInstanceTimeouts {
    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/aws/5.52.0/docs/resources/docdb_cluster_instance#create DocdbClusterInstance#create}.
Delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#delete DocdbClusterInstance#delete}.
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#update DocdbClusterInstance#update}.

CreateOptional
public string Create { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#create DocdbClusterInstance#create}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#delete DocdbClusterInstance#delete}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster_instance#update DocdbClusterInstance#update}.


Classes

DocdbClusterInstanceTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterInstanceTimeoutsOutputReference(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