public static interface RestoreDbClusterFromS3Request.Builder extends RdsRequest.Builder, CopyableBuilder<RestoreDbClusterFromS3Request.Builder,RestoreDbClusterFromS3Request>
Modifier and Type | Method and Description |
---|---|
RestoreDbClusterFromS3Request.Builder |
availabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
RestoreDbClusterFromS3Request.Builder |
availabilityZones(String... availabilityZones)
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
RestoreDbClusterFromS3Request.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups of the restored DB cluster are retained.
|
RestoreDbClusterFromS3Request.Builder |
characterSetName(String characterSetName)
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
|
RestoreDbClusterFromS3Request.Builder |
databaseName(String databaseName)
The database name for the restored DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
The name of the DB cluster to create from the source data in the Amazon S3 bucket.
|
RestoreDbClusterFromS3Request.Builder |
dbClusterParameterGroupName(String dbClusterParameterGroupName)
The name of the DB cluster parameter group to associate with the restored DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
dbSubnetGroupName(String dbSubnetGroupName)
A DB subnet group to associate with the restored DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
RestoreDbClusterFromS3Request.Builder |
engine(String engine)
The name of the database engine to be used for the restored DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
engineVersion(String engineVersion)
The version number of the database engine to use.
|
RestoreDbClusterFromS3Request.Builder |
kmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
masterUsername(String masterUsername)
The name of the master user for the restored DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
masterUserPassword(String masterUserPassword)
The password for the master database user.
|
RestoreDbClusterFromS3Request.Builder |
optionGroupName(String optionGroupName)
A value that indicates that the restored DB cluster should be associated with the specified option group.
|
RestoreDbClusterFromS3Request.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
RestoreDbClusterFromS3Request.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
RestoreDbClusterFromS3Request.Builder |
port(Integer port)
The port number on which the instances in the restored DB cluster accept connections.
|
RestoreDbClusterFromS3Request.Builder |
preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
RestoreDbClusterFromS3Request.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
RestoreDbClusterFromS3Request.Builder |
s3BucketName(String s3BucketName)
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
s3IngestionRoleArn(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.Builder |
s3Prefix(String s3Prefix)
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
sourceEngine(String sourceEngine)
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
|
RestoreDbClusterFromS3Request.Builder |
sourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
|
RestoreDbClusterFromS3Request.Builder |
storageEncrypted(Boolean storageEncrypted)
Specifies whether the restored DB cluster is encrypted.
|
RestoreDbClusterFromS3Request.Builder |
tags(Collection<Tag> tags)
Sets the value of the Tags property for this object.
|
RestoreDbClusterFromS3Request.Builder |
tags(Consumer<Tag.Builder>... tags)
Sets the value of the Tags property for this object.
|
RestoreDbClusterFromS3Request.Builder |
tags(Tag... tags)
Sets the value of the Tags property for this object.
|
RestoreDbClusterFromS3Request.Builder |
vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
RestoreDbClusterFromS3Request.Builder |
vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
build
overrideConfiguration
copy
applyMutation, build
RestoreDbClusterFromS3Request.Builder availabilityZones(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.RestoreDbClusterFromS3Request.Builder availabilityZones(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.RestoreDbClusterFromS3Request.Builder backupRetentionPeriod(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
RestoreDbClusterFromS3Request.Builder characterSetName(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.RestoreDbClusterFromS3Request.Builder databaseName(String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.RestoreDbClusterFromS3Request.Builder dbClusterIdentifier(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
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
RestoreDbClusterFromS3Request.Builder dbClusterParameterGroupName(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.
RestoreDbClusterFromS3Request.Builder vpcSecurityGroupIds(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.RestoreDbClusterFromS3Request.Builder vpcSecurityGroupIds(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.RestoreDbClusterFromS3Request.Builder dbSubnetGroupName(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
RestoreDbClusterFromS3Request.Builder engine(String engine)
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
, aurora-postgresql
engine
- The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
, aurora-postgresql
RestoreDbClusterFromS3Request.Builder engineVersion(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
RestoreDbClusterFromS3Request.Builder port(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
RestoreDbClusterFromS3Request.Builder masterUsername(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.
RestoreDbClusterFromS3Request.Builder masterUserPassword(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.
RestoreDbClusterFromS3Request.Builder optionGroupName(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.
RestoreDbClusterFromS3Request.Builder preferredBackupWindow(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.
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.
RestoreDbClusterFromS3Request.Builder preferredMaintenanceWindow(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.
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.
RestoreDbClusterFromS3Request.Builder tags(Collection<Tag> tags)
tags
- The new value for the Tags property for this object.RestoreDbClusterFromS3Request.Builder tags(Tag... tags)
tags
- The new value for the Tags property for this object.RestoreDbClusterFromS3Request.Builder tags(Consumer<Tag.Builder>... tags)
List.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
RestoreDbClusterFromS3Request.Builder storageEncrypted(Boolean storageEncrypted)
Specifies whether the restored DB cluster is encrypted.
storageEncrypted
- Specifies whether the restored DB cluster is encrypted.RestoreDbClusterFromS3Request.Builder kmsKeyId(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.
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.
RestoreDbClusterFromS3Request.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
RestoreDbClusterFromS3Request.Builder sourceEngine(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
RestoreDbClusterFromS3Request.Builder sourceEngineVersion(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
RestoreDbClusterFromS3Request.Builder s3BucketName(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.RestoreDbClusterFromS3Request.Builder s3Prefix(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.RestoreDbClusterFromS3Request.Builder s3IngestionRoleArn(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.RestoreDbClusterFromS3Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.RestoreDbClusterFromS3Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.