@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 Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
Long |
backtrackWindow()
The target backtrack window, in seconds.
|
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.
|
Boolean |
copyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
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 |
deletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
String |
domain()
Specify the Active Directory directory ID to restore the DB cluster in.
|
String |
domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
enableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
Boolean |
enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
String |
engine()
The name of the database engine to be used for this DB cluster.
|
String |
engineVersion()
The version number of the database engine to use.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAvailabilityZones()
Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasEnableCloudwatchLogsExports()
Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroupIds()
Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
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.
|
List<SdkField<?>> |
sdkFields() |
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()
A value that indicates whether the restored DB cluster is encrypted.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
RestoreDbClusterFromS3Request.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the restored DB cluster.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasAvailabilityZones()
public final List<String> availabilityZones()
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAvailabilityZones() to see if a value was sent in this field.
public final 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 final String characterSetName()
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
public final String databaseName()
The database name for the restored DB cluster.
public final 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
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
public final 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 final boolean hasVpcSecurityGroupIds()
public final 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.
You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
public final 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 final 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
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
5.7-compatible Aurora), and aurora-postgresql
public final 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
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
public final Integer port()
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
Default: 3306
public final 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.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public final 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 final 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 final 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.
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.
public final 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.
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.
public final boolean hasTags()
public final List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags() to see if a value was sent in this field.
public final Boolean storageEncrypted()
A value that indicates whether the restored DB cluster is encrypted.
public final 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.
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.
public final 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.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public final 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 final 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
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40, 5.7.28
public final String s3BucketName()
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
public final 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 final 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 final 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).
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public final boolean hasEnableCloudwatchLogsExports()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnableCloudwatchLogsExports() to see if a value was sent in this field.
public final 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.
public final 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.
public final 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.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public final String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public RestoreDbClusterFromS3Request.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RestoreDbClusterFromS3Request.Builder,RestoreDbClusterFromS3Request>toBuilder in class RdsRequestpublic static RestoreDbClusterFromS3Request.Builder builder()
public static Class<? extends RestoreDbClusterFromS3Request.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.