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

Builder

Properties

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

autoMinorVersionUpgrade

var autoMinorVersionUpgrade: Boolean?

Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

availabilityZone

var availabilityZone: String?

The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

backupRetentionPeriod

var backupRetentionPeriod: Int?

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

caCertificateIdentifier

var caCertificateIdentifier: String?

The CA certificate identifier to use for the DB instance's server certificate.

copyTagsToSnapshot

var copyTagsToSnapshot: Boolean?

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

databaseInsightsMode

var databaseInsightsMode: DatabaseInsightsMode?

Specifies the mode of Database Insights to enable for the DB instance.

dbInstanceClass

var dbInstanceClass: String?

The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

dbInstanceIdentifier

var dbInstanceIdentifier: String?

The DB instance identifier. This parameter is stored as a lowercase string.

dbName

var dbName: String?

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

dbParameterGroupName

var dbParameterGroupName: String?

The name of the DB parameter group to associate with this DB instance.

dbSecurityGroups

var dbSecurityGroups: List<String>?

A list of DB security groups to associate with this DB instance.

dbSubnetGroupName

var dbSubnetGroupName: String?

A DB subnet group to associate with this DB instance.

dedicatedLogVolume

var dedicatedLogVolume: Boolean?

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

deletionProtection

var deletionProtection: Boolean?

Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

enableCloudwatchLogsExports

var enableCloudwatchLogsExports: List<String>?

The list of logs that the restored DB instance 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 RDS User Guide.

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.

enablePerformanceInsights

var enablePerformanceInsights: Boolean?

Specifies whether to enable Performance Insights for the DB instance.

engine

var engine: String?

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

engineLifecycleSupport

var engineLifecycleSupport: String?

The life cycle type for this DB instance.

engineVersion

var engineVersion: String?

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

iops

var iops: Int?

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

kmsKeyId

var kmsKeyId: String?

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

licenseModel

var licenseModel: String?

The license model for this DB instance. Use general-public-license.

manageMasterUserPassword

var manageMasterUserPassword: Boolean?

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

masterUsername

var masterUsername: String?

The name for the master user.

masterUserPassword

var masterUserPassword: String?

The password for the master user.

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.

maxAllocatedStorage

var maxAllocatedStorage: Int?

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

monitoringInterval

var monitoringInterval: Int?

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

monitoringRoleArn

var monitoringRoleArn: String?

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

multiAz

var multiAz: Boolean?

Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

networkType

var networkType: String?

The network type of the DB instance.

optionGroupName

var optionGroupName: String?

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

performanceInsightsKmsKeyId

var performanceInsightsKmsKeyId: String?

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod

var performanceInsightsRetentionPeriod: Int?

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

port

var port: Int?

The port number on which the database accepts connections.

preferredBackupWindow

var preferredBackupWindow: String?

The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.

preferredMaintenanceWindow

var preferredMaintenanceWindow: String?

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

processorFeatures

var processorFeatures: List<ProcessorFeature>?

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

publiclyAccessible

var publiclyAccessible: Boolean?

Specifies whether the DB instance is publicly accessible.

s3BucketName

var s3BucketName: String?

The name of your Amazon S3 bucket that contains your database backup file.

s3IngestionRoleArn

var s3IngestionRoleArn: String?

An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.

s3Prefix

var s3Prefix: String?

The prefix of your Amazon S3 bucket.

sourceEngine

var sourceEngine: String?

The name of the engine of your source database.

sourceEngineVersion

var sourceEngineVersion: String?

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

storageEncrypted

var storageEncrypted: Boolean?

Specifies whether the new DB instance is encrypted or not.