interface CfnDBInstanceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.DocDB.CfnDBInstanceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#CfnDBInstanceProps |
Java | software.amazon.awscdk.services.docdb.CfnDBInstanceProps |
Python | aws_cdk.aws_docdb.CfnDBInstanceProps |
TypeScript | aws-cdk-lib » aws_docdb » CfnDBInstanceProps |
Properties for defining a CfnDBInstance
.
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 cfnDBInstanceProps: docdb.CfnDBInstanceProps = {
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',
}],
};
Properties
Name | Type | Description |
---|---|---|
db | string | The identifier of the cluster that the instance will belong to. |
db | string | The compute and memory capacity of the instance; |
auto | boolean | IResolvable | This parameter does not apply to Amazon DocumentDB. |
availability | string | The Amazon EC2 Availability Zone that the instance is created in. |
ca | string | The CA certificate identifier to use for the DB instance's server certificate. |
certificate | boolean | IResolvable | Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. |
db | string | The instance identifier. This parameter is stored as a lowercase string. |
enable | boolean | IResolvable | A value that indicates whether to enable Performance Insights for the DB Instance. |
preferred | string | The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). |
tags? | Cfn [] | The tags to be assigned to the instance. |
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;
for example, db.m4.large
. If you change the class of an instance there can be some interruption in the cluster's service.
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
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
caCertificateIdentifier?
Type:
string
(optional)
The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .
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 .
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
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 .
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.
tags?
Type:
Cfn
[]
(optional)
The tags to be assigned to the instance.
You can assign up to 10 tags to an instance.