@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreDBClusterFromS3Request extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBClusterFromS3Request() |
Modifier and Type | Method and Description |
---|---|
RestoreDBClusterFromS3Request |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAvailabilityZones()
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups of the restored DB cluster are retained.
|
String |
getCharacterSetName()
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates 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 source data in the Amazon S3 bucket.
|
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with the restored DB cluster.
|
String |
getDBSubnetGroupName()
A DB subnet group to associate with the restored DB cluster.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
String |
getDomain()
Specify the Active Directory directory ID to restore the DB cluster in.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
String |
getEngineVersion()
The version number of the database engine to use.
|
String |
getKmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
String |
getMasterUsername()
The name of the master user for the restored DB cluster.
|
String |
getMasterUserPassword()
The password for the master database user.
|
String |
getOptionGroupName()
A value that indicates that the restored DB cluster should be associated with the specified option group.
|
Integer |
getPort()
The port number on which the instances in the restored DB cluster accept connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
getS3BucketName()
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
|
String |
getS3IngestionRoleArn()
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
|
String |
getS3Prefix()
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
|
ServerlessV2ScalingConfiguration |
getServerlessV2ScalingConfiguration() |
String |
getSourceEngine()
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
|
String |
getSourceEngineVersion()
The version of the database that the backup files were created from.
|
Boolean |
getStorageEncrypted()
A value that indicates whether the restored DB cluster is encrypted.
|
List<Tag> |
getTags() |
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
int |
hashCode() |
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
Boolean |
isStorageEncrypted()
A value that indicates whether the restored DB cluster is encrypted.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
A 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 |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups of the restored DB cluster are retained.
|
void |
setCharacterSetName(String characterSetName)
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates 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 source data in the Amazon S3 bucket.
|
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with the restored DB cluster.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with the restored DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
void |
setDomain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
void |
setEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineVersion(String engineVersion)
The version number of the database engine to use.
|
void |
setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
void |
setMasterUsername(String masterUsername)
The name of the master user for the restored DB cluster.
|
void |
setMasterUserPassword(String masterUserPassword)
The password for the master database user.
|
void |
setOptionGroupName(String optionGroupName)
A value that indicates that the restored DB cluster should be associated with the specified option group.
|
void |
setPort(Integer port)
The port number on which the instances in the restored DB cluster accept connections.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setS3BucketName(String s3BucketName)
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
|
void |
setS3IngestionRoleArn(String s3IngestionRoleArn)
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
|
void |
setS3Prefix(String s3Prefix)
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
|
void |
setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) |
void |
setSourceEngine(String sourceEngine)
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
|
void |
setSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the restored DB cluster is encrypted.
|
void |
setTags(Collection<Tag> tags) |
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
String |
toString()
Returns a string representation of this object.
|
RestoreDBClusterFromS3Request |
withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDBClusterFromS3Request |
withAvailabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDBClusterFromS3Request |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
RestoreDBClusterFromS3Request |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups of the restored DB cluster are retained.
|
RestoreDBClusterFromS3Request |
withCharacterSetName(String characterSetName)
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
|
RestoreDBClusterFromS3Request |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
RestoreDBClusterFromS3Request |
withDatabaseName(String databaseName)
The database name for the restored DB cluster.
|
RestoreDBClusterFromS3Request |
withDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the source data in the Amazon S3 bucket.
|
RestoreDBClusterFromS3Request |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with the restored DB cluster.
|
RestoreDBClusterFromS3Request |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with the restored DB cluster.
|
RestoreDBClusterFromS3Request |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
RestoreDBClusterFromS3Request |
withDomain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in.
|
RestoreDBClusterFromS3Request |
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
RestoreDBClusterFromS3Request |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
RestoreDBClusterFromS3Request |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
RestoreDBClusterFromS3Request |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
RestoreDBClusterFromS3Request |
withEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
RestoreDBClusterFromS3Request |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
RestoreDBClusterFromS3Request |
withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
RestoreDBClusterFromS3Request |
withMasterUsername(String masterUsername)
The name of the master user for the restored DB cluster.
|
RestoreDBClusterFromS3Request |
withMasterUserPassword(String masterUserPassword)
The password for the master database user.
|
RestoreDBClusterFromS3Request |
withOptionGroupName(String optionGroupName)
A value that indicates that the restored DB cluster should be associated with the specified option group.
|
RestoreDBClusterFromS3Request |
withPort(Integer port)
The port number on which the instances in the restored DB cluster accept connections.
|
RestoreDBClusterFromS3Request |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
RestoreDBClusterFromS3Request |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
RestoreDBClusterFromS3Request |
withS3BucketName(String s3BucketName)
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
|
RestoreDBClusterFromS3Request |
withS3IngestionRoleArn(String s3IngestionRoleArn)
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
|
RestoreDBClusterFromS3Request |
withS3Prefix(String s3Prefix)
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
|
RestoreDBClusterFromS3Request |
withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) |
RestoreDBClusterFromS3Request |
withSourceEngine(String sourceEngine)
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
|
RestoreDBClusterFromS3Request |
withSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
|
RestoreDBClusterFromS3Request |
withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the restored DB cluster is encrypted.
|
RestoreDBClusterFromS3Request |
withTags(Collection<Tag> tags) |
RestoreDBClusterFromS3Request |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
RestoreDBClusterFromS3Request |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
RestoreDBClusterFromS3Request |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public List<String> getAvailabilityZones()
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
public void setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
availabilityZones
- A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.public RestoreDBClusterFromS3Request withAvailabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.public RestoreDBClusterFromS3Request withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
availabilityZones
- A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
backupRetentionPeriod
- The number of days for which automated backups of the restored DB cluster are retained. You must specify a
minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
public Integer getBackupRetentionPeriod()
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
Default: 1
Constraints:
Must be a value from 1 to 35
public RestoreDBClusterFromS3Request withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
backupRetentionPeriod
- The number of days for which automated backups of the restored DB cluster are retained. You must specify a
minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
public void setCharacterSetName(String characterSetName)
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
characterSetName
- A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.public String getCharacterSetName()
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
public RestoreDBClusterFromS3Request withCharacterSetName(String characterSetName)
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
characterSetName
- A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.public void setDatabaseName(String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.public String getDatabaseName()
The database name for the restored DB cluster.
public RestoreDBClusterFromS3Request withDatabaseName(String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.public void setDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1
dBClusterIdentifier
- The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1
public String getDBClusterIdentifier()
The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
public RestoreDBClusterFromS3Request withDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1
dBClusterIdentifier
- The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
omitted, default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
omitted, default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
public String getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
omitted, default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
public RestoreDBClusterFromS3Request withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
omitted, default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
omitted, default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the restored DB cluster.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the restored DB cluster.public RestoreDBClusterFromS3Request withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the restored DB cluster.public RestoreDBClusterFromS3Request withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the restored DB cluster.public void setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dBSubnetGroupName
- A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public String getDBSubnetGroupName()
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public RestoreDBClusterFromS3Request withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dBSubnetGroupName
- A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public void setEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql
public String getEngine()
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql
public RestoreDBClusterFromS3Request withEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql
public void setEngineVersion(String engineVersion)
The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible and MySQL
8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
, 8.0.mysql_aurora.3.01.0
Aurora PostgreSQL
Example: 9.6.3
, 10.7
engineVersion
- The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible and
MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
, 8.0.mysql_aurora.3.01.0
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public String getEngineVersion()
The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible and MySQL
8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
, 8.0.mysql_aurora.3.01.0
Aurora PostgreSQL
Example: 9.6.3
, 10.7
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible and
MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
, 8.0.mysql_aurora.3.01.0
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public RestoreDBClusterFromS3Request withEngineVersion(String engineVersion)
The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible and MySQL
8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
, 8.0.mysql_aurora.3.01.0
Aurora PostgreSQL
Example: 9.6.3
, 10.7
engineVersion
- The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible and
MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
, 8.0.mysql_aurora.3.01.0
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public void setPort(Integer port)
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
port
- The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
public Integer getPort()
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
Default: 3306
public RestoreDBClusterFromS3Request withPort(Integer port)
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
port
- The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
public void setMasterUsername(String masterUsername)
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUsername
- The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public String getMasterUsername()
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public RestoreDBClusterFromS3Request withMasterUsername(String masterUsername)
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUsername
- The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public void setMasterUserPassword(String masterUserPassword)
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
masterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except
"/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
public String getMasterUserPassword()
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Constraints: Must contain from 8 to 41 characters.
public RestoreDBClusterFromS3Request withMasterUserPassword(String masterUserPassword)
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
masterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except
"/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
public void setOptionGroupName(String optionGroupName)
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
optionGroupName
- A value that indicates that the restored DB cluster should be associated with the specified option
group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
public String getOptionGroupName()
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
public RestoreDBClusterFromS3Request withOptionGroupName(String optionGroupName)
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
optionGroupName
- A value that indicates that the restored DB cluster should be associated with the specified option
group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public RestoreDBClusterFromS3Request withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public String getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public RestoreDBClusterFromS3Request withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public void setTags(Collection<Tag> tags)
tags
- public RestoreDBClusterFromS3Request withTags(Tag... tags)
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
- public RestoreDBClusterFromS3Request withTags(Collection<Tag> tags)
tags
- public void setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the restored DB cluster is encrypted.
storageEncrypted
- A value that indicates whether the restored DB cluster is encrypted.public Boolean getStorageEncrypted()
A value that indicates whether the restored DB cluster is encrypted.
public RestoreDBClusterFromS3Request withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the restored DB cluster is encrypted.
storageEncrypted
- A value that indicates whether the restored DB cluster is encrypted.public Boolean isStorageEncrypted()
A value that indicates whether the restored DB cluster is encrypted.
public void setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web
Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web
Services Region.
public String getKmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS
key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS
key for each Amazon Web Services Region.
public RestoreDBClusterFromS3Request withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web
Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web
Services Region.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public RestoreDBClusterFromS3Request withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public void setSourceEngine(String sourceEngine)
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
sourceEngine
- The identifier for the database engine that was backed up to create the files stored in the Amazon S3
bucket.
Valid values: mysql
public String getSourceEngine()
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
Valid values: mysql
public RestoreDBClusterFromS3Request withSourceEngine(String sourceEngine)
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
sourceEngine
- The identifier for the database engine that was backed up to create the files stored in the Amazon S3
bucket.
Valid values: mysql
public void setSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
public String getSourceEngineVersion()
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
public RestoreDBClusterFromS3Request withSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
public void setS3BucketName(String s3BucketName)
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
s3BucketName
- The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.public String getS3BucketName()
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
public RestoreDBClusterFromS3Request withS3BucketName(String s3BucketName)
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
s3BucketName
- The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.public void setS3Prefix(String s3Prefix)
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
s3Prefix
- The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If
you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using
all of the files in the Amazon S3 bucket.public String getS3Prefix()
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
public RestoreDBClusterFromS3Request withS3Prefix(String s3Prefix)
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
s3Prefix
- The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If
you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using
all of the files in the Amazon S3 bucket.public void setS3IngestionRoleArn(String s3IngestionRoleArn)
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
s3IngestionRoleArn
- The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.public String getS3IngestionRoleArn()
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
public RestoreDBClusterFromS3Request withS3IngestionRoleArn(String s3IngestionRoleArn)
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
s3IngestionRoleArn
- The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.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).
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).
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).
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).
public RestoreDBClusterFromS3Request 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).
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).
public List<String> getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public RestoreDBClusterFromS3Request withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
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 CloudWatch Logs. The values in the list
depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public RestoreDBClusterFromS3Request withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used.
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 Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection isn't enabled.public Boolean getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
public RestoreDBClusterFromS3Request withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection isn't enabled.public Boolean isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
DB cluster. The default is not to copy them.public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
public RestoreDBClusterFromS3Request withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
DB cluster. The default is not to copy them.public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
public void setDomain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
domain
- Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior
to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public String getDomain()
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public RestoreDBClusterFromS3Request withDomain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
domain
- Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior
to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public RestoreDBClusterFromS3Request withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public void setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public ServerlessV2ScalingConfiguration getServerlessV2ScalingConfiguration()
public RestoreDBClusterFromS3Request withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public String toString()
toString
in class Object
Object.toString()
public RestoreDBClusterFromS3Request clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()