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

Interface RestoreDBClusterFromS3Request.Builder

All Superinterfaces:

CopyableBuilder<RestoreDBClusterFromS3Request.Builder,RestoreDBClusterFromS3Request>, SdkBuilder<RestoreDBClusterFromS3Request.Builder,RestoreDBClusterFromS3Request>

Enclosing class:

RestoreDBClusterFromS3Request

public static interface RestoreDBClusterFromS3Request.Builder
extends CopyableBuilder<RestoreDBClusterFromS3Request.Builder,RestoreDBClusterFromS3Request>

Method Summary

Modifier and Type	Method	Description
RestoreDBClusterFromS3Request.Builder	availabilityZones(String... availabilityZones)	A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
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	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 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)	A Boolean value that is 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 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	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)
RestoreDBClusterFromS3Request.Builder	tags(Tag... tags)	NOTE: This method appends the values to the existing list (if any).
RestoreDBClusterFromS3Request.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds)	A list of EC2 VPC security groups to associate with the restored DB cluster.
RestoreDBClusterFromS3Request.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)	A list of EC2 VPC security groups to associate with the restored DB cluster.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

availabilityZones

RestoreDBClusterFromS3Request.Builder availabilityZones(Collection<String> availabilityZones)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

RestoreDBClusterFromS3Request.Builder availabilityZones(String... availabilityZones)

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

NOTE: This method appends the values to the existing list (if any). Use #setAvailabilityZones(java.util.Collection) or #withAvailabilityZones(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

backupRetentionPeriod

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

characterSetName

RestoreDBClusterFromS3Request.Builder characterSetName(String characterSetName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseName

RestoreDBClusterFromS3Request.Builder databaseName(String databaseName)

The database name for the restored DB cluster.

Parameters:

databaseName - The database name for the restored DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbClusterIdentifier

RestoreDBClusterFromS3Request.Builder dbClusterIdentifier(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

dbClusterParameterGroupName

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

RestoreDBClusterFromS3Request.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

RestoreDBClusterFromS3Request.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

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

NOTE: This method appends the values to the existing list (if any). Use #setVpcSecurityGroupIds(java.util.Collection) or #withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dbSubnetGroupName

RestoreDBClusterFromS3Request.Builder dbSubnetGroupName(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

engine

RestoreDBClusterFromS3Request.Builder engine(String engine)

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

Valid Values: aurora

Parameters:

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

Valid Values: aurora

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

RestoreDBClusterFromS3Request.Builder engineVersion(String engineVersion)

The version number of the database engine to use.

Aurora

Example: 5.6.10a

Parameters:

engineVersion - The version number of the database engine to use.

Aurora

Example: 5.6.10a

Returns:

Returns a reference to this object so that method calls can be chained together.

port

RestoreDBClusterFromS3Request.Builder port(Integer port)

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

Default: 3306

Parameters:

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

Default: 3306

Returns:

Returns a reference to this object so that method calls can be chained together.

masterUsername

RestoreDBClusterFromS3Request.Builder masterUsername(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

masterUserPassword

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

optionGroupName

RestoreDBClusterFromS3Request.Builder optionGroupName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

preferredBackupWindow

RestoreDBClusterFromS3Request.Builder preferredBackupWindow(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

preferredMaintenanceWindow

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

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tags

RestoreDBClusterFromS3Request.Builder tags(Collection<Tag> tags)

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

RestoreDBClusterFromS3Request.Builder tags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

storageEncrypted

RestoreDBClusterFromS3Request.Builder storageEncrypted(Boolean storageEncrypted)

Specifies whether the restored DB cluster is encrypted.

Parameters:

storageEncrypted - Specifies whether the restored DB cluster is encrypted.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

RestoreDBClusterFromS3Request.Builder kmsKeyId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

enableIAMDatabaseAuthentication

RestoreDBClusterFromS3Request.Builder enableIAMDatabaseAuthentication(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sourceEngine

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sourceEngineVersion

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

s3BucketName

RestoreDBClusterFromS3Request.Builder s3BucketName(String s3BucketName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

s3Prefix

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

s3IngestionRoleArn

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.