rds/aws.sdk.kotlin.services.rds.model/RestoreDbClusterFromS3Request/Builder

Builder

class Builder

Properties

availabilityZones

var availabilityZones: List<String>?

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

backtrackWindow

var backtrackWindow: Long?

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod

var backupRetentionPeriod: Int?

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

characterSetName

var characterSetName: String?

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

copyTagsToSnapshot

var copyTagsToSnapshot: Boolean?

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

databaseName

var databaseName: String?

The database name for the restored DB cluster.

dbClusterIdentifier

var dbClusterIdentifier: String?

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

dbClusterParameterGroupName

var dbClusterParameterGroupName: String?

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

dbSubnetGroupName

var dbSubnetGroupName: String?

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

deletionProtection

var deletionProtection: Boolean?

Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

domain

var domain: String?

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

domainIamRoleName

var domainIamRoleName: String?

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports

var enableCloudwatchLogsExports: List<String>?

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.

enableIamDatabaseAuthentication

var enableIamDatabaseAuthentication: Boolean?

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

engine

var engine: String?

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

engineVersion

var engineVersion: String?

The version number of the database engine to use.

kmsKeyId

var kmsKeyId: String?

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

manageMasterUserPassword

var manageMasterUserPassword: Boolean?

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

masterUsername

var masterUsername: String?

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

masterUserPassword

var masterUserPassword: String?

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

masterUserSecretKmsKeyId

var masterUserSecretKmsKeyId: String?

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

networkType

var networkType: String?

The network type of the DB cluster.

optionGroupName

var optionGroupName: String?

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

port

var port: Int?

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

preferredBackupWindow

var preferredBackupWindow: String?

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

preferredMaintenanceWindow

var preferredMaintenanceWindow: String?

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

s3BucketName

var s3BucketName: String?

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

s3IngestionRoleArn

var s3IngestionRoleArn: String?

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.

s3Prefix

var s3Prefix: String?

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.

serverlessV2ScalingConfiguration

var serverlessV2ScalingConfiguration: ServerlessV2ScalingConfiguration?

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

sourceEngine

var sourceEngine: String?

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

sourceEngineVersion

var sourceEngineVersion: String?

The version of the database that the backup files were created from.

storageEncrypted

var storageEncrypted: Boolean?

Specifies whether the restored DB cluster is encrypted.