@Generated(value="software.amazon.awssdk:codegen") public final class RestoreDbClusterFromS3Request extends RdsRequest implements ToCopyableBuilder<RestoreDbClusterFromS3Request.Builder,RestoreDbClusterFromS3Request>
Modifier and Type | Class and Description |
---|---|
static interface |
RestoreDbClusterFromS3Request.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
availabilityZones()
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
Integer |
backupRetentionPeriod()
The number of days for which automated backups of the restored DB cluster are retained.
|
static RestoreDbClusterFromS3Request.Builder |
builder() |
String |
characterSetName()
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
|
String |
databaseName()
The database name for the restored DB cluster.
|
String |
dbClusterIdentifier()
The name of the DB cluster to create from the source data in the Amazon S3 bucket.
|
String |
dbClusterParameterGroupName()
The name of the DB cluster parameter group to associate with the restored DB cluster.
|
String |
dbSubnetGroupName()
A DB subnet group to associate with the restored DB cluster.
|
Boolean |
enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
String |
engine()
The name of the database engine to be used for the restored DB cluster.
|
String |
engineVersion()
The version number of the database engine to use.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
kmsKeyId()
The AWS KMS key identifier for an encrypted DB cluster.
|
String |
masterUsername()
The name of the master user for the restored DB cluster.
|
String |
masterUserPassword()
The password for the master database user.
|
String |
optionGroupName()
A value that indicates that the restored DB cluster should be associated with the specified option group.
|
Integer |
port()
The port number on which the instances in the restored DB cluster accept connections.
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
String |
preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
s3BucketName()
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
|
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.
|
String |
s3Prefix()
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
|
static Class<? extends RestoreDbClusterFromS3Request.Builder> |
serializableBuilderClass() |
String |
sourceEngine()
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
|
String |
sourceEngineVersion()
The version of the database that the backup files were created from.
|
Boolean |
storageEncrypted()
Specifies whether the restored DB cluster is encrypted.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
RestoreDbClusterFromS3Request.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
overrideConfiguration
copy
public List<String> availabilityZones()
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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
Default: 1
Constraints:
Must be a value from 1 to 35
public String characterSetName()
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
public String databaseName()
The database name for the restored DB cluster.
public String dbClusterIdentifier()
The name of the DB cluster to create from the source data in the Amazon 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 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.
default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
public List<String> vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the restored DB cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public String engine()
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
, aurora-postgresql
Valid Values: aurora
, aurora-postgresql
public String engineVersion()
The version number of the database engine to use.
Aurora
Example: 5.6.10a
Aurora
Example: 5.6.10a
public Integer port()
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
Default: 3306
public 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.
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 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.
Constraints: Must contain from 8 to 41 characters.
public 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.
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 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 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
.
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 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
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public 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 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
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean storageEncrypted()
Specifies whether the restored DB cluster is encrypted.
public String kmsKeyId()
The AWS 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 Boolean enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public 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
Valid values: mysql
public 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
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
public String s3BucketName()
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
public 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.
public 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.
public RestoreDbClusterFromS3Request.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RestoreDbClusterFromS3Request.Builder,RestoreDbClusterFromS3Request>
toBuilder
in class RdsRequest
public static RestoreDbClusterFromS3Request.Builder builder()
public static Class<? extends RestoreDbClusterFromS3Request.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.