@Stability(value=Experimental) public static final class DatabaseInstanceProps.Builder extends Object implements software.amazon.jsii.Builder<DatabaseInstanceProps>
DatabaseInstanceProps
Constructor and Description |
---|
Builder() |
@Stability(value=Experimental) public DatabaseInstanceProps.Builder characterSetName(String characterSetName)
DatabaseInstanceProps.getCharacterSetName()
characterSetName
- For supported engines, specifies the character set to associate with the DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder credentials(Credentials credentials)
DatabaseInstanceProps.getCredentials()
credentials
- Credentials for the administrative user.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder storageEncrypted(Boolean storageEncrypted)
DatabaseInstanceProps.getStorageEncrypted()
storageEncrypted
- Indicates whether the DB instance is encrypted.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder storageEncryptionKey(IKey storageEncryptionKey)
DatabaseInstanceProps.getStorageEncryptionKey()
storageEncryptionKey
- The KMS key that's used to encrypt the DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder engine(IInstanceEngine engine)
DatabaseInstanceSourceProps.getEngine()
engine
- The database engine. This parameter is required.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder allocatedStorage(Number allocatedStorage)
DatabaseInstanceSourceProps.getAllocatedStorage()
allocatedStorage
- The allocated storage size, specified in gigabytes (GB).this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
DatabaseInstanceSourceProps.getAllowMajorVersionUpgrade()
allowMajorVersionUpgrade
- Whether to allow major version upgrades.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder databaseName(String databaseName)
DatabaseInstanceSourceProps.getDatabaseName()
databaseName
- The name of the database.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder instanceType(InstanceType instanceType)
DatabaseInstanceSourceProps.getInstanceType()
instanceType
- The name of the compute and memory capacity for the instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder licenseModel(LicenseModel licenseModel)
DatabaseInstanceSourceProps.getLicenseModel()
licenseModel
- The license model.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder parameterGroup(IParameterGroup parameterGroup)
DatabaseInstanceSourceProps.getParameterGroup()
parameterGroup
- The DB parameter group to associate with the instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder timezone(String timezone)
DatabaseInstanceSourceProps.getTimezone()
timezone
- The time zone of the instance.
This is currently supported only by Microsoft Sql Server.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder vpc(IVpc vpc)
DatabaseInstanceNewProps.getVpc()
vpc
- The VPC network where the DB subnet group should be created. This parameter is required.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
DatabaseInstanceNewProps.getAutoMinorVersionUpgrade()
autoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder availabilityZone(String availabilityZone)
DatabaseInstanceNewProps.getAvailabilityZone()
availabilityZone
- The name of the Availability Zone where the DB instance will be located.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder backupRetention(Duration backupRetention)
DatabaseInstanceNewProps.getBackupRetention()
backupRetention
- The number of days during which automatic DB snapshots are retained.
Set to zero to disable backups.
When creating a read replica, you must enable automatic backups on the source
database instance by setting the backup retention to a value other than zero.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder cloudwatchLogsExports(List<String> cloudwatchLogsExports)
DatabaseInstanceNewProps.getCloudwatchLogsExports()
cloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)
DatabaseInstanceNewProps.getCloudwatchLogsRetention()
cloudwatchLogsRetention
- The number of days log events are kept in CloudWatch Logs.
When updating
this property, unsetting it doesn't remove the log retention policy. To
remove the retention policy, set the value to Infinity
.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)
DatabaseInstanceNewProps.getCloudwatchLogsRetentionRole()
cloudwatchLogsRetentionRole
- The IAM role for the Lambda function associated with the custom resource that sets the retention policy.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
DatabaseInstanceNewProps.getCopyTagsToSnapshot()
copyTagsToSnapshot
- Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder deleteAutomatedBackups(Boolean deleteAutomatedBackups)
DatabaseInstanceNewProps.getDeleteAutomatedBackups()
deleteAutomatedBackups
- Indicates whether automated backups should be deleted or retained when you delete a DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder deletionProtection(Boolean deletionProtection)
DatabaseInstanceNewProps.getDeletionProtection()
deletionProtection
- Indicates whether the DB instance should have deletion protection enabled.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder domain(String domain)
DatabaseInstanceNewProps.getDomain()
domain
- The Active Directory directory ID to create the DB instance in.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder domainRole(IRole domainRole)
DatabaseInstanceNewProps.getDomainRole()
domainRole
- The IAM role to be used when making API calls to the Directory Service.
The role needs the AWS-managed policy
AmazonRDSDirectoryServiceAccess or equivalent.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
DatabaseInstanceNewProps.getEnablePerformanceInsights()
enablePerformanceInsights
- Whether to enable Performance Insights for the DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder iamAuthentication(Boolean iamAuthentication)
DatabaseInstanceNewProps.getIamAuthentication()
iamAuthentication
- Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder instanceIdentifier(String instanceIdentifier)
DatabaseInstanceNewProps.getInstanceIdentifier()
instanceIdentifier
- A name for the DB instance.
If you specify a name, AWS CloudFormation
converts it to lowercase.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder iops(Number iops)
DatabaseInstanceNewProps.getIops()
iops
- The number of I/O operations per second (IOPS) that the database provisions.
The value must be equal to or greater than 1000.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder maxAllocatedStorage(Number maxAllocatedStorage)
DatabaseInstanceNewProps.getMaxAllocatedStorage()
maxAllocatedStorage
- Upper limit to which RDS can scale the storage in GiB(Gibibyte).this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder monitoringInterval(Duration monitoringInterval)
DatabaseInstanceNewProps.getMonitoringInterval()
monitoringInterval
- The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder monitoringRole(IRole monitoringRole)
DatabaseInstanceNewProps.getMonitoringRole()
monitoringRole
- Role that will be used to manage DB instance monitoring.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder multiAz(Boolean multiAz)
DatabaseInstanceNewProps.getMultiAz()
multiAz
- Specifies if the database instance is a multiple Availability Zone deployment.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder optionGroup(IOptionGroup optionGroup)
DatabaseInstanceNewProps.getOptionGroup()
optionGroup
- The option group to associate with the instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)
DatabaseInstanceNewProps.getPerformanceInsightEncryptionKey()
performanceInsightEncryptionKey
- The AWS KMS key for encryption of Performance Insights data.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)
DatabaseInstanceNewProps.getPerformanceInsightRetention()
performanceInsightRetention
- The amount of time, in days, to retain Performance Insights data.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder port(Number port)
DatabaseInstanceNewProps.getPort()
port
- The port for the instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder preferredBackupWindow(String preferredBackupWindow)
DatabaseInstanceNewProps.getPreferredBackupWindow()
preferredBackupWindow
- The daily time range during which automated backups are performed.
Constraints:
hh24:mi-hh24:mi
.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
DatabaseInstanceNewProps.getPreferredMaintenanceWindow()
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Constraint: Minimum 30-minute windowthis
@Stability(value=Experimental) public DatabaseInstanceProps.Builder processorFeatures(ProcessorFeatures processorFeatures)
DatabaseInstanceNewProps.getProcessorFeatures()
processorFeatures
- The number of CPU cores and the number of threads per core.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder publiclyAccessible(Boolean publiclyAccessible)
DatabaseInstanceNewProps.getPubliclyAccessible()
publiclyAccessible
- Indicates whether the DB instance is an internet-facing instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder removalPolicy(RemovalPolicy removalPolicy)
DatabaseInstanceNewProps.getRemovalPolicy()
removalPolicy
- The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)
DatabaseInstanceNewProps.getS3ExportBuckets()
s3ExportBuckets
- S3 buckets that you want to load data into.
This feature is only supported by the Microsoft SQL Server and Oracle engines.
This property must not be used if s3ExportRole
is used.
For Microsoft SQL Server:
this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder s3ExportRole(IRole s3ExportRole)
DatabaseInstanceNewProps.getS3ExportRole()
s3ExportRole
- Role that will be associated with this DB instance to enable S3 export.
This feature is only supported by the Microsoft SQL Server and Oracle engines.
This property must not be used if s3ExportBuckets
is used.
For Microsoft SQL Server:
this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)
DatabaseInstanceNewProps.getS3ImportBuckets()
s3ImportBuckets
- S3 buckets that you want to load data from.
This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
This property must not be used if s3ImportRole
is used.
For Microsoft SQL Server:
this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder s3ImportRole(IRole s3ImportRole)
DatabaseInstanceNewProps.getS3ImportRole()
s3ImportRole
- Role that will be associated with this DB instance to enable S3 import.
This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.
This property must not be used if s3ImportBuckets
is used.
For Microsoft SQL Server:
this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
DatabaseInstanceNewProps.getSecurityGroups()
securityGroups
- The security groups to assign to the DB instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder storageType(StorageType storageType)
DatabaseInstanceNewProps.getStorageType()
storageType
- The storage type.
Storage types supported are gp2, io1, standard.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder subnetGroup(ISubnetGroup subnetGroup)
DatabaseInstanceNewProps.getSubnetGroup()
subnetGroup
- Existing subnet group for the instance.this
@Stability(value=Experimental) public DatabaseInstanceProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
DatabaseInstanceNewProps.getVpcSubnets()
vpcSubnets
- The type of subnets to add to the created DB subnet group.this
@Stability(value=Experimental) public DatabaseInstanceProps build()
build
in interface software.amazon.jsii.Builder<DatabaseInstanceProps>
DatabaseInstanceProps
NullPointerException
- if any required attribute was not providedCopyright © 2021. All rights reserved.