@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 Amazon Web Services 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()
For responses, this returns true if the service returned a value for the AvailabilityZones property.
|
boolean |
hasEnableCloudwatchLogsExports()
For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
|
String |
kmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
|
Boolean |
manageMasterUserPassword()
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
|
String |
masterUsername()
The name of the master user for the restored DB cluster.
|
String |
masterUserPassword()
The password for the master database user.
|
String |
masterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
String |
networkType()
The network type of the DB cluster.
|
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 Amazon Web Services 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() |
ServerlessV2ScalingConfiguration |
serverlessV2ScalingConfiguration()
Returns the value of the ServerlessV2ScalingConfiguration property for this object.
|
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()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAvailabilityZones() method.
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()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.
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: mydbsubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
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) and aurora-mysql (for MySQL
5.7-compatible and MySQL 8.0-compatible Aurora)
Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for
MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
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 and MySQL
8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,
8.0.mysql_aurora.3.02.0
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 and
MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
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.
Can't be specified if ManageMasterUserPassword is turned on.
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final Boolean storageEncrypted()
A value that indicates whether the restored DB cluster is encrypted.
public final String kmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services
account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services 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 KMS key. There is a default KMS
key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS
key for each Amazon Web Services Region.
public final Boolean enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
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 Amazon Web Services 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()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.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.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon Aurora, 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnableCloudwatchLogsExports() method.
Aurora MySQL
Possible values are audit, error, general, and
slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
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 isn't enabled.
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 final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()
public final String networkType()
The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
public final Boolean manageMasterUserPassword()
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword is specified.
public final String masterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS
key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you
can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer
managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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 © 2023. All rights reserved.