Uses of Class
software.amazon.awscdk.services.rds.CfnDBInstance.Builder
Package
Description
Amazon Relational Database Service Construct Library
-
Uses of CfnDBInstance.Builder in software.amazon.awscdk.services.rds
Modifier and TypeMethodDescriptionCfnDBInstance.Builder.allocatedStorage
(String allocatedStorage) The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.CfnDBInstance.Builder.allowMajorVersionUpgrade
(Boolean allowMajorVersionUpgrade) A value that indicates whether major version upgrades are allowed.CfnDBInstance.Builder.allowMajorVersionUpgrade
(IResolvable allowMajorVersionUpgrade) A value that indicates whether major version upgrades are allowed.CfnDBInstance.Builder.associatedRoles
(List<? extends Object> associatedRoles) The AWS Identity and Access Management (IAM) roles associated with the DB instance.CfnDBInstance.Builder.associatedRoles
(IResolvable associatedRoles) The AWS Identity and Access Management (IAM) roles associated with the DB instance.CfnDBInstance.Builder.autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.CfnDBInstance.Builder.autoMinorVersionUpgrade
(IResolvable autoMinorVersionUpgrade) A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.CfnDBInstance.Builder.availabilityZone
(String availabilityZone) The Availability Zone (AZ) where the database will be created.CfnDBInstance.Builder.backupRetentionPeriod
(Number backupRetentionPeriod) The number of days for which automated backups are retained.CfnDBInstance.Builder.caCertificateIdentifier
(String caCertificateIdentifier) The identifier of the CA certificate for this DB instance.CfnDBInstance.Builder.certificateDetails
(IResolvable certificateDetails) The details of the DB instance's server certificate.CfnDBInstance.Builder.certificateDetails
(CfnDBInstance.CertificateDetailsProperty certificateDetails) The details of the DB instance's server certificate.CfnDBInstance.Builder.certificateRotationRestart
(Boolean certificateRotationRestart) A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.CfnDBInstance.Builder.certificateRotationRestart
(IResolvable certificateRotationRestart) A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.CfnDBInstance.Builder.characterSetName
(String characterSetName) For supported engines, indicates that the DB instance should be associated with the specified character set.CfnDBInstance.Builder.copyTagsToSnapshot
(Boolean copyTagsToSnapshot) A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.CfnDBInstance.Builder.copyTagsToSnapshot
(IResolvable copyTagsToSnapshot) A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.static CfnDBInstance.Builder
CfnDBInstance.Builder.customIamInstanceProfile
(String customIamInstanceProfile) The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.CfnDBInstance.Builder.dbClusterIdentifier
(String dbClusterIdentifier) The identifier of the DB cluster that the instance will belong to.CfnDBInstance.Builder.dbClusterSnapshotIdentifier
(String dbClusterSnapshotIdentifier) The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.CfnDBInstance.Builder.dbInstanceClass
(String dbInstanceClass) The compute and memory capacity of the DB instance, for example,db.m4.large
.CfnDBInstance.Builder.dbInstanceIdentifier
(String dbInstanceIdentifier) A name for the DB instance.The meaning of this parameter differs according to the database engine you use.CfnDBInstance.Builder.dbParameterGroupName
(String dbParameterGroupName) The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.CfnDBInstance.Builder.dbSecurityGroups
(List<String> dbSecurityGroups) A list of the DB security groups to assign to the DB instance.CfnDBInstance.Builder.dbSnapshotIdentifier
(String dbSnapshotIdentifier) The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.CfnDBInstance.Builder.dbSubnetGroupName
(String dbSubnetGroupName) A DB subnet group to associate with the DB instance.CfnDBInstance.Builder.deleteAutomatedBackups
(Boolean deleteAutomatedBackups) A value that indicates whether to remove automated backups immediately after the DB instance is deleted.CfnDBInstance.Builder.deleteAutomatedBackups
(IResolvable deleteAutomatedBackups) A value that indicates whether to remove automated backups immediately after the DB instance is deleted.CfnDBInstance.Builder.deletionProtection
(Boolean deletionProtection) A value that indicates whether the DB instance has deletion protection enabled.CfnDBInstance.Builder.deletionProtection
(IResolvable deletionProtection) A value that indicates whether the DB instance has deletion protection enabled.The Active Directory directory ID to create the DB instance in.CfnDBInstance.Builder.domainIamRoleName
(String domainIamRoleName) Specify the name of the IAM role to be used when making API calls to the Directory Service.CfnDBInstance.Builder.enableCloudwatchLogsExports
(List<String> enableCloudwatchLogsExports) The list of log types that need to be enabled for exporting to CloudWatch Logs.CfnDBInstance.Builder.enableIamDatabaseAuthentication
(Boolean enableIamDatabaseAuthentication) A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.CfnDBInstance.Builder.enableIamDatabaseAuthentication
(IResolvable enableIamDatabaseAuthentication) A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.CfnDBInstance.Builder.enablePerformanceInsights
(Boolean enablePerformanceInsights) A value that indicates whether to enable Performance Insights for the DB instance.CfnDBInstance.Builder.enablePerformanceInsights
(IResolvable enablePerformanceInsights) A value that indicates whether to enable Performance Insights for the DB instance.CfnDBInstance.Builder.endpoint
(IResolvable endpoint) Specifies the connection endpoint.CfnDBInstance.Builder.endpoint
(CfnDBInstance.EndpointProperty endpoint) Specifies the connection endpoint.The name of the database engine that you want to use for this DB instance.CfnDBInstance.Builder.engineVersion
(String engineVersion) The version number of the database engine to use.The number of I/O operations per second (IOPS) that the database provisions.The ARN of the AWS KMS key that's used to encrypt the DB instance, such asarn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
.CfnDBInstance.Builder.licenseModel
(String licenseModel) License model information for this DB instance.CfnDBInstance.Builder.manageMasterUserPassword
(Boolean manageMasterUserPassword) A value that indicates whether to manage the master user password with AWS Secrets Manager.CfnDBInstance.Builder.manageMasterUserPassword
(IResolvable manageMasterUserPassword) A value that indicates whether to manage the master user password with AWS Secrets Manager.CfnDBInstance.Builder.masterUsername
(String masterUsername) The master user name for the DB instance.CfnDBInstance.Builder.masterUserPassword
(String masterUserPassword) The password for the master user.CfnDBInstance.Builder.masterUserSecret
(IResolvable masterUserSecret) Contains the secret managed by RDS in AWS Secrets Manager for the master user password.CfnDBInstance.Builder.masterUserSecret
(CfnDBInstance.MasterUserSecretProperty masterUserSecret) Contains the secret managed by RDS in AWS Secrets Manager for the master user password.CfnDBInstance.Builder.maxAllocatedStorage
(Number maxAllocatedStorage) The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.CfnDBInstance.Builder.monitoringInterval
(Number monitoringInterval) The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.CfnDBInstance.Builder.monitoringRoleArn
(String monitoringRoleArn) The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.Specifies whether the database instance is a Multi-AZ DB instance deployment.CfnDBInstance.Builder.multiAz
(IResolvable multiAz) Specifies whether the database instance is a Multi-AZ DB instance deployment.CfnDBInstance.Builder.ncharCharacterSetName
(String ncharCharacterSetName) The name of the NCHAR character set for the Oracle DB instance.CfnDBInstance.Builder.networkType
(String networkType) The network type of the DB instance.CfnDBInstance.Builder.optionGroupName
(String optionGroupName) Indicates that the DB instance should be associated with the specified option group.CfnDBInstance.Builder.performanceInsightsKmsKeyId
(String performanceInsightsKmsKeyId) The AWS KMS key identifier for encryption of Performance Insights data.CfnDBInstance.Builder.performanceInsightsRetentionPeriod
(Number performanceInsightsRetentionPeriod) The number of days to retain Performance Insights data.The port number on which the database accepts connections.CfnDBInstance.Builder.preferredBackupWindow
(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, using theBackupRetentionPeriod
parameter.CfnDBInstance.Builder.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).CfnDBInstance.Builder.processorFeatures
(List<? extends Object> processorFeatures) The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.CfnDBInstance.Builder.processorFeatures
(IResolvable processorFeatures) The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.CfnDBInstance.Builder.promotionTier
(Number promotionTier) A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.CfnDBInstance.Builder.publiclyAccessible
(Boolean publiclyAccessible) Indicates whether the DB instance is an internet-facing instance.CfnDBInstance.Builder.publiclyAccessible
(IResolvable publiclyAccessible) Indicates whether the DB instance is an internet-facing instance.CfnDBInstance.Builder.replicaMode
(String replicaMode) The open mode of an Oracle read replica.CfnDBInstance.Builder.restoreTime
(String restoreTime) The date and time to restore from.CfnDBInstance.Builder.sourceDbClusterIdentifier
(String sourceDbClusterIdentifier) The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.CfnDBInstance.Builder.sourceDbInstanceAutomatedBackupsArn
(String sourceDbInstanceAutomatedBackupsArn) The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.CfnDBInstance.Builder.sourceDbInstanceIdentifier
(String sourceDbInstanceIdentifier) If you want to create a read replica DB instance, specify the ID of the source DB instance.CfnDBInstance.Builder.sourceDbiResourceId
(String sourceDbiResourceId) The resource ID of the source DB instance from which to restore.CfnDBInstance.Builder.sourceRegion
(String sourceRegion) The ID of the region that contains the source DB instance for the read replica.CfnDBInstance.Builder.storageEncrypted
(Boolean storageEncrypted) A value that indicates whether the DB instance is encrypted.CfnDBInstance.Builder.storageEncrypted
(IResolvable storageEncrypted) A value that indicates whether the DB instance is encrypted.CfnDBInstance.Builder.storageThroughput
(Number storageThroughput) Specifies the storage throughput value for the DB instance.CfnDBInstance.Builder.storageType
(String storageType) Specifies the storage type to be associated with the DB instance.An optional array of key-value pairs to apply to this DB instance.The time zone of the DB instance.CfnDBInstance.Builder.useDefaultProcessorFeatures
(Boolean useDefaultProcessorFeatures) A value that indicates whether the DB instance class of the DB instance uses its default processor features.CfnDBInstance.Builder.useDefaultProcessorFeatures
(IResolvable useDefaultProcessorFeatures) A value that indicates whether the DB instance class of the DB instance uses its default processor features.CfnDBInstance.Builder.useLatestRestorableTime
(Boolean useLatestRestorableTime) A value that indicates whether the DB instance is restored from the latest backup time.CfnDBInstance.Builder.useLatestRestorableTime
(IResolvable useLatestRestorableTime) A value that indicates whether the DB instance is restored from the latest backup time.CfnDBInstance.Builder.vpcSecurityGroups
(List<String> vpcSecurityGroups) A list of the VPC security group IDs to assign to the DB instance.