@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:41.353Z") @Stability(value=Stable) public class CfnDBCluster extends CfnResource implements IInspectable
The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide .
You can only create this resource in AWS Regions where Amazon Aurora is supported.
This topic covers the resource for Amazon Aurora DB clusters. For the documentation on the resource for Amazon RDS DB instances, see AWS::RDS::DBInstance .
Updating DB clusters
When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
- Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
- Create a snapshot of the DB cluster. For more information about creating DB snapshots, see Creating a DB Cluster Snapshot .
- If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the
SnapshotIdentifierproperty with the ID of the DB cluster snapshot that you want to use.After you restore a DB cluster with a
SnapshotIdentifierproperty, you must specify the sameSnapshotIdentifierproperty for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify theSnapshotIdentifierproperty, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specifiedSnapshotIdentifierproperty, and the original DB cluster is deleted.
- Update the stack.
Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: PreferredBackupWindow , PreferredMaintenanceWindow , and Port . This limitation doesn't apply to provisioned DB clusters.
For more information about updating other properties of this resource, see [ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .
Deleting DB clusters
The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot . For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;
CfnDBCluster cfnDBCluster = CfnDBCluster.Builder.create(this, "MyCfnDBCluster")
.engine("engine")
// the properties below are optional
.associatedRoles(List.of(DBClusterRoleProperty.builder()
.roleArn("roleArn")
// the properties below are optional
.featureName("featureName")
.build()))
.availabilityZones(List.of("availabilityZones"))
.backtrackWindow(123)
.backupRetentionPeriod(123)
.copyTagsToSnapshot(false)
.databaseName("databaseName")
.dbClusterIdentifier("dbClusterIdentifier")
.dbClusterParameterGroupName("dbClusterParameterGroupName")
.dbSubnetGroupName("dbSubnetGroupName")
.deletionProtection(false)
.enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
.enableHttpEndpoint(false)
.enableIamDatabaseAuthentication(false)
.engineMode("engineMode")
.engineVersion("engineVersion")
.globalClusterIdentifier("globalClusterIdentifier")
.kmsKeyId("kmsKeyId")
.masterUsername("masterUsername")
.masterUserPassword("masterUserPassword")
.port(123)
.preferredBackupWindow("preferredBackupWindow")
.preferredMaintenanceWindow("preferredMaintenanceWindow")
.replicationSourceIdentifier("replicationSourceIdentifier")
.restoreType("restoreType")
.scalingConfiguration(ScalingConfigurationProperty.builder()
.autoPause(false)
.maxCapacity(123)
.minCapacity(123)
.secondsUntilAutoPause(123)
.build())
.snapshotIdentifier("snapshotIdentifier")
.sourceDbClusterIdentifier("sourceDbClusterIdentifier")
.sourceRegion("sourceRegion")
.storageEncrypted(false)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.useLatestRestorableTime(false)
.vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnDBCluster.Builder
A fluent builder for
CfnDBCluster. |
static interface |
CfnDBCluster.DBClusterRoleProperty
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
|
static interface |
CfnDBCluster.ScalingConfigurationProperty
The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnDBCluster(software.constructs.Construct scope,
String id,
CfnDBClusterProps props)
Create a new `AWS::RDS::DBCluster`.
|
protected |
CfnDBCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDBCluster(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAssociatedRoles()
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
String |
getAttrEndpointAddress()
The connection endpoint for the DB cluster.
|
String |
getAttrEndpointPort()
The port number that will accept connections on this DB cluster.
|
String |
getAttrReadEndpointAddress()
The reader endpoint for the DB cluster.
|
List<String> |
getAvailabilityZones()
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
Number |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Number |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
String |
getDatabaseName()
The name of your database.
|
String |
getDbClusterIdentifier()
The DB cluster identifier.
|
String |
getDbClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDbSubnetGroupName()
A DB subnet group that you want to associate with this DB cluster.
|
Object |
getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Object |
getEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
Object |
getEnableIamDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
|
String |
getEngineVersion()
The version number of the database engine to use.
|
String |
getGlobalClusterIdentifier()
If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
|
String |
getKmsKeyId()
The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
|
String |
getMasterUsername()
The name of the master user for the DB cluster.
|
String |
getMasterUserPassword()
The master password for the DB instance.
|
Number |
getPort()
The port number on which the DB instances in the DB cluster accept connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created.
|
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
getReplicationSourceIdentifier()
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
|
String |
getRestoreType()
The type of restore to be performed.
|
Object |
getScalingConfiguration()
The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
|
String |
getSnapshotIdentifier()
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
String |
getSourceDbClusterIdentifier()
When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
|
String |
getSourceRegion()
The AWS Region which contains the source DB cluster when replicating a DB cluster.
|
Object |
getStorageEncrypted()
Indicates whether the DB cluster is encrypted.
|
TagManager |
getTags()
Tags to assign to the DB cluster.
|
Object |
getUseLatestRestorableTime()
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAssociatedRoles(IResolvable value)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
void |
setAssociatedRoles(List<Object> value)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
void |
setAvailabilityZones(List<String> value)
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
void |
setBacktrackWindow(Number value)
The target backtrack window, in seconds.
|
void |
setBackupRetentionPeriod(Number value)
The number of days for which automated backups are retained.
|
void |
setCopyTagsToSnapshot(Boolean value)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
void |
setCopyTagsToSnapshot(IResolvable value)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
void |
setDatabaseName(String value)
The name of your database.
|
void |
setDbClusterIdentifier(String value)
The DB cluster identifier.
|
void |
setDbClusterParameterGroupName(String value)
The name of the DB cluster parameter group to associate with this DB cluster.
|
void |
setDbSubnetGroupName(String value)
A DB subnet group that you want to associate with this DB cluster.
|
void |
setDeletionProtection(Boolean value)
A value that indicates whether the DB cluster has deletion protection enabled.
|
void |
setDeletionProtection(IResolvable value)
A value that indicates whether the DB cluster has deletion protection enabled.
|
void |
setEnableCloudwatchLogsExports(List<String> value)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
void |
setEnableHttpEndpoint(Boolean value)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
void |
setEnableHttpEndpoint(IResolvable value)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
void |
setEnableIamDatabaseAuthentication(Boolean value)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
void |
setEnableIamDatabaseAuthentication(IResolvable value)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
void |
setEngine(String value)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineMode(String value)
The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
|
void |
setEngineVersion(String value)
The version number of the database engine to use.
|
void |
setGlobalClusterIdentifier(String value)
If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
|
void |
setKmsKeyId(String value)
The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
|
void |
setMasterUsername(String value)
The name of the master user for the DB cluster.
|
void |
setMasterUserPassword(String value)
The master password for the DB instance.
|
void |
setPort(Number value)
The port number on which the DB instances in the DB cluster accept connections.
|
void |
setPreferredBackupWindow(String value)
The daily time range during which automated backups are created.
|
void |
setPreferredMaintenanceWindow(String value)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setReplicationSourceIdentifier(String value)
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
|
void |
setRestoreType(String value)
The type of restore to be performed.
|
void |
setScalingConfiguration(CfnDBCluster.ScalingConfigurationProperty value)
The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
|
void |
setScalingConfiguration(IResolvable value)
The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
|
void |
setSnapshotIdentifier(String value)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
void |
setSourceDbClusterIdentifier(String value)
When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
|
void |
setSourceRegion(String value)
The AWS Region which contains the source DB cluster when replicating a DB cluster.
|
void |
setStorageEncrypted(Boolean value)
Indicates whether the DB cluster is encrypted.
|
void |
setStorageEncrypted(IResolvable value)
Indicates whether the DB cluster is encrypted.
|
void |
setUseLatestRestorableTime(Boolean value)
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
|
void |
setUseLatestRestorableTime(IResolvable value)
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
|
void |
setVpcSecurityGroupIds(List<String> value)
A list of EC2 VPC security groups to associate with this DB cluster.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnDBCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDBCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnDBCluster(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnDBClusterProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrEndpointAddress()
For example: mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com
@Stability(value=Stable) @NotNull public String getAttrEndpointPort()
For example: 3306
@Stability(value=Stable) @NotNull public String getAttrReadEndpointAddress()
For example: mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @NotNull public String getEngine()
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
@Stability(value=Stable)
public void setEngine(@NotNull
String value)
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
@Stability(value=Stable) @Nullable public Object getAssociatedRoles()
IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
@Stability(value=Stable)
public void setAssociatedRoles(@Nullable
IResolvable value)
IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
@Stability(value=Stable)
public void setAssociatedRoles(@Nullable
List<Object> value)
IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
@Stability(value=Stable) @Nullable public List<String> getAvailabilityZones()
For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
@Stability(value=Stable)
public void setAvailabilityZones(@Nullable
List<String> value)
For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
@Stability(value=Stable) @Nullable public Number getBacktrackWindow()
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
@Stability(value=Stable)
public void setBacktrackWindow(@Nullable
Number value)
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
@Stability(value=Stable) @Nullable public Number getBackupRetentionPeriod()
Default: 1
Constraints:
@Stability(value=Stable)
public void setBackupRetentionPeriod(@Nullable
Number value)
Default: 1
Constraints:
@Stability(value=Stable) @Nullable public Object getCopyTagsToSnapshot()
The default is not to copy them.
@Stability(value=Stable)
public void setCopyTagsToSnapshot(@Nullable
Boolean value)
The default is not to copy them.
@Stability(value=Stable)
public void setCopyTagsToSnapshot(@Nullable
IResolvable value)
The default is not to copy them.
@Stability(value=Stable) @Nullable public String getDatabaseName()
If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .
@Stability(value=Stable)
public void setDatabaseName(@Nullable
String value)
If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .
@Stability(value=Stable) @Nullable public String getDbClusterIdentifier()
Constraints:
Example: my-cluster1
@Stability(value=Stable)
public void setDbClusterIdentifier(@Nullable
String value)
Constraints:
Example: my-cluster1
@Stability(value=Stable) @Nullable public String getDbClusterParameterGroupName()
If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
To list all of the available DB cluster parameter group names, use the following command:
aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
@Stability(value=Stable)
public void setDbClusterParameterGroupName(@Nullable
String value)
If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
To list all of the available DB cluster parameter group names, use the following command:
aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
@Stability(value=Stable) @Nullable public String getDbSubnetGroupName()
If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
@Stability(value=Stable)
public void setDbSubnetGroupName(@Nullable
String value)
If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
@Stability(value=Stable) @Nullable public Object getDeletionProtection()
The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
@Stability(value=Stable)
public void setDeletionProtection(@Nullable
Boolean value)
The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
@Stability(value=Stable)
public void setDeletionProtection(@Nullable
IResolvable value)
The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
@Stability(value=Stable) @Nullable public List<String> getEnableCloudwatchLogsExports()
The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Aurora MySQL
Valid values: audit , error , general , slowquery
Aurora PostgreSQL
Valid values: postgresql
@Stability(value=Stable)
public void setEnableCloudwatchLogsExports(@Nullable
List<String> value)
The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Aurora MySQL
Valid values: audit , error , general , slowquery
Aurora PostgreSQL
Valid values: postgresql
@Stability(value=Stable) @Nullable public Object getEnableHttpEndpoint()
By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
@Stability(value=Stable)
public void setEnableHttpEndpoint(@Nullable
Boolean value)
By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
@Stability(value=Stable)
public void setEnableHttpEndpoint(@Nullable
IResolvable value)
By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
@Stability(value=Stable) @Nullable public Object getEnableIamDatabaseAuthentication()
By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
@Stability(value=Stable)
public void setEnableIamDatabaseAuthentication(@Nullable
Boolean value)
By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
@Stability(value=Stable)
public void setEnableIamDatabaseAuthentication(@Nullable
IResolvable value)
By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
@Stability(value=Stable) @Nullable public String getEngineMode()
The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
@Stability(value=Stable)
public void setEngineMode(@Nullable
String value)
The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
@Stability(value=Stable) @Nullable public String getEngineVersion()
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql , use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
@Stability(value=Stable)
public void setEngineVersion(@Nullable
String value)
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql , use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
@Stability(value=Stable) @Nullable public String getGlobalClusterIdentifier()
To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
If you aren't configuring a global database cluster, don't specify this property.
To remove the DB cluster from a global database cluster, specify an empty value for the
GlobalClusterIdentifierproperty.
For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
@Stability(value=Stable)
public void setGlobalClusterIdentifier(@Nullable
String value)
To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
If you aren't configuring a global database cluster, don't specify this property.
To remove the DB cluster from a global database cluster, specify an empty value for the
GlobalClusterIdentifierproperty.
For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
@Stability(value=Stable) @Nullable public String getKmsKeyId()
If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .
If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
String value)
If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .
If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
@Stability(value=Stable) @Nullable public String getMasterUsername()
If you specify the
SourceDBClusterIdentifier,SnapshotIdentifier, orGlobalClusterIdentifierproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
@Stability(value=Stable)
public void setMasterUsername(@Nullable
String value)
If you specify the
SourceDBClusterIdentifier,SnapshotIdentifier, orGlobalClusterIdentifierproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
@Stability(value=Stable) @Nullable public String getMasterUserPassword()
If you specify the
SourceDBClusterIdentifier,SnapshotIdentifier, orGlobalClusterIdentifierproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
@Stability(value=Stable)
public void setMasterUserPassword(@Nullable
String value)
If you specify the
SourceDBClusterIdentifier,SnapshotIdentifier, orGlobalClusterIdentifierproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
@Stability(value=Stable) @Nullable public Number getPort()
Default:
EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)EngineMode is serverless :3306 when Engine is aurora or aurora-mysql5432 when Engine is aurora-postgresql
The
No interruptionon update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.
@Stability(value=Stable)
public void setPort(@Nullable
Number value)
Default:
EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)EngineMode is serverless :3306 when Engine is aurora or aurora-mysql5432 when Engine is aurora-postgresql
The
No interruptionon update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.
@Stability(value=Stable) @Nullable public String getPreferredBackupWindow()
For more information, see Backup Window in the Amazon Aurora User Guide.
Constraints:
hh24:mi-hh24:mi .@Stability(value=Stable)
public void setPreferredBackupWindow(@Nullable
String value)
For more information, see Backup Window in the Amazon Aurora User Guide.
Constraints:
hh24:mi-hh24:mi .@Stability(value=Stable) @Nullable public String getPreferredMaintenanceWindow()
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
String value)
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
@Stability(value=Stable) @Nullable public String getReplicationSourceIdentifier()
@Stability(value=Stable)
public void setReplicationSourceIdentifier(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getRestoreType()
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
@Stability(value=Stable)
public void setRestoreType(@Nullable
String value)
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
@Stability(value=Stable) @Nullable public Object getScalingConfiguration()
Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
@Stability(value=Stable)
public void setScalingConfiguration(@Nullable
CfnDBCluster.ScalingConfigurationProperty value)
Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
@Stability(value=Stable)
public void setScalingConfiguration(@Nullable
IResolvable value)
Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
@Stability(value=Stable) @Nullable public String getSnapshotIdentifier()
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
GlobalClusterIdentifierMasterUsernameMasterUserPasswordReplicationSourceIdentifierRestoreTypeSourceDBClusterIdentifierSourceRegionStorageEncrypted (for an encrypted snapshot)UseLatestRestorableTimeConstraints:
@Stability(value=Stable)
public void setSnapshotIdentifier(@Nullable
String value)
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
GlobalClusterIdentifierMasterUsernameMasterUserPasswordReplicationSourceIdentifierRestoreTypeSourceDBClusterIdentifierSourceRegionStorageEncrypted (for an encrypted snapshot)UseLatestRestorableTimeConstraints:
@Stability(value=Stable) @Nullable public String getSourceDbClusterIdentifier()
Constraints:
@Stability(value=Stable)
public void setSourceDbClusterIdentifier(@Nullable
String value)
Constraints:
@Stability(value=Stable) @Nullable public String getSourceRegion()
For example, us-east-1 .
@Stability(value=Stable)
public void setSourceRegion(@Nullable
String value)
For example, us-east-1 .
@Stability(value=Stable) @Nullable public Object getStorageEncrypted()
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
Boolean value)
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
IResolvable value)
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
@Stability(value=Stable) @Nullable public Object getUseLatestRestorableTime()
By default, the DB cluster is not restored to the latest restorable backup time.
@Stability(value=Stable)
public void setUseLatestRestorableTime(@Nullable
Boolean value)
By default, the DB cluster is not restored to the latest restorable backup time.
@Stability(value=Stable)
public void setUseLatestRestorableTime(@Nullable
IResolvable value)
By default, the DB cluster is not restored to the latest restorable backup time.
@Stability(value=Stable) @Nullable public List<String> getVpcSecurityGroupIds()
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
Copyright © 2022. All rights reserved.