public static interface RestoreDbClusterFromS3Request.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbClusterFromS3Request.Builder,RestoreDbClusterFromS3Request>
| Modifier and Type | Method and Description |
|---|---|
RestoreDbClusterFromS3Request.Builder |
availabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDbClusterFromS3Request.Builder |
availabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDbClusterFromS3Request.Builder |
backtrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
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 |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
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 |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
RestoreDbClusterFromS3Request.Builder |
domain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in.
|
RestoreDbClusterFromS3Request.Builder |
domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
RestoreDbClusterFromS3Request.Builder |
enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
RestoreDbClusterFromS3Request.Builder |
enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
RestoreDbClusterFromS3Request.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts.
|
RestoreDbClusterFromS3Request.Builder |
engine(String engine)
The name of the database engine to be used for this 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) |
RestoreDbClusterFromS3Request.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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)
A value that indicates 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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRestoreDbClusterFromS3Request.Builder availabilityZones(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.RestoreDbClusterFromS3Request.Builder availabilityZones(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.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 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
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 this DB cluster.
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
5.7-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 Aurora), and aurora-postgresql
RestoreDbClusterFromS3Request.Builder engineVersion(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 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
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
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
Aurora PostgreSQL
Example: 9.6.3, 10.7
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.
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.
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 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 AWS 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.
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 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 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 Aurora 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)
A value that indicates whether the restored DB cluster is encrypted.
storageEncrypted - A value that indicates whether the restored DB cluster is encrypted.RestoreDbClusterFromS3Request.Builder kmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB cluster.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 CMK. There is a default CMK for your AWS account. Your AWS
account has a different default CMK for each AWS Region.
kmsKeyId - The AWS KMS key identifier for an encrypted DB cluster.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 CMK. There is a default CMK for
your AWS account. Your AWS account has a different default CMK for each AWS Region.
RestoreDbClusterFromS3Request.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts
to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
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 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
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 backtrackWindow(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).
RestoreDbClusterFromS3Request.Builder enableCloudwatchLogsExports(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. For more information, 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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.RestoreDbClusterFromS3Request.Builder enableCloudwatchLogsExports(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. For more information, 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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.RestoreDbClusterFromS3Request.Builder deletionProtection(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 is disabled.
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 is disabled.RestoreDbClusterFromS3Request.Builder copyTagsToSnapshot(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.RestoreDbClusterFromS3Request.Builder domain(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.
RestoreDbClusterFromS3Request.Builder domainIAMRoleName(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.RestoreDbClusterFromS3Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRestoreDbClusterFromS3Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.