Package software.amazon.awssdk.services.rds.model

Class RestoreDBClusterFromS3Request

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.RestoreDBClusterFromS3Request

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<RestoreDBClusterFromS3Request.Builder,RestoreDBClusterFromS3Request>

@Generated("software.amazon.awssdk:codegen")
public class RestoreDBClusterFromS3Request
extends AmazonWebServiceRequest
implements ToCopyableBuilder<RestoreDBClusterFromS3Request.Builder,RestoreDBClusterFromS3Request>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestoreDBClusterFromS3Request.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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 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()	A Boolean value that is 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)
int	hashCode()
String	kmsKeyId()	The 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()
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.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

availabilityZones

public List<String> availabilityZones()

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

backupRetentionPeriod

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

Returns:

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

characterSetName

public String characterSetName()

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Returns:

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

databaseName

public String databaseName()

The database name for the restored DB cluster.

Returns:

The database name for the restored DB cluster.

dbClusterIdentifier

public String dbClusterIdentifier()

The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Returns:

The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

dbClusterParameterGroupName

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 will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

vpcSecurityGroupIds

public List<String> vpcSecurityGroupIds()

A list of EC2 VPC security groups to associate with the restored DB cluster.

Returns:

A list of EC2 VPC security groups to associate with the restored DB cluster.

dbSubnetGroupName

public String dbSubnetGroupName()

A DB subnet group to associate with the restored DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Returns:

A DB subnet group to associate with the restored DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

engine

public String engine()

The name of the database engine to be used for the restored DB cluster.

Valid Values: aurora

Returns:

The name of the database engine to be used for the restored DB cluster.

Valid Values: aurora

engineVersion

public String engineVersion()

The version number of the database engine to use.

Aurora

Example: 5.6.10a

Returns:

The version number of the database engine to use.

Aurora

Example: 5.6.10a

port

public Integer port()

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

Returns:

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

masterUsername

public String masterUsername()

The name of the master user for the restored DB cluster.

Constraints:

• Must be 1 to 16 alphanumeric characters.

• First character must be a letter.

• Cannot be a reserved word for the chosen database engine.

Returns:

The name of the master user for the restored DB cluster.

Constraints:

• Must be 1 to 16 alphanumeric characters.

• First character must be a letter.

• Cannot be a reserved word for the chosen database engine.

masterUserPassword

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.

Returns:

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.

optionGroupName

public String optionGroupName()

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.

Returns:

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.

preferredBackupWindow

public String preferredBackupWindow()

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per 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.

• Times should be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Returns:

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per 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.

• Times should be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

preferredMaintenanceWindow

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

Default: A 30-minute window selected at random from an 8-hour block of time per 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.

Returns:

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per 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.

tags

public List<Tag> tags()

Returns:

storageEncrypted

public Boolean storageEncrypted()

Specifies whether the restored DB cluster is encrypted.

Returns:

Specifies whether the restored DB cluster is encrypted.

kmsKeyId

public String kmsKeyId()

The 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.

Returns:

The 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.

enableIAMDatabaseAuthentication

public Boolean enableIAMDatabaseAuthentication()

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

sourceEngine

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

Returns:

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

sourceEngineVersion

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

Returns:

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

s3BucketName

public String s3BucketName()

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Returns:

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

s3Prefix

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.

Returns:

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.

s3IngestionRoleArn

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.

Returns:

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.

toBuilder

public RestoreDBClusterFromS3Request.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreDBClusterFromS3Request.Builder,RestoreDBClusterFromS3Request>

Returns:

a builder for type T

builder

public static RestoreDBClusterFromS3Request.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreDBClusterFromS3Request.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object