@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBClusterFromSnapshotRequest() |
Modifier and Type | Method and Description |
---|---|
RestoreDBClusterFromSnapshotRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAvailabilityZones()
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Boolean |
getCopyTagsToSnapshot()
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
|
String |
getDatabaseName()
The database name for the restored DB cluster.
|
String |
getDBClusterIdentifier()
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
|
String |
getDBClusterInstanceClass()
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.
|
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDBSubnetGroupName()
The name of the DB subnet group to use for the new DB cluster.
|
Boolean |
getDeletionProtection()
Specifies whether to enable deletion protection for the DB cluster.
|
String |
getDomain()
The Active Directory directory ID to restore the DB cluster in.
|
String |
getDomainIAMRoleName()
The name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
String |
getEngine()
The database engine to use for the new DB cluster.
|
String |
getEngineLifecycleSupport()
The life cycle type for this DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either
provisioned or serverless . |
String |
getEngineVersion()
The version of the database engine to use for the new DB 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 to use when restoring an encrypted DB cluster from a DB snapshot or DB
cluster snapshot.
|
String |
getNetworkType()
The network type of the DB cluster.
|
String |
getOptionGroupName()
The name of the option group to use for the restored DB cluster.
|
Integer |
getPort()
The port number on which the new DB cluster accepts connections.
|
Boolean |
getPubliclyAccessible()
Specifies whether the DB cluster is publicly accessible.
|
RdsCustomClusterConfiguration |
getRdsCustomClusterConfiguration()
Reserved for future use.
|
ScalingConfiguration |
getScalingConfiguration()
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
ServerlessV2ScalingConfiguration |
getServerlessV2ScalingConfiguration() |
String |
getSnapshotIdentifier()
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB cluster.
|
List<Tag> |
getTags()
The tags to be assigned to the restored DB cluster.
|
List<String> |
getVpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster will belong to.
|
int |
hashCode() |
Boolean |
isCopyTagsToSnapshot()
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
|
Boolean |
isDeletionProtection()
Specifies whether to enable deletion protection for the DB cluster.
|
Boolean |
isEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
isPubliclyAccessible()
Specifies whether the DB cluster is publicly accessible.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
|
void |
setDatabaseName(String databaseName)
The database name for the restored DB cluster.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
|
void |
setDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.
|
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB cluster.
|
void |
setDomain(String domain)
The Active Directory directory ID to restore the DB cluster in.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
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 logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
void |
setEngine(String engine)
The database engine to use for the new DB cluster.
|
void |
setEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB cluster.
|
void |
setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless . |
void |
setEngineVersion(String engineVersion)
The version of the database engine to use for the new DB 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 to use when restoring an encrypted DB cluster from a DB snapshot or DB
cluster snapshot.
|
void |
setNetworkType(String networkType)
The network type of the DB cluster.
|
void |
setOptionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
void |
setPort(Integer port)
The port number on which the new DB cluster accepts connections.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB cluster is publicly accessible.
|
void |
setRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
|
void |
setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
void |
setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) |
void |
setSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
|
void |
setTags(Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
String |
toString()
Returns a string representation of this object.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDBClusterFromSnapshotRequest |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
RestoreDBClusterFromSnapshotRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDatabaseName(String databaseName)
The database name for the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
|
RestoreDBClusterFromSnapshotRequest |
withDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.
|
RestoreDBClusterFromSnapshotRequest |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDomain(String domain)
The Active Directory directory ID to restore the DB cluster in.
|
RestoreDBClusterFromSnapshotRequest |
withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to be used when making API calls to the Directory Service.
|
RestoreDBClusterFromSnapshotRequest |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
RestoreDBClusterFromSnapshotRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
RestoreDBClusterFromSnapshotRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
RestoreDBClusterFromSnapshotRequest |
withEngine(String engine)
The database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless . |
RestoreDBClusterFromSnapshotRequest |
withEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
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.
|
RestoreDBClusterFromSnapshotRequest |
withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB
cluster snapshot.
|
RestoreDBClusterFromSnapshotRequest |
withNetworkType(String networkType)
The network type of the DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withOptionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withPort(Integer port)
The port number on which the new DB cluster accepts connections.
|
RestoreDBClusterFromSnapshotRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB cluster is publicly accessible.
|
RestoreDBClusterFromSnapshotRequest |
withRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
|
RestoreDBClusterFromSnapshotRequest |
withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
RestoreDBClusterFromSnapshotRequest |
withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) |
RestoreDBClusterFromSnapshotRequest |
withSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
RestoreDBClusterFromSnapshotRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withTags(Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withTags(Tag... tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
RestoreDBClusterFromSnapshotRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
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()
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be
created.
Valid for: Aurora DB clusters only
public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
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
- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be
created.
Valid for: Aurora DB clusters only
public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be
created.
Valid for: Aurora DB clusters only
public void setDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBClusterIdentifier
- The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't
case-sensitive.
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getDBClusterIdentifier()
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
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-snapshot-id
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBClusterIdentifier
- The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't
case-sensitive.
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
snapshotIdentifier
- The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getSnapshotIdentifier()
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
snapshotIdentifier
- The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEngine(String engine)
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine
- The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getEngine()
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withEngine(String engine)
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine
- The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, 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
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
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 of the database engine to use for the new DB cluster. If you don't specify an engine version,
the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, 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
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
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 of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, 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
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
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 Aurora MySQL, 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
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
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 RestoreDBClusterFromSnapshotRequest withEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, 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
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
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 of the database engine to use for the new DB cluster. If you don't specify an engine version,
the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, 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
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
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 new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port
- The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Integer getPort()
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withPort(Integer port)
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
port
- The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getDBSubnetGroupName()
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dBSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setDatabaseName(String databaseName)
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
databaseName
- The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getDatabaseName()
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withDatabaseName(String databaseName)
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
databaseName
- The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setOptionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
optionGroupName
- The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
public String getOptionGroupName()
The name of the option group to use for the restored DB cluster.
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 RestoreDBClusterFromSnapshotRequest withOptionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
optionGroupName
- The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
public List<String> getVpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster will belong to.
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 VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
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 VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public List<Tag> getTags()
The tags to be assigned to the restored 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)
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
tags
- The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withTags(Tag... tags)
The tags to be assigned to the restored 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
- The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withTags(Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
tags
- The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
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 you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the restored
DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
kmsKeyId
- The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB
snapshot or DB cluster snapshot.
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 you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster
snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the
restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getKmsKeyId()
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
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 you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the restored
DB cluster isn't encrypted.
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 you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster
snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the
restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
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 you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the restored
DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
kmsKeyId
- The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB
snapshot or DB cluster snapshot.
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 you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster
snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the
restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies 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
- Specifies 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()
Specifies 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 RestoreDBClusterFromSnapshotRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies 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
- Specifies 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()
Specifies 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.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
public Long getBacktrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
public RestoreDBClusterFromSnapshotRequest withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
public List<String> getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
engineMode
- The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
public String getEngineMode()
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
provisioned
or serverless
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
public RestoreDBClusterFromSnapshotRequest withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
engineMode
- The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
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 RestoreDBClusterFromSnapshotRequest 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 setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
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 this argument is omitted,
the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
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 this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
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 this argument is omitted,
the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB cluster. 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
- Specifies whether to enable deletion protection for the DB cluster. 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()
Specifies whether to enable deletion protection for the DB cluster. 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 RestoreDBClusterFromSnapshotRequest withDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB cluster. 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
- Specifies whether to enable deletion protection for the DB cluster. 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()
Specifies whether to enable deletion protection for the DB cluster. 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 setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
copyTagsToSnapshot
- Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getCopyTagsToSnapshot()
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
copyTagsToSnapshot
- Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isCopyTagsToSnapshot()
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setDomain(String domain)
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
domain
- The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created
in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
public String getDomain()
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
public RestoreDBClusterFromSnapshotRequest withDomain(String domain)
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
domain
- The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created
in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
public void setDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
domainIAMRoleName
- 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()
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 RestoreDBClusterFromSnapshotRequest withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
domainIAMRoleName
- 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 setDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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.
Valid for: Multi-AZ DB clusters only
dBClusterInstanceClass
- The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.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.
Valid for: Multi-AZ DB clusters only
public String getDBClusterInstanceClass()
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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.
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.
Valid for: Multi-AZ DB clusters only
public RestoreDBClusterFromSnapshotRequest withDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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.
Valid for: Multi-AZ DB clusters only
dBClusterInstanceClass
- The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.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.
Valid for: Multi-AZ DB clusters only
public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid Values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB
clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
storageType
- Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid Values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public String getStorageType()
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid Values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB
clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid Values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withStorageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid Values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB
clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
storageType
- Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid Values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest 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 in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies 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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
publiclyAccessible
- Specifies 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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getPubliclyAccessible()
Specifies 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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
public RestoreDBClusterFromSnapshotRequest withPubliclyAccessible(Boolean publiclyAccessible)
Specifies 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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
publiclyAccessible
- Specifies 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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isPubliclyAccessible()
Specifies 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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
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 is not 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: Aurora DB clusters and Multi-AZ DB clusters
public void setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public ServerlessV2ScalingConfiguration getServerlessV2ScalingConfiguration()
public RestoreDBClusterFromSnapshotRequest withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public void setNetworkType(String networkType)
The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
networkType
- The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public String getNetworkType()
The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public RestoreDBClusterFromSnapshotRequest withNetworkType(String networkType)
The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
networkType
- The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public void setRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
rdsCustomClusterConfiguration
- Reserved for future use.public RdsCustomClusterConfiguration getRdsCustomClusterConfiguration()
Reserved for future use.
public RestoreDBClusterFromSnapshotRequest withRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
rdsCustomClusterConfiguration
- Reserved for future use.public void setEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB cluster
into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by
setting the value to open-source-rds-extended-support-disabled
. In this case, RDS automatically
upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of
standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
engineLifecycleSupport
- The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB
cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled
. In this
case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine
version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
public String getEngineLifecycleSupport()
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB cluster
into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by
setting the value to open-source-rds-extended-support-disabled
. In this case, RDS automatically
upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of
standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB
cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled
. In this
case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine
version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
public RestoreDBClusterFromSnapshotRequest withEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB cluster
into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by
setting the value to open-source-rds-extended-support-disabled
. In this case, RDS automatically
upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of
standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
engineLifecycleSupport
- The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB
cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled
. In this
case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine
version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
public String toString()
toString
in class Object
Object.toString()
public RestoreDBClusterFromSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()