@Stability(value=Stable) public static final class CfnDBClusterProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDBClusterProps>
CfnDBClusterProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnDBClusterProps.Builder engine(String engine)
CfnDBClusterProps.getEngine()engine - The name of the database engine to be used for this DB cluster. This parameter is required.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible Aurora)aurora-postgresqlmysqlpostgresValid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder allocatedStorage(Number allocatedStorage)
CfnDBClusterProps.getAllocatedStorage()allocatedStorage - The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder associatedRoles(IResolvable associatedRoles)
CfnDBClusterProps.getAssociatedRoles()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder associatedRoles(List<? extends Object> associatedRoles)
CfnDBClusterProps.getAssociatedRoles()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
CfnDBClusterProps.getAutoMinorVersionUpgrade()autoMinorVersionUpgrade - A value that indicates 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: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
CfnDBClusterProps.getAutoMinorVersionUpgrade()autoMinorVersionUpgrade - A value that indicates 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: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder availabilityZones(List<String> availabilityZones)
CfnDBClusterProps.getAvailabilityZones()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder backtrackWindow(Number backtrackWindow)
CfnDBClusterProps.getBacktrackWindow()backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
Valid for: Aurora MySQL DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder backupRetentionPeriod(Number backupRetentionPeriod)
CfnDBClusterProps.getBackupRetentionPeriod()backupRetentionPeriod - The number of days for which automated backups are retained.
Default: 1
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
CfnDBClusterProps.getCopyTagsToSnapshot()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
CfnDBClusterProps.getCopyTagsToSnapshot()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder databaseName(String databaseName)
CfnDBClusterProps.getDatabaseName()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder dbClusterIdentifier(String dbClusterIdentifier)
CfnDBClusterProps.getDbClusterIdentifier()dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder dbClusterInstanceClass(String dbClusterInstanceClass)
CfnDBClusterProps.getDbClusterInstanceClass()dbClusterInstanceClass - The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.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: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
CfnDBClusterProps.getDbClusterParameterGroupName()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder dbInstanceParameterGroupName(String dbInstanceParameterGroupName)
CfnDBClusterProps.getDbInstanceParameterGroupName()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
DBInstanceParameterGroupNameparameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Default: The existing name setting
Constraints:
this@Stability(value=Stable) public CfnDBClusterProps.Builder dbSubnetGroupName(String dbSubnetGroupName)
CfnDBClusterProps.getDbSubnetGroupName()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 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder deletionProtection(Boolean deletionProtection)
CfnDBClusterProps.getDeletionProtection()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder deletionProtection(IResolvable deletionProtection)
CfnDBClusterProps.getDeletionProtection()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder domain(String domain)
CfnDBClusterProps.getDomain()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder domainIamRoleName(String domainIamRoleName)
CfnDBClusterProps.getDomainIamRoleName()domainIamRoleName - Specifies the name of the IAM role to use when making API calls to the Directory Service.
Valid for: Aurora DB clusters onlythis@Stability(value=Stable) public CfnDBClusterProps.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)
CfnDBClusterProps.getEnableCloudwatchLogsExports()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
CfnDBClusterProps.getEnableHttpEndpoint()enableHttpEndpoint - A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
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 .
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder enableHttpEndpoint(IResolvable enableHttpEndpoint)
CfnDBClusterProps.getEnableHttpEndpoint()enableHttpEndpoint - A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
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 .
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication)
CfnDBClusterProps.getEnableIamDatabaseAuthentication()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication)
CfnDBClusterProps.getEnableIamDatabaseAuthentication()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder engineMode(String engineMode)
CfnDBClusterProps.getEngineMode()engineMode - The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
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 :
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder engineVersion(String engineVersion)
CfnDBClusterProps.getEngineVersion()engineVersion - The version number of the database engine to use.
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"
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder globalClusterIdentifier(String globalClusterIdentifier)
CfnDBClusterProps.getGlobalClusterIdentifier()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
GlobalClusterIdentifierproperty.
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
this@Stability(value=Stable) public CfnDBClusterProps.Builder iops(Number iops)
CfnDBClusterProps.getIops()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 Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide .
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder kmsKeyId(String kmsKeyId)
CfnDBClusterProps.getKmsKeyId()kmsKeyId - 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` .
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder masterUsername(String masterUsername)
CfnDBClusterProps.getMasterUsername()masterUsername - The name of the master user for the DB cluster.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder masterUserPassword(String masterUserPassword)
CfnDBClusterProps.getMasterUserPassword()masterUserPassword - The master password for the DB instance.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder monitoringInterval(Number monitoringInterval)
CfnDBClusterProps.getMonitoringInterval()monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder monitoringRoleArn(String monitoringRoleArn)
CfnDBClusterProps.getMonitoringRoleArn()monitoringRoleArn - The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
An example is arn: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 than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder networkType(String networkType)
CfnDBClusterProps.getNetworkType()networkType - The network type of the DB cluster.
Valid values:
IPV4DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup 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
this@Stability(value=Stable) public CfnDBClusterProps.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled)
CfnDBClusterProps.getPerformanceInsightsEnabled()performanceInsightsEnabled - A value that indicates 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: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder performanceInsightsEnabled(IResolvable performanceInsightsEnabled)
CfnDBClusterProps.getPerformanceInsightsEnabled()performanceInsightsEnabled - A value that indicates 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: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder performanceInsightsKmsKeyId(String performanceInsightsKmsKeyId)
CfnDBClusterProps.getPerformanceInsightsKmsKeyId()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: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder performanceInsightsRetentionPeriod(Number performanceInsightsRetentionPeriod)
CfnDBClusterProps.getPerformanceInsightsRetentionPeriod()performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:.
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder port(Number port)
CfnDBClusterProps.getPort()port - The port number on which the DB instances in the DB cluster accept connections.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder preferredBackupWindow(String preferredBackupWindow)
CfnDBClusterProps.getPreferredBackupWindow()preferredBackupWindow - The daily time range during which automated backups are created.
For more information, see Backup Window in the Amazon Aurora User Guide.
Constraints:
hh24:mi-hh24:mi .Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
CfnDBClusterProps.getPreferredMaintenanceWindow()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder publiclyAccessible(Boolean publiclyAccessible)
CfnDBClusterProps.getPubliclyAccessible()publiclyAccessible - A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder publiclyAccessible(IResolvable publiclyAccessible)
CfnDBClusterProps.getPubliclyAccessible()publiclyAccessible - A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder replicationSourceIdentifier(String replicationSourceIdentifier)
CfnDBClusterProps.getReplicationSourceIdentifier()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 onlythis@Stability(value=Stable) public CfnDBClusterProps.Builder restoreType(String restoreType)
CfnDBClusterProps.getRestoreType()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.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder scalingConfiguration(IResolvable scalingConfiguration)
CfnDBClusterProps.getScalingConfiguration()scalingConfiguration - The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use ServerlessV2ScalingConfiguration property.
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder scalingConfiguration(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration)
CfnDBClusterProps.getScalingConfiguration()scalingConfiguration - The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use ServerlessV2ScalingConfiguration property.
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder serverlessV2ScalingConfiguration(IResolvable serverlessV2ScalingConfiguration)
CfnDBClusterProps.getServerlessV2ScalingConfiguration()serverlessV2ScalingConfiguration - The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster.
This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use ScalingConfiguration property.
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder serverlessV2ScalingConfiguration(CfnDBCluster.ServerlessV2ScalingConfigurationProperty serverlessV2ScalingConfiguration)
CfnDBClusterProps.getServerlessV2ScalingConfiguration()serverlessV2ScalingConfiguration - The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster.
This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use ScalingConfiguration property.
Valid for: Aurora DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder snapshotIdentifier(String snapshotIdentifier)
CfnDBClusterProps.getSnapshotIdentifier()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 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:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)
CfnDBClusterProps.getSourceDbClusterIdentifier()sourceDbClusterIdentifier - When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder sourceRegion(String sourceRegion)
CfnDBClusterProps.getSourceRegion()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 onlythis@Stability(value=Stable) public CfnDBClusterProps.Builder storageEncrypted(Boolean storageEncrypted)
CfnDBClusterProps.getStorageEncrypted()storageEncrypted - Indicates whether the DB cluster is encrypted.
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 .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder storageEncrypted(IResolvable storageEncrypted)
CfnDBClusterProps.getStorageEncrypted()storageEncrypted - Indicates whether the DB cluster is encrypted.
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 .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
this@Stability(value=Stable) public CfnDBClusterProps.Builder storageType(String storageType)
CfnDBClusterProps.getStorageType()storageType - Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
this@Stability(value=Stable) public CfnDBClusterProps.Builder tags(List<? extends CfnTag> tags)
CfnDBClusterProps.getTags()tags - An optional array of key-value pairs to apply to this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clustersthis@Stability(value=Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)
CfnDBClusterProps.getUseLatestRestorableTime()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime)
CfnDBClusterProps.getUseLatestRestorableTime()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
this@Stability(value=Stable) public CfnDBClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)
CfnDBClusterProps.getVpcSecurityGroupIds()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
this@Stability(value=Stable) public CfnDBClusterProps build()
build in interface software.amazon.jsii.Builder<CfnDBClusterProps>CfnDBClusterPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.