| Package | Description |
|---|---|
| software.amazon.awscdk.services.rds |
Amazon Relational Database Service Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
DatabaseInstance.Builder |
DatabaseInstance.Builder.allocatedStorage(Number allocatedStorage)
(experimental) The allocated storage size, specified in gigabytes (GB).
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
(experimental) Whether to allow major version upgrades.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
(experimental) Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.availabilityZone(String availabilityZone)
(experimental) The name of the Availability Zone where the DB instance will be located.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.backupRetention(Duration backupRetention)
(experimental) The number of days during which automatic DB snapshots are retained.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.characterSetName(String characterSetName)
(experimental) For supported engines, specifies the character set to associate with the DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.cloudwatchLogsExports(List<String> cloudwatchLogsExports)
(experimental) The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)
(experimental) The number of days log events are kept in CloudWatch Logs.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)
(experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.copyTagsToSnapshot(Boolean copyTagsToSnapshot)
(experimental) Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
|
static DatabaseInstance.Builder |
DatabaseInstance.Builder.create(software.constructs.Construct scope,
String id) |
DatabaseInstance.Builder |
DatabaseInstance.Builder.credentials(Credentials credentials)
(experimental) Credentials for the administrative user.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.databaseName(String databaseName)
(experimental) The name of the database.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.deleteAutomatedBackups(Boolean deleteAutomatedBackups)
(experimental) Indicates whether automated backups should be deleted or retained when you delete a DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.deletionProtection(Boolean deletionProtection)
(experimental) Indicates whether the DB instance should have deletion protection enabled.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.domain(String domain)
(experimental) The Active Directory directory ID to create the DB instance in.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.domainRole(IRole domainRole)
(experimental) The IAM role to be used when making API calls to the Directory Service.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.enablePerformanceInsights(Boolean enablePerformanceInsights)
(experimental) Whether to enable Performance Insights for the DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.engine(IInstanceEngine engine)
(experimental) The database engine.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.iamAuthentication(Boolean iamAuthentication)
(experimental) Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.instanceIdentifier(String instanceIdentifier)
(experimental) A name for the DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.instanceType(InstanceType instanceType)
(experimental) The name of the compute and memory capacity for the instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.iops(Number iops)
(experimental) The number of I/O operations per second (IOPS) that the database provisions.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.licenseModel(LicenseModel licenseModel)
(experimental) The license model.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.maxAllocatedStorage(Number maxAllocatedStorage)
(experimental) Upper limit to which RDS can scale the storage in GiB(Gibibyte).
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.monitoringInterval(Duration monitoringInterval)
(experimental) The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.monitoringRole(IRole monitoringRole)
(experimental) Role that will be used to manage DB instance monitoring.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.multiAz(Boolean multiAz)
(experimental) Specifies if the database instance is a multiple Availability Zone deployment.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.optionGroup(IOptionGroup optionGroup)
(experimental) The option group to associate with the instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.parameterGroup(IParameterGroup parameterGroup)
(experimental) The DB parameter group to associate with the instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)
(experimental) The AWS KMS key for encryption of Performance Insights data.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)
(experimental) The amount of time, in days, to retain Performance Insights data.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.port(Number port)
(experimental) The port for the instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.preferredBackupWindow(String preferredBackupWindow)
(experimental) The daily time range during which automated backups are performed.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.preferredMaintenanceWindow(String preferredMaintenanceWindow)
(experimental) The weekly time range (in UTC) during which system maintenance can occur.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.processorFeatures(ProcessorFeatures processorFeatures)
(experimental) The number of CPU cores and the number of threads per core.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.publiclyAccessible(Boolean publiclyAccessible)
(experimental) Indicates whether the DB instance is an internet-facing instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.removalPolicy(RemovalPolicy removalPolicy)
(experimental) The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)
(experimental) S3 buckets that you want to load data into.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.s3ExportRole(IRole s3ExportRole)
(experimental) Role that will be associated with this DB instance to enable S3 export.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)
(experimental) S3 buckets that you want to load data from.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.s3ImportRole(IRole s3ImportRole)
(experimental) Role that will be associated with this DB instance to enable S3 import.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.securityGroups(List<? extends ISecurityGroup> securityGroups)
(experimental) The security groups to assign to the DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.storageEncrypted(Boolean storageEncrypted)
(experimental) Indicates whether the DB instance is encrypted.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.storageEncryptionKey(IKey storageEncryptionKey)
(experimental) The KMS key that's used to encrypt the DB instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.storageType(StorageType storageType)
(experimental) The storage type.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.subnetGroup(ISubnetGroup subnetGroup)
(experimental) Existing subnet group for the instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.timezone(String timezone)
(experimental) The time zone of the instance.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.vpc(IVpc vpc)
(experimental) The VPC network where the DB subnet group should be created.
|
DatabaseInstance.Builder |
DatabaseInstance.Builder.vpcSubnets(SubnetSelection vpcSubnets)
(experimental) The type of subnets to add to the created DB subnet group.
|
Copyright © 2021. All rights reserved.