class CfnDBInstance (construct)

Language	Type name
.NET	Amazon.CDK.AWS.DocDB.CfnDBInstance
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#CfnDBInstance
Java	software.amazon.awscdk.services.docdb.CfnDBInstance
Python	aws_cdk.aws_docdb.CfnDBInstance
TypeScript	aws-cdk-lib » aws_docdb » CfnDBInstance

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::DocDB::DBInstance Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance.

For more information, see DBInstance in the Amazon DocumentDB Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnDBInstance = new docdb.CfnDBInstance(this, 'MyCfnDBInstance', {
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbInstanceClass: 'dbInstanceClass',

  // the properties below are optional
  autoMinorVersionUpgrade: false,
  availabilityZone: 'availabilityZone',
  caCertificateIdentifier: 'caCertificateIdentifier',
  certificateRotationRestart: false,
  dbInstanceIdentifier: 'dbInstanceIdentifier',
  enablePerformanceInsights: false,
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnDBInstance(scope: Construct, id: string, props: CfnDBInstanceProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnDBInstanceProps — Resource properties.

Construct Props

Name	Type	Description
dbClusterIdentifier	string	The identifier of the cluster that the instance will belong to.
dbInstanceClass	string	The compute and memory capacity of the instance;
autoMinorVersionUpgrade?	boolean | IResolvable	This parameter does not apply to Amazon DocumentDB.
availabilityZone?	string	The Amazon EC2 Availability Zone that the instance is created in.
caCertificateIdentifier?	string	The identifier of the CA certificate for this DB instance.
certificateRotationRestart?	boolean | IResolvable	Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
dbInstanceIdentifier?	string	The instance identifier. This parameter is stored as a lowercase string.
enablePerformanceInsights?	boolean | IResolvable	A value that indicates whether to enable Performance Insights for the DB Instance.
preferredMaintenanceWindow?	string	The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
tags?	CfnTag[]	The tags to be assigned to the instance.

---

dbClusterIdentifier

Type: string

The identifier of the cluster that the instance will belong to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier

---

dbInstanceClass

Type: string

The compute and memory capacity of the instance;

for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

This parameter does not apply to Amazon DocumentDB.

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade

---

availabilityZone?

Type: string (optional)

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

Example: us-east-1d

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone

---

caCertificateIdentifier?

Type: string (optional)

The identifier of the CA certificate for this DB instance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-cacertificateidentifier

---

certificateRotationRestart?

Type: boolean | IResolvable (optional)

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-certificaterotationrestart

---

dbInstanceIdentifier?

Type: string (optional)

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier

---

enablePerformanceInsights?

Type: boolean | IResolvable (optional)

A value that indicates whether to enable Performance Insights for the DB Instance.

For more information, see Using Amazon Performance Insights .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-enableperformanceinsights

---

preferredMaintenanceWindow?

Type: string (optional)

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow

---

tags?

Type: CfnTag[] (optional)

The tags to be assigned to the instance.

You can assign up to 10 tags to an instance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags

Properties

Name	Type	Description
attrEndpoint	string	The connection endpoint for the instance.
attrId	string
attrPort	string	The port number on which the database accepts connections, such as 27017 .
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
dbClusterIdentifier	string	The identifier of the cluster that the instance will belong to.
dbInstanceClass	string	The compute and memory capacity of the instance;
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
autoMinorVersionUpgrade?	boolean | IResolvable	This parameter does not apply to Amazon DocumentDB.
availabilityZone?	string	The Amazon EC2 Availability Zone that the instance is created in.
caCertificateIdentifier?	string	The identifier of the CA certificate for this DB instance.
certificateRotationRestart?	boolean | IResolvable	Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
dbInstanceIdentifier?	string	The instance identifier.
enablePerformanceInsights?	boolean | IResolvable	A value that indicates whether to enable Performance Insights for the DB Instance.
preferredMaintenanceWindow?	string	The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
tagsRaw?	CfnTag[]	The tags to be assigned to the instance.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrEndpoint

Type: string

The connection endpoint for the instance.

For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .

---

attrId

Type: string

---

attrPort

Type: string

The port number on which the database accepts connections, such as 27017 .

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

dbClusterIdentifier

Type: string

The identifier of the cluster that the instance will belong to.

---

dbInstanceClass

Type: string

The compute and memory capacity of the instance;

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

This parameter does not apply to Amazon DocumentDB.

---

availabilityZone?

Type: string (optional)

The Amazon EC2 Availability Zone that the instance is created in.

---

caCertificateIdentifier?

Type: string (optional)

The identifier of the CA certificate for this DB instance.

---

certificateRotationRestart?

Type: boolean | IResolvable (optional)

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

---

dbInstanceIdentifier?

Type: string (optional)

The instance identifier.

This parameter is stored as a lowercase string.

---

enablePerformanceInsights?

Type: boolean | IResolvable (optional)

A value that indicates whether to enable Performance Insights for the DB Instance.

---

preferredMaintenanceWindow?

Type: string (optional)

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

---

tagsRaw?

Type: CfnTag[] (optional)

The tags to be assigned to the instance.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

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

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }