| Package | Description |
|---|---|
| software.amazon.awscdk.services.rds |
Amazon Relational Database Service Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
CfnDBInstance.Builder |
CfnDBInstance.Builder.allocatedStorage(String allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.allowMajorVersionUpgrade(IResolvable allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.associatedRoles(IResolvable associatedRoles)
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.associatedRoles(List<? extends Object> associatedRoles)
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
|
CfnDBInstance.Builder |
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 |
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 |
CfnDBInstance.Builder.availabilityZone(String availabilityZone)
The Availability Zone (AZ) where the database will be created.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.backupRetentionPeriod(Number backupRetentionPeriod)
The number of days for which automated backups are retained.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.caCertificateIdentifier(String caCertificateIdentifier)
The identifier of the CA certificate for this DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.characterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified character set.
|
CfnDBInstance.Builder |
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 |
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.create(software.constructs.Construct scope,
String id) |
CfnDBInstance.Builder |
CfnDBInstance.Builder.dbClusterIdentifier(String dbClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.dbInstanceClass(String dbInstanceClass)
The compute and memory capacity of the DB instance, for example, `db.m4.large` .
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.dbInstanceIdentifier(String dbInstanceIdentifier)
A name for the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.dbName(String dbName)
The meaning of this parameter differs according to the database engine you use.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.dbParameterGroupName(String dbParameterGroupName)
The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.dbSecurityGroups(List<String> dbSecurityGroups)
A list of the DB security groups to assign to the DB instance.
|
CfnDBInstance.Builder |
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 |
CfnDBInstance.Builder.dbSubnetGroupName(String dbSubnetGroupName)
A DB subnet group to associate with the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.deleteAutomatedBackups(Boolean deleteAutomatedBackups)
A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.deleteAutomatedBackups(IResolvable deleteAutomatedBackups)
A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.deletionProtection(IResolvable deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.domain(String domain)
The Active Directory directory ID to create the DB instance in.
|
CfnDBInstance.Builder |
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 |
CfnDBInstance.Builder.enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CfnDBInstance.Builder |
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 |
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 |
CfnDBInstance.Builder.enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.enablePerformanceInsights(IResolvable enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.engine(String engine)
The name of the database engine that you want to use for this DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.engineVersion(String engineVersion)
The version number of the database engine to use.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.iops(Number iops)
The number of I/O operations per second (IOPS) that the database provisions.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.kmsKeyId(String kmsKeyId)
The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.licenseModel(String licenseModel)
License model information for this DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.masterUsername(String masterUsername)
The master user name for the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.masterUserPassword(String masterUserPassword)
The password for the master user.
|
CfnDBInstance.Builder |
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 |
CfnDBInstance.Builder.monitoringInterval(Number monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.multiAz(Boolean multiAz)
Specifies whether the database instance is a Multi-AZ DB instance deployment.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.multiAz(IResolvable multiAz)
Specifies whether the database instance is a Multi-AZ DB instance deployment.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.optionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.performanceInsightsKmsKeyId(String performanceInsightsKmsKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.performanceInsightsRetentionPeriod(Number performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.port(String port)
The port number on which the database accepts connections.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CfnDBInstance.Builder |
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 |
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 |
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 |
CfnDBInstance.Builder.publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB instance is an internet-facing instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.publiclyAccessible(IResolvable publiclyAccessible)
Indicates whether the DB instance is an internet-facing instance.
|
CfnDBInstance.Builder |
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 |
CfnDBInstance.Builder.sourceRegion(String sourceRegion)
The ID of the region that contains the source DB instance for the read replica.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.storageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB instance is encrypted.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.storageEncrypted(IResolvable storageEncrypted)
A value that indicates whether the DB instance is encrypted.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.storageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.tags(List<? extends CfnTag> tags)
Tags to assign to the DB instance.
|
CfnDBInstance.Builder |
CfnDBInstance.Builder.timezone(String timezone)
The time zone of the DB instance.
|
CfnDBInstance.Builder |
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 |
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 |
CfnDBInstance.Builder.vpcSecurityGroups(List<String> vpcSecurityGroups)
A list of the VPC security group IDs to assign to the DB instance.
|
Copyright © 2022. All rights reserved.