@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 EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
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.
|
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 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 |
getEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
String |
getEngine()
The name of the database engine to be used for the restored DB cluster.
|
String |
getEngineVersion()
The version number of the database engine to use.
|
String |
getKmsKeyId()
The 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 AWS 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.
|
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()
Specifies 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 |
isEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
Boolean |
isStorageEncrypted()
Specifies whether the restored DB cluster is encrypted.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
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 |
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 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 |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
void |
setEngine(String engine)
The name of the database engine to be used for the restored DB cluster.
|
void |
setEngineVersion(String engineVersion)
The version number of the database engine to use.
|
void |
setKmsKeyId(String kmsKeyId)
The 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 AWS 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 |
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)
Specifies 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; useful for testing and debugging.
|
RestoreDBClusterFromS3Request |
withAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
RestoreDBClusterFromS3Request |
withAvailabilityZones(String... availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
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 |
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 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 |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
RestoreDBClusterFromS3Request |
withEngine(String engine)
The name of the database engine to be used for the restored DB cluster.
|
RestoreDBClusterFromS3Request |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
RestoreDBClusterFromS3Request |
withKmsKeyId(String kmsKeyId)
The 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 AWS 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 |
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)
Specifies 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 EC2 Availability Zones that instances in the restored DB cluster can be created in.
public void setAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
availabilityZones
- A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.public RestoreDBClusterFromS3Request withAvailabilityZones(String... availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
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 EC2 Availability Zones that instances in the restored DB cluster can be created in.public RestoreDBClusterFromS3Request withAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
availabilityZones
- A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.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 S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot 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 S3 bucket. This parameter is isn't
case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot 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 S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot 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.
Cannot 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 S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot 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 S3 bucket. This parameter is isn't
case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot 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: mySubnetgroup
dBSubnetGroupName
- A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
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: mySubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
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: mySubnetgroup
dBSubnetGroupName
- A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public void setEngine(String engine)
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
engine
- The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
public String getEngine()
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
Valid Values: aurora
public RestoreDBClusterFromS3Request withEngine(String engine)
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
engine
- The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
public void setEngineVersion(String engineVersion)
The version number of the database engine to use.
Aurora
Example: 5.6.10a
engineVersion
- The version number of the database engine to use.
Aurora
Example: 5.6.10a
public String getEngineVersion()
The version number of the database engine to use.
Aurora
Example: 5.6.10a
Aurora
Example: 5.6.10a
public RestoreDBClusterFromS3Request withEngineVersion(String engineVersion)
The version number of the database engine to use.
Aurora
Example: 5.6.10a
engineVersion
- The version number of the database engine to use.
Aurora
Example: 5.6.10a
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.
Cannot 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.
Cannot 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.
Cannot be a reserved word for the chosen database engine.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot 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.
Cannot 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.
Cannot 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 cannot be removed from an option group. An option group cannot 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 cannot be removed from an option group. An option group cannot 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 cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.
Permanent options cannot be removed from an option group. An option group cannot 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 cannot be removed from an option group. An option group cannot 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 cannot be removed from an option group. An option group cannot 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.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
BackupRetentionPeriod
parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should 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
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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)
Specifies whether the restored DB cluster is encrypted.
storageEncrypted
- Specifies whether the restored DB cluster is encrypted.public Boolean getStorageEncrypted()
Specifies whether the restored DB cluster is encrypted.
public RestoreDBClusterFromS3Request withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the restored DB cluster is encrypted.
storageEncrypted
- Specifies whether the restored DB cluster is encrypted.public Boolean isStorageEncrypted()
Specifies whether the restored DB cluster is encrypted.
public void setKmsKeyId(String kmsKeyId)
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
kmsKeyId
- The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for
each AWS Region.
public String getKmsKeyId()
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has a different default encryption key
for each AWS Region.
public RestoreDBClusterFromS3Request withKmsKeyId(String kmsKeyId)
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
kmsKeyId
- The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for
each AWS Region.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts, and otherwise false.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public RestoreDBClusterFromS3Request withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts, and otherwise false.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
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 version 5.5 and 5.6 are supported.
Example: 5.6.22
sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
public String getSourceEngineVersion()
The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
public RestoreDBClusterFromS3Request withSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Identity and Access Management (IAM) role that authorizes Amazon
RDS to access the Amazon S3 bucket on your behalf.public String toString()
toString
in class Object
Object.toString()
public RestoreDBClusterFromS3Request clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.