CfnDBInstanceProps
- class aws_cdk.aws_docdb.CfnDBInstanceProps(*, db_cluster_identifier, db_instance_class, auto_minor_version_upgrade=None, availability_zone=None, db_instance_identifier=None, enable_performance_insights=None, preferred_maintenance_window=None, tags=None)
Bases:
object
Properties for defining a
CfnDBInstance
.- Parameters:
db_cluster_identifier (
str
) – The identifier of the cluster that the instance will belong to.db_instance_class (
str
) – 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.auto_minor_version_upgrade (
Union
[bool
,IResolvable
,None
]) – This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. Default:false
availability_zone (
Optional
[str
]) – 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
db_instance_identifier (
Optional
[str
]) – 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
enable_performance_insights (
Union
[bool
,IResolvable
,None
]) –AWS::DocDB::DBInstance.EnablePerformanceInsights
.preferred_maintenance_window (
Optional
[str
]) – 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 (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_docdb as docdb cfn_dBInstance_props = docdb.CfnDBInstanceProps( db_cluster_identifier="dbClusterIdentifier", db_instance_class="dbInstanceClass", # the properties below are optional auto_minor_version_upgrade=False, availability_zone="availabilityZone", db_instance_identifier="dbInstanceIdentifier", enable_performance_insights=False, preferred_maintenance_window="preferredMaintenanceWindow", tags=[CfnTag( key="key", value="value" )] )
Attributes
- auto_minor_version_upgrade
This parameter does not apply to Amazon DocumentDB.
Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default:
false
- availability_zone
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
- db_cluster_identifier
The identifier of the cluster that the instance will belong to.
- db_instance_class
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.
- db_instance_identifier
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
- enable_performance_insights
AWS::DocDB::DBInstance.EnablePerformanceInsights
.
- preferred_maintenance_window
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
The tags to be assigned to the instance.
You can assign up to 10 tags to an instance.