@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDBClusterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateDBClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
Boolean |
getAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the
maintenance window.
|
List<String> |
getAvailabilityZones()
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getCharacterSetName()
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
String |
getDatabaseName()
The name for your database of up to 64 alphanumeric characters.
|
String |
getDBClusterIdentifier()
The DB cluster identifier.
|
String |
getDBClusterInstanceClass()
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDBSubnetGroupName()
A DB subnet group to associate with this DB cluster.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
String |
getDomain()
The Active Directory directory ID to create the DB cluster in.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Boolean |
getEnableGlobalWriteForwarding()
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an
Aurora global database (GlobalCluster).
|
Boolean |
getEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
Boolean |
getEnablePerformanceInsights()
A value that indicates whether to turn on Performance Insights for the DB cluster.
|
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()
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
Integer |
getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
|
String |
getKmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
String |
getMasterUsername()
The name of the master user for the DB cluster.
|
String |
getMasterUserPassword()
The password for the master database user.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
String |
getMonitoringRoleArn()
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs.
|
String |
getOptionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
|
String |
getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
Integer |
getPort()
The port number on which the instances in the DB cluster accept connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
getPreSignedUrl()
A URL that contains a Signature Version 4 signed request for the
CreateDBCluster action to be called
in the source Amazon Web Services Region where the DB cluster is replicated from. |
Boolean |
getPubliclyAccessible()
A value that indicates whether the DB cluster is publicly accessible.
|
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.
|
ScalingConfiguration |
getScalingConfiguration()
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
String |
getSourceRegion()
The region where the source instance is located.
|
Boolean |
getStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB cluster.
|
List<Tag> |
getTags()
Tags to assign to the DB cluster.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the
maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
Boolean |
isEnableGlobalWriteForwarding()
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an
Aurora global database (GlobalCluster).
|
Boolean |
isEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
Boolean |
isEnablePerformanceInsights()
A value that indicates whether to turn on Performance Insights for the DB cluster.
|
Boolean |
isPubliclyAccessible()
A value that indicates whether the DB cluster is publicly accessible.
|
Boolean |
isStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the
maintenance window.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
|
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
void |
setCharacterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
void |
setDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier.
|
void |
setDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
void |
setDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
void |
setEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an
Aurora global database (GlobalCluster).
|
void |
setEnableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to turn on Performance Insights for the DB cluster.
|
void |
setEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
void |
setEngineVersion(String engineVersion)
The version number of the database engine to use.
|
void |
setGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
void |
setIops(Integer 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.
|
void |
setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
void |
setMasterUsername(String masterUsername)
The name of the master user for the DB cluster.
|
void |
setMasterUserPassword(String masterUserPassword)
The password for the master database user.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs.
|
void |
setOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
void |
setPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setPreSignedUrl(String preSignedUrl)
A URL that contains a Signature Version 4 signed request for the
CreateDBCluster action to be called
in the source Amazon Web Services Region where the DB cluster is replicated from. |
void |
setPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB cluster is publicly accessible.
|
void |
setReplicationSourceIdentifier(String replicationSourceIdentifier)
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read
replica.
|
void |
setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
void |
setSourceRegion(String sourceRegion)
The region where the source instance is located.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
|
void |
setTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
String |
toString()
Returns a string representation of this object.
|
CreateDBClusterRequest |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
CreateDBClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the
maintenance window.
|
CreateDBClusterRequest |
withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
|
CreateDBClusterRequest |
withAvailabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
|
CreateDBClusterRequest |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
CreateDBClusterRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
CreateDBClusterRequest |
withCharacterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
CreateDBClusterRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
CreateDBClusterRequest |
withDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters.
|
CreateDBClusterRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier.
|
CreateDBClusterRequest |
withDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
CreateDBClusterRequest |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
CreateDBClusterRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB cluster.
|
CreateDBClusterRequest |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
CreateDBClusterRequest |
withDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
|
CreateDBClusterRequest |
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
CreateDBClusterRequest |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDBClusterRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDBClusterRequest |
withEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an
Aurora global database (GlobalCluster).
|
CreateDBClusterRequest |
withEnableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
CreateDBClusterRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
CreateDBClusterRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to turn on Performance Insights for the DB cluster.
|
CreateDBClusterRequest |
withEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
CreateDBClusterRequest |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
CreateDBClusterRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
CreateDBClusterRequest |
withGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
CreateDBClusterRequest |
withIops(Integer 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.
|
CreateDBClusterRequest |
withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
CreateDBClusterRequest |
withMasterUsername(String masterUsername)
The name of the master user for the DB cluster.
|
CreateDBClusterRequest |
withMasterUserPassword(String masterUserPassword)
The password for the master database user.
|
CreateDBClusterRequest |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
CreateDBClusterRequest |
withMonitoringRoleArn(String monitoringRoleArn)
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs.
|
CreateDBClusterRequest |
withOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
|
CreateDBClusterRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
CreateDBClusterRequest |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
CreateDBClusterRequest |
withPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
|
CreateDBClusterRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
CreateDBClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CreateDBClusterRequest |
withPreSignedUrl(String preSignedUrl)
A URL that contains a Signature Version 4 signed request for the
CreateDBCluster action to be called
in the source Amazon Web Services Region where the DB cluster is replicated from. |
CreateDBClusterRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB cluster is publicly accessible.
|
CreateDBClusterRequest |
withReplicationSourceIdentifier(String replicationSourceIdentifier)
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read
replica.
|
CreateDBClusterRequest |
withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
CreateDBClusterRequest |
withSourceRegion(String sourceRegion)
The region where the source instance is located.
|
CreateDBClusterRequest |
withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
|
CreateDBClusterRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
|
CreateDBClusterRequest |
withTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
|
CreateDBClusterRequest |
withTags(Tag... tags)
Tags to assign to the DB cluster.
|
CreateDBClusterRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
CreateDBClusterRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public List<String> getAvailabilityZones()
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public void setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
availabilityZones
- A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withAvailabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
availabilityZones
- A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
backupRetentionPeriod
- The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Integer getBackupRetentionPeriod()
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
backupRetentionPeriod
- The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setCharacterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
characterSetName
- A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
public String getCharacterSetName()
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withCharacterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
characterSetName
- A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
public void setDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
databaseName
- The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS
doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getDatabaseName()
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
databaseName
- The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS
doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setDBClusterIdentifier(String 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
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
public String getDBClusterIdentifier()
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
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
public CreateDBClusterRequest withDBClusterIdentifier(String 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
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
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a
value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a
value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBSubnetGroupName
- A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getDBSubnetGroupName()
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBSubnetGroupName
- A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine
- The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getEngine()
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine
- The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEngineVersion(String engineVersion)
The version number of the database engine to use.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
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 MySQL on Amazon RDS Versions 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 MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engineVersion
- The version number of the database engine to use.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
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 MySQL on Amazon RDS Versions 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 MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getEngineVersion()
The version number of the database engine to use.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
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 MySQL on Amazon RDS Versions 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 MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
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 MySQL on Amazon RDS Versions 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 MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withEngineVersion(String engineVersion)
The version number of the database engine to use.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
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 MySQL on Amazon RDS Versions 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 MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engineVersion
- The version number of the database engine to use.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
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 MySQL on Amazon RDS Versions 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 MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port
- The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Integer getPort()
The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port
- The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setMasterUsername(String masterUsername)
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
masterUsername
- The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getMasterUsername()
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withMasterUsername(String masterUsername)
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
masterUsername
- The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setMasterUserPassword(String masterUserPassword)
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
masterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except
"/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getMasterUserPassword()
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withMasterUserPassword(String masterUserPassword)
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
masterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except
"/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
optionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
public String getOptionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
DB clusters are associated with a default option group that can't be modified.
public CreateDBClusterRequest withOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
optionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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
public CreateDBClusterRequest withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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
public void setPreferredMaintenanceWindow(String 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 Amazon Web Services 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
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 Amazon Web Services 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
public String getPreferredMaintenanceWindow()
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 Amazon Web Services 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
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 Amazon Web Services 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
public CreateDBClusterRequest withPreferredMaintenanceWindow(String 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 Amazon Web Services 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
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 Amazon Web Services 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
public void setReplicationSourceIdentifier(String 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
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
public 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.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withReplicationSourceIdentifier(String 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
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
public List<Tag> getTags()
Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
tags
- Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withTags(Tag... tags)
Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
tags
- Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
storageEncrypted
- A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
storageEncrypted
- A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the KMS key
used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't
specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set
KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services Region. This
KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the
KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must
set KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services
Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getKmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the KMS key
used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't
specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set
KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services Region. This
KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the
KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must
set KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services
Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the KMS key
used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't
specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set
KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services Region. This
KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the
KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't specified, then Amazon RDS will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must
set KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services
Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setPreSignedUrl(String preSignedUrl)
A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be called
in the source Amazon Web Services Region where the DB cluster is replicated from. Specify
PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be executed
in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of
the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the
CreateDBCluster
action that is called in the destination Amazon Web Services Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will be
created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For
example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your
ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be
executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
preSignedUrl
- A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be
called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify
PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB
cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be
executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the
copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS
key for both the CreateDBCluster
action that is called in the destination Amazon Web Services
Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will
be created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be
copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web
Services Region, then your ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
public String getPreSignedUrl()
A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be called
in the source Amazon Web Services Region where the DB cluster is replicated from. Specify
PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be executed
in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of
the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the
CreateDBCluster
action that is called in the destination Amazon Web Services Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will be
created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For
example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your
ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be
executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
CreateDBCluster
action to
be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify
PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB
cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be
executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the
copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS
key for both the CreateDBCluster
action that is called in the destination Amazon Web
Services Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will
be created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be
copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web
Services Region, then your ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or --source-region
for the CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withPreSignedUrl(String preSignedUrl)
A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be called
in the source Amazon Web Services Region where the DB cluster is replicated from. Specify
PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be executed
in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of
the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the
CreateDBCluster
action that is called in the destination Amazon Web Services Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will be
created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For
example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your
ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be
executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
preSignedUrl
- A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be
called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify
PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB
cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be
executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the
copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS
key for both the CreateDBCluster
action that is called in the destination Amazon Web Services
Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will
be created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be
copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web
Services Region, then your ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public void setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
public Long getBacktrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
public CreateDBClusterRequest withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
public List<String> getEnableCloudwatchLogsExports()
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
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
public void setEnableCloudwatchLogsExports(Collection<String> 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
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
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
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withEnableCloudwatchLogsExports(String... 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
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
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
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withEnableCloudwatchLogsExports(Collection<String> 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
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
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
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
Valid for: Aurora DB clusters only
public void setEngineMode(String 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
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
public String getEngineMode()
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
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
public CreateDBClusterRequest withEngineMode(String 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
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
public void setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
public ScalingConfiguration getScalingConfiguration()
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
public void setDeletionProtection(Boolean 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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getDeletionProtection()
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public CreateDBClusterRequest withDeletionProtection(Boolean 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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isDeletionProtection()
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for: Aurora DB clusters only
globalClusterIdentifier
- The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database
cluster.
Valid for: Aurora DB clusters only
public String getGlobalClusterIdentifier()
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for: Aurora DB clusters only
globalClusterIdentifier
- The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database
cluster.
Valid for: Aurora DB clusters only
public void setEnableHttpEndpoint(Boolean 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
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
public Boolean getEnableHttpEndpoint()
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
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
public CreateDBClusterRequest withEnableHttpEndpoint(Boolean 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
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
public Boolean isEnableHttpEndpoint()
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
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
public void setCopyTagsToSnapshot(Boolean 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 only
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 only
public Boolean getCopyTagsToSnapshot()
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 only
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withCopyTagsToSnapshot(Boolean 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 only
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 only
public Boolean isCopyTagsToSnapshot()
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 only
Valid for: Aurora DB clusters only
public void setDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
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
domain
- The Active Directory directory ID to create the DB cluster in.
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
public String getDomain()
The Active Directory directory ID to create the DB cluster in.
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
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
public CreateDBClusterRequest withDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
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
domain
- The Active Directory directory ID to create the DB cluster in.
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
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
public void setEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
enableGlobalWriteForwarding
- A value that indicates whether to enable this DB cluster to forward write operations to the primary
cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
public Boolean getEnableGlobalWriteForwarding()
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
public CreateDBClusterRequest withEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
enableGlobalWriteForwarding
- A value that indicates whether to enable this DB cluster to forward write operations to the primary
cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
public Boolean isEnableGlobalWriteForwarding()
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
public void setDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services 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
dBClusterInstanceClass
- The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
Not all DB instance classes are available in all Amazon Web Services 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
public String getDBClusterInstanceClass()
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services 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
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
public CreateDBClusterRequest withDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services 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
dBClusterInstanceClass
- The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
Not all DB instance classes are available in all Amazon Web Services 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
public void setAllocatedStorage(Integer 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
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
public Integer getAllocatedStorage()
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 setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
public CreateDBClusterRequest withAllocatedStorage(Integer 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
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
public void setStorageType(String 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
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
public String getStorageType()
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 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
public CreateDBClusterRequest withStorageType(String 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
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
public void setIops(Integer 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 to improve performance 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
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 to improve performance 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
public Integer getIops()
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 to improve performance 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
For information about valid Iops
values, see Amazon RDS
Provisioned IOPS storage to improve performance 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
public CreateDBClusterRequest withIops(Integer 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 to improve performance 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
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 to improve performance 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
public void setPubliclyAccessible(Boolean 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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
public Boolean getPubliclyAccessible()
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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
public CreateDBClusterRequest withPubliclyAccessible(Boolean 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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
public Boolean isPubliclyAccessible()
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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
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 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, and PubliclyAccessible
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.
Valid for: Multi-AZ DB clusters only
public void setAutoMinorVersionUpgrade(Boolean 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
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
public Boolean getAutoMinorVersionUpgrade()
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
Valid for: Multi-AZ DB clusters only
public CreateDBClusterRequest withAutoMinorVersionUpgrade(Boolean 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
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
public Boolean isAutoMinorVersionUpgrade()
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
Valid for: Multi-AZ DB clusters only
public void setMonitoringInterval(Integer 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
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
public Integer getMonitoringInterval()
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
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
public CreateDBClusterRequest withMonitoringInterval(Integer 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
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
public void setMonitoringRoleArn(String 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
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
public String getMonitoringRoleArn()
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
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
public CreateDBClusterRequest withMonitoringRoleArn(String 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
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
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
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
enablePerformanceInsights
- 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
public Boolean getEnablePerformanceInsights()
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
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
public CreateDBClusterRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
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
enablePerformanceInsights
- 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
public Boolean isEnablePerformanceInsights()
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
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
public String getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web
Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
public CreateDBClusterRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Valid for: Multi-AZ DB clusters only
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Valid for: Multi-AZ DB clusters only
public Integer getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Valid for: Multi-AZ DB clusters only
Valid for: Multi-AZ DB clusters only
public CreateDBClusterRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Valid for: Multi-AZ DB clusters only
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Valid for: Multi-AZ DB clusters only
public void setSourceRegion(String sourceRegion)
sourceRegion
- The region where the source instance is located.public String getSourceRegion()
public CreateDBClusterRequest withSourceRegion(String sourceRegion)
sourceRegion
- The region where the source instance is located.public String toString()
toString
in class Object
Object.toString()
public CreateDBClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()