Class CfnDBClusterProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBClusterProps>
- Enclosing interface:
CfnDBClusterProps
CfnDBClusterProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallocatedStorage
(Number allocatedStorage) Sets the value ofCfnDBClusterProps.getAllocatedStorage()
associatedRoles
(List<? extends Object> associatedRoles) Sets the value ofCfnDBClusterProps.getAssociatedRoles()
associatedRoles
(IResolvable associatedRoles) Sets the value ofCfnDBClusterProps.getAssociatedRoles()
autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Sets the value ofCfnDBClusterProps.getAutoMinorVersionUpgrade()
autoMinorVersionUpgrade
(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnDBClusterProps.getAutoMinorVersionUpgrade()
availabilityZones
(List<String> availabilityZones) Sets the value ofCfnDBClusterProps.getAvailabilityZones()
backtrackWindow
(Number backtrackWindow) Sets the value ofCfnDBClusterProps.getBacktrackWindow()
backupRetentionPeriod
(Number backupRetentionPeriod) Sets the value ofCfnDBClusterProps.getBackupRetentionPeriod()
build()
Builds the configured instance.copyTagsToSnapshot
(Boolean copyTagsToSnapshot) Sets the value ofCfnDBClusterProps.getCopyTagsToSnapshot()
copyTagsToSnapshot
(IResolvable copyTagsToSnapshot) Sets the value ofCfnDBClusterProps.getCopyTagsToSnapshot()
databaseName
(String databaseName) Sets the value ofCfnDBClusterProps.getDatabaseName()
dbClusterIdentifier
(String dbClusterIdentifier) Sets the value ofCfnDBClusterProps.getDbClusterIdentifier()
dbClusterInstanceClass
(String dbClusterInstanceClass) Sets the value ofCfnDBClusterProps.getDbClusterInstanceClass()
dbClusterParameterGroupName
(String dbClusterParameterGroupName) Sets the value ofCfnDBClusterProps.getDbClusterParameterGroupName()
dbInstanceParameterGroupName
(String dbInstanceParameterGroupName) Sets the value ofCfnDBClusterProps.getDbInstanceParameterGroupName()
dbSubnetGroupName
(String dbSubnetGroupName) Sets the value ofCfnDBClusterProps.getDbSubnetGroupName()
dbSystemId
(String dbSystemId) Sets the value ofCfnDBClusterProps.getDbSystemId()
deletionProtection
(Boolean deletionProtection) Sets the value ofCfnDBClusterProps.getDeletionProtection()
deletionProtection
(IResolvable deletionProtection) Sets the value ofCfnDBClusterProps.getDeletionProtection()
Sets the value ofCfnDBClusterProps.getDomain()
domainIamRoleName
(String domainIamRoleName) Sets the value ofCfnDBClusterProps.getDomainIamRoleName()
enableCloudwatchLogsExports
(List<String> enableCloudwatchLogsExports) Sets the value ofCfnDBClusterProps.getEnableCloudwatchLogsExports()
enableGlobalWriteForwarding
(Boolean enableGlobalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableGlobalWriteForwarding()
enableGlobalWriteForwarding
(IResolvable enableGlobalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableGlobalWriteForwarding()
enableHttpEndpoint
(Boolean enableHttpEndpoint) Sets the value ofCfnDBClusterProps.getEnableHttpEndpoint()
enableHttpEndpoint
(IResolvable enableHttpEndpoint) Sets the value ofCfnDBClusterProps.getEnableHttpEndpoint()
enableIamDatabaseAuthentication
(Boolean enableIamDatabaseAuthentication) Sets the value ofCfnDBClusterProps.getEnableIamDatabaseAuthentication()
enableIamDatabaseAuthentication
(IResolvable enableIamDatabaseAuthentication) Sets the value ofCfnDBClusterProps.getEnableIamDatabaseAuthentication()
enableLocalWriteForwarding
(Boolean enableLocalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableLocalWriteForwarding()
enableLocalWriteForwarding
(IResolvable enableLocalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableLocalWriteForwarding()
Sets the value ofCfnDBClusterProps.getEngine()
engineLifecycleSupport
(String engineLifecycleSupport) Sets the value ofCfnDBClusterProps.getEngineLifecycleSupport()
engineMode
(String engineMode) Sets the value ofCfnDBClusterProps.getEngineMode()
engineVersion
(String engineVersion) Sets the value ofCfnDBClusterProps.getEngineVersion()
globalClusterIdentifier
(String globalClusterIdentifier) Sets the value ofCfnDBClusterProps.getGlobalClusterIdentifier()
Sets the value ofCfnDBClusterProps.getIops()
Sets the value ofCfnDBClusterProps.getKmsKeyId()
manageMasterUserPassword
(Boolean manageMasterUserPassword) Sets the value ofCfnDBClusterProps.getManageMasterUserPassword()
manageMasterUserPassword
(IResolvable manageMasterUserPassword) Sets the value ofCfnDBClusterProps.getManageMasterUserPassword()
masterUsername
(String masterUsername) Sets the value ofCfnDBClusterProps.getMasterUsername()
masterUserPassword
(String masterUserPassword) Sets the value ofCfnDBClusterProps.getMasterUserPassword()
masterUserSecret
(IResolvable masterUserSecret) Sets the value ofCfnDBClusterProps.getMasterUserSecret()
masterUserSecret
(CfnDBCluster.MasterUserSecretProperty masterUserSecret) Sets the value ofCfnDBClusterProps.getMasterUserSecret()
monitoringInterval
(Number monitoringInterval) Sets the value ofCfnDBClusterProps.getMonitoringInterval()
monitoringRoleArn
(String monitoringRoleArn) Sets the value ofCfnDBClusterProps.getMonitoringRoleArn()
networkType
(String networkType) Sets the value ofCfnDBClusterProps.getNetworkType()
performanceInsightsEnabled
(Boolean performanceInsightsEnabled) Sets the value ofCfnDBClusterProps.getPerformanceInsightsEnabled()
performanceInsightsEnabled
(IResolvable performanceInsightsEnabled) Sets the value ofCfnDBClusterProps.getPerformanceInsightsEnabled()
performanceInsightsKmsKeyId
(String performanceInsightsKmsKeyId) Sets the value ofCfnDBClusterProps.getPerformanceInsightsKmsKeyId()
performanceInsightsRetentionPeriod
(Number performanceInsightsRetentionPeriod) Sets the value ofCfnDBClusterProps.getPerformanceInsightsRetentionPeriod()
Sets the value ofCfnDBClusterProps.getPort()
preferredBackupWindow
(String preferredBackupWindow) Sets the value ofCfnDBClusterProps.getPreferredBackupWindow()
preferredMaintenanceWindow
(String preferredMaintenanceWindow) Sets the value ofCfnDBClusterProps.getPreferredMaintenanceWindow()
publiclyAccessible
(Boolean publiclyAccessible) Sets the value ofCfnDBClusterProps.getPubliclyAccessible()
publiclyAccessible
(IResolvable publiclyAccessible) Sets the value ofCfnDBClusterProps.getPubliclyAccessible()
replicationSourceIdentifier
(String replicationSourceIdentifier) Sets the value ofCfnDBClusterProps.getReplicationSourceIdentifier()
restoreToTime
(String restoreToTime) Sets the value ofCfnDBClusterProps.getRestoreToTime()
restoreType
(String restoreType) Sets the value ofCfnDBClusterProps.getRestoreType()
scalingConfiguration
(IResolvable scalingConfiguration) Sets the value ofCfnDBClusterProps.getScalingConfiguration()
scalingConfiguration
(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration) Sets the value ofCfnDBClusterProps.getScalingConfiguration()
serverlessV2ScalingConfiguration
(IResolvable serverlessV2ScalingConfiguration) Sets the value ofCfnDBClusterProps.getServerlessV2ScalingConfiguration()
serverlessV2ScalingConfiguration
(CfnDBCluster.ServerlessV2ScalingConfigurationProperty serverlessV2ScalingConfiguration) Sets the value ofCfnDBClusterProps.getServerlessV2ScalingConfiguration()
snapshotIdentifier
(String snapshotIdentifier) Sets the value ofCfnDBClusterProps.getSnapshotIdentifier()
sourceDbClusterIdentifier
(String sourceDbClusterIdentifier) Sets the value ofCfnDBClusterProps.getSourceDbClusterIdentifier()
sourceRegion
(String sourceRegion) Sets the value ofCfnDBClusterProps.getSourceRegion()
storageEncrypted
(Boolean storageEncrypted) Sets the value ofCfnDBClusterProps.getStorageEncrypted()
storageEncrypted
(IResolvable storageEncrypted) Sets the value ofCfnDBClusterProps.getStorageEncrypted()
storageType
(String storageType) Sets the value ofCfnDBClusterProps.getStorageType()
Sets the value ofCfnDBClusterProps.getTags()
useLatestRestorableTime
(Boolean useLatestRestorableTime) Sets the value ofCfnDBClusterProps.getUseLatestRestorableTime()
useLatestRestorableTime
(IResolvable useLatestRestorableTime) Sets the value ofCfnDBClusterProps.getUseLatestRestorableTime()
vpcSecurityGroupIds
(List<String> vpcSecurityGroupIds) Sets the value ofCfnDBClusterProps.getVpcSecurityGroupIds()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allocatedStorage
Sets the value ofCfnDBClusterProps.getAllocatedStorage()
- Parameters:
allocatedStorage
- The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters onlyThis setting is required to create a Multi-AZ DB cluster.
- Returns:
this
-
associatedRoles
Sets the value ofCfnDBClusterProps.getAssociatedRoles()
- Parameters:
associatedRoles
- Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
associatedRoles
@Stability(Stable) public CfnDBClusterProps.Builder associatedRoles(List<? extends Object> associatedRoles) Sets the value ofCfnDBClusterProps.getAssociatedRoles()
- Parameters:
associatedRoles
- Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnDBClusterProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Sets the value ofCfnDBClusterProps.getAutoMinorVersionUpgrade()
- Parameters:
autoMinorVersionUpgrade
- Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnDBClusterProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnDBClusterProps.getAutoMinorVersionUpgrade()
- Parameters:
autoMinorVersionUpgrade
- Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
availabilityZones
@Stability(Stable) public CfnDBClusterProps.Builder availabilityZones(List<String> availabilityZones) Sets the value ofCfnDBClusterProps.getAvailabilityZones()
- Parameters:
availabilityZones
- A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .Valid for: Aurora DB clusters only
- Returns:
this
-
backtrackWindow
Sets the value ofCfnDBClusterProps.getBacktrackWindow()
- Parameters:
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to0
. Valid for Cluster Type: Aurora MySQL DB clusters onlyDefault:
0
Constraints:
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
- Returns:
this
-
backupRetentionPeriod
@Stability(Stable) public CfnDBClusterProps.Builder backupRetentionPeriod(Number backupRetentionPeriod) Sets the value ofCfnDBClusterProps.getBackupRetentionPeriod()
- Parameters:
backupRetentionPeriod
- The number of days for which automated backups are retained. Default: 1Constraints:
- Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
copyTagsToSnapshot
Sets the value ofCfnDBClusterProps.getCopyTagsToSnapshot()
- Parameters:
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
copyTagsToSnapshot
@Stability(Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot) Sets the value ofCfnDBClusterProps.getCopyTagsToSnapshot()
- Parameters:
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
databaseName
Sets the value ofCfnDBClusterProps.getDatabaseName()
- Parameters:
databaseName
- The name of your database. 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 .Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
dbClusterIdentifier
Sets the value ofCfnDBClusterProps.getDbClusterIdentifier()
- Parameters:
dbClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase string. Constraints:- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
dbClusterInstanceClass
@Stability(Stable) public CfnDBClusterProps.Builder dbClusterInstanceClass(String dbClusterInstanceClass) Sets the value ofCfnDBClusterProps.getDbClusterInstanceClass()
- Parameters:
dbClusterInstanceClass
- The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for exampledb.m6gd.xlarge
. Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
dbClusterParameterGroupName
@Stability(Stable) public CfnDBClusterProps.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName) Sets the value ofCfnDBClusterProps.getDbClusterParameterGroupName()
- Parameters:
dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster.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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
dbInstanceParameterGroupName
@Stability(Stable) public CfnDBClusterProps.Builder dbInstanceParameterGroupName(String dbInstanceParameterGroupName) Sets the value ofCfnDBClusterProps.getDbInstanceParameterGroupName()
- Parameters:
dbInstanceParameterGroupName
- The name of the DB parameter group to apply to all instances of the DB cluster.When you apply a parameter group using the
DBInstanceParameterGroupName
parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
- The DB parameter group must be in the same DB parameter group family as this DB cluster.
- The
DBInstanceParameterGroupName
parameter is valid in combination with theAllowMajorVersionUpgrade
parameter for a major version upgrade only.
- Returns:
this
-
dbSubnetGroupName
Sets the value ofCfnDBClusterProps.getDbSubnetGroupName()
- Parameters:
dbSubnetGroupName
- A DB subnet group that you want to associate with this DB cluster. If you are restoring a DB cluster to a point in time withRestoreType
set tocopy-on-write
, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
dbSystemId
Sets the value ofCfnDBClusterProps.getDbSystemId()
- Parameters:
dbSystemId
- Reserved for future use.- Returns:
this
-
deletionProtection
Sets the value ofCfnDBClusterProps.getDeletionProtection()
- Parameters:
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
deletionProtection
@Stability(Stable) public CfnDBClusterProps.Builder deletionProtection(IResolvable deletionProtection) Sets the value ofCfnDBClusterProps.getDeletionProtection()
- Parameters:
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
domain
Sets the value ofCfnDBClusterProps.getDomain()
- Parameters:
domain
- Indicates the directory ID of the Active Directory to create the DB cluster. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.For more information, see Kerberos authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
- Returns:
this
-
domainIamRoleName
Sets the value ofCfnDBClusterProps.getDomainIamRoleName()
- Parameters:
domainIamRoleName
- Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only- Returns:
this
-
enableCloudwatchLogsExports
@Stability(Stable) public CfnDBClusterProps.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports) Sets the value ofCfnDBClusterProps.getEnableCloudwatchLogsExports()
- Parameters:
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. 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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
enableGlobalWriteForwarding
@Stability(Stable) public CfnDBClusterProps.Builder enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableGlobalWriteForwarding()
- Parameters:
enableGlobalWriteForwarding
- Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
- Returns:
this
-
enableGlobalWriteForwarding
@Stability(Stable) public CfnDBClusterProps.Builder enableGlobalWriteForwarding(IResolvable enableGlobalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableGlobalWriteForwarding()
- Parameters:
enableGlobalWriteForwarding
- Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
- Returns:
this
-
enableHttpEndpoint
Sets the value ofCfnDBClusterProps.getEnableHttpEndpoint()
- Parameters:
enableHttpEndpoint
- Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.RDS Data API is supported with the following DB clusters:
- Aurora PostgreSQL Serverless v2 and provisioned
- Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
- Returns:
this
-
enableHttpEndpoint
@Stability(Stable) public CfnDBClusterProps.Builder enableHttpEndpoint(IResolvable enableHttpEndpoint) Sets the value ofCfnDBClusterProps.getEnableHttpEndpoint()
- Parameters:
enableHttpEndpoint
- Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.RDS Data API is supported with the following DB clusters:
- Aurora PostgreSQL Serverless v2 and provisioned
- Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
- Returns:
this
-
enableIamDatabaseAuthentication
@Stability(Stable) public CfnDBClusterProps.Builder enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication) Sets the value ofCfnDBClusterProps.getEnableIamDatabaseAuthentication()
- Parameters:
enableIamDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
- Returns:
this
-
enableIamDatabaseAuthentication
@Stability(Stable) public CfnDBClusterProps.Builder enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication) Sets the value ofCfnDBClusterProps.getEnableIamDatabaseAuthentication()
- Parameters:
enableIamDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
- Returns:
this
-
enableLocalWriteForwarding
@Stability(Stable) public CfnDBClusterProps.Builder enableLocalWriteForwarding(Boolean enableLocalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableLocalWriteForwarding()
- Parameters:
enableLocalWriteForwarding
- Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.Valid for: Aurora DB clusters only
- Returns:
this
-
enableLocalWriteForwarding
@Stability(Stable) public CfnDBClusterProps.Builder enableLocalWriteForwarding(IResolvable enableLocalWriteForwarding) Sets the value ofCfnDBClusterProps.getEnableLocalWriteForwarding()
- Parameters:
enableLocalWriteForwarding
- Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.Valid for: Aurora DB clusters only
- Returns:
this
-
engine
Sets the value ofCfnDBClusterProps.getEngine()
- Parameters:
engine
- The name of the database engine to be used for this DB cluster. Valid Values:aurora-mysql
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
engineLifecycleSupport
@Stability(Stable) public CfnDBClusterProps.Builder engineLifecycleSupport(String engineLifecycleSupport) Sets the value ofCfnDBClusterProps.getEngineLifecycleSupport()
- Parameters:
engineLifecycleSupport
- The life cycle type for this DB cluster.By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
- Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
- Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
- Returns:
this
-
engineMode
Sets the value ofCfnDBClusterProps.getEngineMode()
- Parameters:
engineMode
- The DB engine mode of the DB cluster, eitherprovisioned
orserverless
. Theserverless
engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use theprovisioned
engine mode.For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :
Valid for Cluster Type: Aurora DB clusters only
- Returns:
this
-
engineVersion
Sets the value ofCfnDBClusterProps.getEngineVersion()
- Parameters:
engineVersion
- The version number of the database engine to use. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either
5.7
or8.0
to use the default engine version for Aurora MySQL version 2 or version 3, respectively.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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .
Aurora PostgreSQL
For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
MySQL
For information, see Amazon RDS for MySQL in the Amazon RDS User Guide .
PostgreSQL
For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
globalClusterIdentifier
@Stability(Stable) public CfnDBClusterProps.Builder globalClusterIdentifier(String globalClusterIdentifier) Sets the value ofCfnDBClusterProps.getGlobalClusterIdentifier()
- Parameters:
globalClusterIdentifier
- 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. 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
GlobalClusterIdentifier
property.For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
- Returns:
this
-
iops
Sets the value ofCfnDBClusterProps.getIops()
- Parameters:
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide .This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
- Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
- Returns:
this
-
kmsKeyId
Sets the value ofCfnDBClusterProps.getKmsKeyId()
- Parameters:
kmsKeyId
- The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such asarn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable theStorageEncrypted
property but don't specify this property, the default KMS key is used. If you specify this property, you must set theStorageEncrypted
property totrue
.If you specify the
SnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB cluster is encrypted, the specifiedKmsKeyId
property is used.If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set
KmsKeyId
to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
manageMasterUserPassword
@Stability(Stable) public CfnDBClusterProps.Builder manageMasterUserPassword(Boolean manageMasterUserPassword) Sets the value ofCfnDBClusterProps.getManageMasterUserPassword()
- Parameters:
manageMasterUserPassword
- Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
- Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified.
- Can't manage the master user password with AWS Secrets Manager if
- Returns:
this
-
manageMasterUserPassword
@Stability(Stable) public CfnDBClusterProps.Builder manageMasterUserPassword(IResolvable manageMasterUserPassword) Sets the value ofCfnDBClusterProps.getManageMasterUserPassword()
- Parameters:
manageMasterUserPassword
- Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
- Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified.
- Can't manage the master user password with AWS Secrets Manager if
- Returns:
this
-
masterUsername
Sets the value ofCfnDBClusterProps.getMasterUsername()
- Parameters:
masterUsername
- The name of the master user for the DB cluster.If you specify the
SourceDBClusterIdentifier
,SnapshotIdentifier
, orGlobalClusterIdentifier
property, 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.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
masterUserPassword
Sets the value ofCfnDBClusterProps.getMasterUserPassword()
- Parameters:
masterUserPassword
- The master password for the DB instance.If you specify the
SourceDBClusterIdentifier
,SnapshotIdentifier
, orGlobalClusterIdentifier
property, 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.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
masterUserSecret
Sets the value ofCfnDBClusterProps.getMasterUserSecret()
- Parameters:
masterUserSecret
- The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.- Returns:
this
-
masterUserSecret
@Stability(Stable) public CfnDBClusterProps.Builder masterUserSecret(CfnDBCluster.MasterUserSecretProperty masterUserSecret) Sets the value ofCfnDBClusterProps.getMasterUserSecret()
- Parameters:
masterUserSecret
- The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.- Returns:
this
-
monitoringInterval
Sets the value ofCfnDBClusterProps.getMonitoringInterval()
- Parameters:
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify0
.If
MonitoringRoleArn
is specified, also setMonitoringInterval
to a value other than0
.Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
- Returns:
this
-
monitoringRoleArn
Sets the value ofCfnDBClusterProps.getMonitoringRoleArn()
- Parameters:
monitoringRoleArn
- The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example isarn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .If
MonitoringInterval
is set to a value other than0
, supply aMonitoringRoleArn
value.Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
networkType
Sets the value ofCfnDBClusterProps.getNetworkType()
- Parameters:
networkType
- The network type of the DB cluster. Valid values:IPV4
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
- Returns:
this
-
performanceInsightsEnabled
@Stability(Stable) public CfnDBClusterProps.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled) Sets the value ofCfnDBClusterProps.getPerformanceInsightsEnabled()
- Parameters:
performanceInsightsEnabled
- Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
performanceInsightsEnabled
@Stability(Stable) public CfnDBClusterProps.Builder performanceInsightsEnabled(IResolvable performanceInsightsEnabled) Sets the value ofCfnDBClusterProps.getPerformanceInsightsEnabled()
- Parameters:
performanceInsightsEnabled
- Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
performanceInsightsKmsKeyId
@Stability(Stable) public CfnDBClusterProps.Builder performanceInsightsKmsKeyId(String performanceInsightsKmsKeyId) Sets the value ofCfnDBClusterProps.getPerformanceInsightsKmsKeyId()
- Parameters:
performanceInsightsKmsKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.If you don't specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .Valid for Cluster Type: Multi-AZ DB clusters only
- Returns:
this
-
performanceInsightsRetentionPeriod
@Stability(Stable) public CfnDBClusterProps.Builder performanceInsightsRetentionPeriod(Number performanceInsightsRetentionPeriod) Sets the value ofCfnDBClusterProps.getPerformanceInsightsRetentionPeriod()
- Parameters:
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data. Valid for Cluster Type: Multi-AZ DB clusters onlyValid Values:
7
- month * 31, where month is a number of months from 1-23. Examples:
93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) 731
Default:
7
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS issues an error.- Returns:
this
-
port
Sets the value ofCfnDBClusterProps.getPort()
- Parameters:
port
- The port number on which the DB instances in the DB cluster accept connections. Default:- When
EngineMode
isprovisioned
,3306
(for both Aurora MySQL and Aurora PostgreSQL) - When
EngineMode
isserverless
: 3306
whenEngine
isaurora
oraurora-mysql
5432
whenEngine
isaurora-postgresql
The
No interruption
on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- When
- Returns:
this
-
preferredBackupWindow
@Stability(Stable) public CfnDBClusterProps.Builder preferredBackupWindow(String preferredBackupWindow) Sets the value ofCfnDBClusterProps.getPreferredBackupWindow()
- Parameters:
preferredBackupWindow
- The daily time range during which automated backups are created. For more information, see Backup Window in the Amazon Aurora User Guide.Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Must be in the format
- Returns:
this
-
preferredMaintenanceWindow
@Stability(Stable) public CfnDBClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofCfnDBClusterProps.getPreferredMaintenanceWindow()
- Parameters:
preferredMaintenanceWindow
- The weekly time range 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. 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
publiclyAccessible
Sets the value ofCfnDBClusterProps.getPubliclyAccessible()
- Parameters:
publiclyAccessible
- Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn't specified, andPubliclyAccessible
isn't specified, the following applies:- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn't specified, the following applies:- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
- Returns:
this
-
publiclyAccessible
@Stability(Stable) public CfnDBClusterProps.Builder publiclyAccessible(IResolvable publiclyAccessible) Sets the value ofCfnDBClusterProps.getPubliclyAccessible()
- Parameters:
publiclyAccessible
- Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn't specified, andPubliclyAccessible
isn't specified, the following applies:- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupName
is specified, andPubliclyAccessible
isn't specified, the following applies:- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
- Returns:
this
-
replicationSourceIdentifier
@Stability(Stable) public CfnDBClusterProps.Builder replicationSourceIdentifier(String replicationSourceIdentifier) Sets the value ofCfnDBClusterProps.getReplicationSourceIdentifier()
- Parameters:
replicationSourceIdentifier
- The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters only- Returns:
this
-
restoreToTime
Sets the value ofCfnDBClusterProps.getRestoreToTime()
- Parameters:
restoreToTime
- The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) formatConstraints:
- Must be before the latest restorable time for the DB instance
- Must be specified if
UseLatestRestorableTime
parameter isn't provided - Can't be specified if the
UseLatestRestorableTime
parameter is enabled - Can't be specified if the
RestoreType
parameter iscopy-on-write
This property must be used with
SourceDBClusterIdentifier
property. The resulting cluster will have the identifier that matches the value of theDBclusterIdentifier
property.Example:
2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
restoreType
Sets the value ofCfnDBClusterProps.getRestoreType()
- Parameters:
restoreType
- The type of restore to be performed. You can specify one of the following values:.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.
If you don't specify a
RestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
scalingConfiguration
@Stability(Stable) public CfnDBClusterProps.Builder scalingConfiguration(IResolvable scalingConfiguration) Sets the value ofCfnDBClusterProps.getScalingConfiguration()
- Parameters:
scalingConfiguration
- The scaling configuration of an Aurora Serverless v1 DB cluster. This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use theServerlessV2ScalingConfiguration
property.Valid for: Aurora Serverless v1 DB clusters only
- Returns:
this
-
scalingConfiguration
@Stability(Stable) public CfnDBClusterProps.Builder scalingConfiguration(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration) Sets the value ofCfnDBClusterProps.getScalingConfiguration()
- Parameters:
scalingConfiguration
- The scaling configuration of an Aurora Serverless v1 DB cluster. This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use theServerlessV2ScalingConfiguration
property.Valid for: Aurora Serverless v1 DB clusters only
- Returns:
this
-
serverlessV2ScalingConfiguration
@Stability(Stable) public CfnDBClusterProps.Builder serverlessV2ScalingConfiguration(IResolvable serverlessV2ScalingConfiguration) Sets the value ofCfnDBClusterProps.getServerlessV2ScalingConfiguration()
- Parameters:
serverlessV2ScalingConfiguration
- The scaling configuration of an Aurora Serverless V2 DB cluster. This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use theScalingConfiguration
property.Valid for: Aurora Serverless v2 DB clusters only
- Returns:
this
-
serverlessV2ScalingConfiguration
@Stability(Stable) public CfnDBClusterProps.Builder serverlessV2ScalingConfiguration(CfnDBCluster.ServerlessV2ScalingConfigurationProperty serverlessV2ScalingConfiguration) Sets the value ofCfnDBClusterProps.getServerlessV2ScalingConfiguration()
- Parameters:
serverlessV2ScalingConfiguration
- The scaling configuration of an Aurora Serverless V2 DB cluster. This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use theScalingConfiguration
property.Valid for: Aurora Serverless v2 DB clusters only
- Returns:
this
-
snapshotIdentifier
Sets the value ofCfnDBClusterProps.getSnapshotIdentifier()
- Parameters:
snapshotIdentifier
- The identifier for the DB snapshot or DB cluster snapshot to restore from. 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 sameSnapshotIdentifier
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 theSnapshotIdentifier
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 specifiedSnapshotIdentifier
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:GlobalClusterIdentifier
MasterUsername
MasterUserPassword
ReplicationSourceIdentifier
RestoreType
SourceDBClusterIdentifier
SourceRegion
StorageEncrypted
(for an encrypted snapshot)UseLatestRestorableTime
Constraints:
- Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
sourceDbClusterIdentifier
@Stability(Stable) public CfnDBClusterProps.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier) Sets the value ofCfnDBClusterProps.getSourceDbClusterIdentifier()
- Parameters:
sourceDbClusterIdentifier
- When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore. Constraints:- Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
sourceRegion
Sets the value ofCfnDBClusterProps.getSourceRegion()
- Parameters:
sourceRegion
- The AWS Region which contains the source DB cluster when replicating a DB cluster. For example,us-east-1
. Valid for: Aurora DB clusters only- Returns:
this
-
storageEncrypted
Sets the value ofCfnDBClusterProps.getStorageEncrypted()
- Parameters:
storageEncrypted
- Indicates whether the DB cluster is encrypted. If you specify theKmsKeyId
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 specifiedKmsKeyId
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 specifiedKmsKeyId
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 theKmsKeyId
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 tofalse
.If you specify both the
StorageEncrypted
andSnapshotIdentifier
properties without specifying theKmsKeyId
property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
storageEncrypted
Sets the value ofCfnDBClusterProps.getStorageEncrypted()
- Parameters:
storageEncrypted
- Indicates whether the DB cluster is encrypted. If you specify theKmsKeyId
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 specifiedKmsKeyId
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 specifiedKmsKeyId
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 theKmsKeyId
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 tofalse
.If you specify both the
StorageEncrypted
andSnapshotIdentifier
properties without specifying theKmsKeyId
property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
storageType
Sets the value ofCfnDBClusterProps.getStorageType()
- Parameters:
storageType
- The storage type to associate with the DB cluster. For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iops
parameter is required.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
- Aurora DB clusters -
aurora | aurora-iopt1
- Multi-AZ DB clusters -
io1 | io2 | gp3
Default:
- Aurora DB clusters -
aurora
- Multi-AZ DB clusters -
io1
When you create an Aurora DB cluster with the storage type set to
aurora-iopt1
, the storage type is returned in the response. The storage type isn't returned when you set it toaurora
.- Aurora DB clusters -
- Returns:
this
-
tags
Sets the value ofCfnDBClusterProps.getTags()
- Parameters:
tags
- Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters- Returns:
this
-
useLatestRestorableTime
@Stability(Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(Boolean useLatestRestorableTime) Sets the value ofCfnDBClusterProps.getUseLatestRestorableTime()
- Parameters:
useLatestRestorableTime
- A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
useLatestRestorableTime
@Stability(Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime) Sets the value ofCfnDBClusterProps.getUseLatestRestorableTime()
- Parameters:
useLatestRestorableTime
- A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
vpcSecurityGroupIds
@Stability(Stable) public CfnDBClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds) Sets the value ofCfnDBClusterProps.getVpcSecurityGroupIds()
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster. If you plan to update the resource, don't specify VPC security groups in a shared VPC.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDBClusterProps>
- Returns:
- a new instance of
CfnDBClusterProps
- Throws:
NullPointerException
- if any required attribute was not provided
-