Package software.amazon.awscdk.services.rds

Class DatabaseInstanceNewProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.DatabaseInstanceNewProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseInstanceNewProps>

Enclosing interface:

DatabaseInstanceNewProps

@Stability(Stable)
public static final class DatabaseInstanceNewProps.Builder
extends Object
implements software.amazon.jsii.Builder<DatabaseInstanceNewProps>

A builder for DatabaseInstanceNewProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DatabaseInstanceNewProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of DatabaseInstanceNewProps.getAutoMinorVersionUpgrade()
DatabaseInstanceNewProps.Builder	availabilityZone(String availabilityZone)	Sets the value of DatabaseInstanceNewProps.getAvailabilityZone()
DatabaseInstanceNewProps.Builder	backupRetention(Duration backupRetention)	Sets the value of DatabaseInstanceNewProps.getBackupRetention()
DatabaseInstanceNewProps	build()	Builds the configured instance.
DatabaseInstanceNewProps.Builder	caCertificate(CaCertificate caCertificate)	Sets the value of DatabaseInstanceNewProps.getCaCertificate()
DatabaseInstanceNewProps.Builder	cloudwatchLogsExports(List<String> cloudwatchLogsExports)	Sets the value of DatabaseInstanceNewProps.getCloudwatchLogsExports()
DatabaseInstanceNewProps.Builder	cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)	Sets the value of DatabaseInstanceNewProps.getCloudwatchLogsRetention()
DatabaseInstanceNewProps.Builder	cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)	Sets the value of DatabaseInstanceNewProps.getCloudwatchLogsRetentionRole()
DatabaseInstanceNewProps.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)	Sets the value of DatabaseInstanceNewProps.getCopyTagsToSnapshot()
DatabaseInstanceNewProps.Builder	deleteAutomatedBackups(Boolean deleteAutomatedBackups)	Sets the value of DatabaseInstanceNewProps.getDeleteAutomatedBackups()
DatabaseInstanceNewProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of DatabaseInstanceNewProps.getDeletionProtection()
DatabaseInstanceNewProps.Builder	domain(String domain)	Sets the value of DatabaseInstanceNewProps.getDomain()
DatabaseInstanceNewProps.Builder	domainRole(IRole domainRole)	Sets the value of DatabaseInstanceNewProps.getDomainRole()
DatabaseInstanceNewProps.Builder	enablePerformanceInsights(Boolean enablePerformanceInsights)	Sets the value of DatabaseInstanceNewProps.getEnablePerformanceInsights()
DatabaseInstanceNewProps.Builder	iamAuthentication(Boolean iamAuthentication)	Sets the value of DatabaseInstanceNewProps.getIamAuthentication()
DatabaseInstanceNewProps.Builder	instanceIdentifier(String instanceIdentifier)	Sets the value of DatabaseInstanceNewProps.getInstanceIdentifier()
DatabaseInstanceNewProps.Builder	iops(Number iops)	Sets the value of DatabaseInstanceNewProps.getIops()
DatabaseInstanceNewProps.Builder	maxAllocatedStorage(Number maxAllocatedStorage)	Sets the value of DatabaseInstanceNewProps.getMaxAllocatedStorage()
DatabaseInstanceNewProps.Builder	monitoringInterval(Duration monitoringInterval)	Sets the value of DatabaseInstanceNewProps.getMonitoringInterval()
DatabaseInstanceNewProps.Builder	monitoringRole(IRole monitoringRole)	Sets the value of DatabaseInstanceNewProps.getMonitoringRole()
DatabaseInstanceNewProps.Builder	multiAz(Boolean multiAz)	Sets the value of DatabaseInstanceNewProps.getMultiAz()
DatabaseInstanceNewProps.Builder	networkType(NetworkType networkType)	Sets the value of DatabaseInstanceNewProps.getNetworkType()
DatabaseInstanceNewProps.Builder	optionGroup(IOptionGroup optionGroup)	Sets the value of DatabaseInstanceNewProps.getOptionGroup()
DatabaseInstanceNewProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of DatabaseInstanceNewProps.getParameterGroup()
DatabaseInstanceNewProps.Builder	performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)	Sets the value of DatabaseInstanceNewProps.getPerformanceInsightEncryptionKey()
DatabaseInstanceNewProps.Builder	performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)	Sets the value of DatabaseInstanceNewProps.getPerformanceInsightRetention()
DatabaseInstanceNewProps.Builder	port(Number port)	Sets the value of DatabaseInstanceNewProps.getPort()
DatabaseInstanceNewProps.Builder	preferredBackupWindow(String preferredBackupWindow)	Sets the value of DatabaseInstanceNewProps.getPreferredBackupWindow()
DatabaseInstanceNewProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of DatabaseInstanceNewProps.getPreferredMaintenanceWindow()
DatabaseInstanceNewProps.Builder	processorFeatures(ProcessorFeatures processorFeatures)	Sets the value of DatabaseInstanceNewProps.getProcessorFeatures()
DatabaseInstanceNewProps.Builder	publiclyAccessible(Boolean publiclyAccessible)	Sets the value of DatabaseInstanceNewProps.getPubliclyAccessible()
DatabaseInstanceNewProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of DatabaseInstanceNewProps.getRemovalPolicy()
DatabaseInstanceNewProps.Builder	s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)	Sets the value of DatabaseInstanceNewProps.getS3ExportBuckets()
DatabaseInstanceNewProps.Builder	s3ExportRole(IRole s3ExportRole)	Sets the value of DatabaseInstanceNewProps.getS3ExportRole()
DatabaseInstanceNewProps.Builder	s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)	Sets the value of DatabaseInstanceNewProps.getS3ImportBuckets()
DatabaseInstanceNewProps.Builder	s3ImportRole(IRole s3ImportRole)	Sets the value of DatabaseInstanceNewProps.getS3ImportRole()
DatabaseInstanceNewProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of DatabaseInstanceNewProps.getSecurityGroups()
DatabaseInstanceNewProps.Builder	storageThroughput(Number storageThroughput)	Sets the value of DatabaseInstanceNewProps.getStorageThroughput()
DatabaseInstanceNewProps.Builder	storageType(StorageType storageType)	Sets the value of DatabaseInstanceNewProps.getStorageType()
DatabaseInstanceNewProps.Builder	subnetGroup(ISubnetGroup subnetGroup)	Sets the value of DatabaseInstanceNewProps.getSubnetGroup()
DatabaseInstanceNewProps.Builder	vpc(IVpc vpc)	Sets the value of DatabaseInstanceNewProps.getVpc()
DatabaseInstanceNewProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of DatabaseInstanceNewProps.getVpcSubnets()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

vpc

@Stability(Stable)
public DatabaseInstanceNewProps.Builder vpc(IVpc vpc)

Sets the value of DatabaseInstanceNewProps.getVpc()

Parameters:

vpc - The VPC network where the DB subnet group should be created. This parameter is required.

Returns:

this

autoMinorVersionUpgrade

@Stability(Stable)
public DatabaseInstanceNewProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Sets the value of DatabaseInstanceNewProps.getAutoMinorVersionUpgrade()

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Returns:

this

availabilityZone

@Stability(Stable)
public DatabaseInstanceNewProps.Builder availabilityZone(String availabilityZone)

Sets the value of DatabaseInstanceNewProps.getAvailabilityZone()

Parameters:

availabilityZone - The name of the Availability Zone where the DB instance will be located.

Returns:

this

backupRetention

@Stability(Stable)
public DatabaseInstanceNewProps.Builder backupRetention(Duration backupRetention)

Sets the value of DatabaseInstanceNewProps.getBackupRetention()

Parameters:

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.

Returns:

this

caCertificate

@Stability(Stable)
public DatabaseInstanceNewProps.Builder caCertificate(CaCertificate caCertificate)

Sets the value of DatabaseInstanceNewProps.getCaCertificate()

Parameters:

caCertificate - The identifier of the CA certificate for this DB instance. Specifying or updating this property triggers a reboot.

For RDS DB engines:

Returns:

this

cloudwatchLogsExports

@Stability(Stable)
public DatabaseInstanceNewProps.Builder cloudwatchLogsExports(List<String> cloudwatchLogsExports)

Sets the value of DatabaseInstanceNewProps.getCloudwatchLogsExports()

Parameters:

cloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs.

Returns:

this

cloudwatchLogsRetention

@Stability(Stable)
public DatabaseInstanceNewProps.Builder cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)

Sets the value of DatabaseInstanceNewProps.getCloudwatchLogsRetention()

Parameters:

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.

Returns:

this

cloudwatchLogsRetentionRole

@Stability(Stable)
public DatabaseInstanceNewProps.Builder cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)

Sets the value of DatabaseInstanceNewProps.getCloudwatchLogsRetentionRole()

Parameters:

cloudwatchLogsRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Returns:

this

copyTagsToSnapshot

@Stability(Stable)
public DatabaseInstanceNewProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

Sets the value of DatabaseInstanceNewProps.getCopyTagsToSnapshot()

Parameters:

copyTagsToSnapshot - Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.

Returns:

this

deleteAutomatedBackups

@Stability(Stable)
public DatabaseInstanceNewProps.Builder deleteAutomatedBackups(Boolean deleteAutomatedBackups)

Sets the value of DatabaseInstanceNewProps.getDeleteAutomatedBackups()

Parameters:

deleteAutomatedBackups - Indicates whether automated backups should be deleted or retained when you delete a DB instance.

Returns:

this

deletionProtection

@Stability(Stable)
public DatabaseInstanceNewProps.Builder deletionProtection(Boolean deletionProtection)

Sets the value of DatabaseInstanceNewProps.getDeletionProtection()

Parameters:

deletionProtection - Indicates whether the DB instance should have deletion protection enabled.

Returns:

this

domain

@Stability(Stable)
public DatabaseInstanceNewProps.Builder domain(String domain)

Sets the value of DatabaseInstanceNewProps.getDomain()

Parameters:

domain - The Active Directory directory ID to create the DB instance in.

Returns:

this

domainRole

@Stability(Stable)
public DatabaseInstanceNewProps.Builder domainRole(IRole domainRole)

Sets the value of DatabaseInstanceNewProps.getDomainRole()

Parameters:

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.

Returns:

this

enablePerformanceInsights

@Stability(Stable)
public DatabaseInstanceNewProps.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)

Sets the value of DatabaseInstanceNewProps.getEnablePerformanceInsights()

Parameters:

enablePerformanceInsights - Whether to enable Performance Insights for the DB instance.

Returns:

this

iamAuthentication

@Stability(Stable)
public DatabaseInstanceNewProps.Builder iamAuthentication(Boolean iamAuthentication)

Sets the value of DatabaseInstanceNewProps.getIamAuthentication()

Parameters:

iamAuthentication - Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

Returns:

this

instanceIdentifier

@Stability(Stable)
public DatabaseInstanceNewProps.Builder instanceIdentifier(String instanceIdentifier)

Sets the value of DatabaseInstanceNewProps.getInstanceIdentifier()

Parameters:

instanceIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase.

Returns:

this

iops

@Stability(Stable)
public DatabaseInstanceNewProps.Builder iops(Number iops)

Sets the value of DatabaseInstanceNewProps.getIops()

Parameters:

iops - The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.

Returns:

this

maxAllocatedStorage

@Stability(Stable)
public DatabaseInstanceNewProps.Builder maxAllocatedStorage(Number maxAllocatedStorage)

Sets the value of DatabaseInstanceNewProps.getMaxAllocatedStorage()

Parameters:

maxAllocatedStorage - Upper limit to which RDS can scale the storage in GiB(Gibibyte).

Returns:

this

monitoringInterval

@Stability(Stable)
public DatabaseInstanceNewProps.Builder monitoringInterval(Duration monitoringInterval)

Sets the value of DatabaseInstanceNewProps.getMonitoringInterval()

Parameters:

monitoringInterval - The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.

Returns:

this

monitoringRole

@Stability(Stable)
public DatabaseInstanceNewProps.Builder monitoringRole(IRole monitoringRole)

Sets the value of DatabaseInstanceNewProps.getMonitoringRole()

Parameters:

monitoringRole - Role that will be used to manage DB instance monitoring.

Returns:

this

multiAz

@Stability(Stable)
public DatabaseInstanceNewProps.Builder multiAz(Boolean multiAz)

Sets the value of DatabaseInstanceNewProps.getMultiAz()

Parameters:

multiAz - Specifies if the database instance is a multiple Availability Zone deployment.

Returns:

this

networkType

@Stability(Stable)
public DatabaseInstanceNewProps.Builder networkType(NetworkType networkType)

Sets the value of DatabaseInstanceNewProps.getNetworkType()

Parameters:

networkType - The network type of the DB instance.

Returns:

this

optionGroup

@Stability(Stable)
public DatabaseInstanceNewProps.Builder optionGroup(IOptionGroup optionGroup)

Sets the value of DatabaseInstanceNewProps.getOptionGroup()

Parameters:

optionGroup - The option group to associate with the instance.

Returns:

this

parameterGroup

@Stability(Stable)
public DatabaseInstanceNewProps.Builder parameterGroup(IParameterGroup parameterGroup)

Sets the value of DatabaseInstanceNewProps.getParameterGroup()

Parameters:

parameterGroup - The DB parameter group to associate with the instance.

Returns:

this

performanceInsightEncryptionKey

@Stability(Stable)
public DatabaseInstanceNewProps.Builder performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)

Sets the value of DatabaseInstanceNewProps.getPerformanceInsightEncryptionKey()

Parameters:

performanceInsightEncryptionKey - The AWS KMS key for encryption of Performance Insights data.

Returns:

this

performanceInsightRetention

@Stability(Stable)
public DatabaseInstanceNewProps.Builder performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)

Sets the value of DatabaseInstanceNewProps.getPerformanceInsightRetention()

Parameters:

performanceInsightRetention - The amount of time, in days, to retain Performance Insights data.

Returns:

this

port

@Stability(Stable)
public DatabaseInstanceNewProps.Builder port(Number port)

Sets the value of DatabaseInstanceNewProps.getPort()

Parameters:

port - The port for the instance.

Returns:

this

preferredBackupWindow

@Stability(Stable)
public DatabaseInstanceNewProps.Builder preferredBackupWindow(String preferredBackupWindow)

Sets the value of DatabaseInstanceNewProps.getPreferredBackupWindow()

Parameters:

preferredBackupWindow - The daily time range during which automated backups are performed. Constraints:

• Must be in the format hh24:mi-hh24:mi.
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

Returns:

this

preferredMaintenanceWindow

@Stability(Stable)
public DatabaseInstanceNewProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of DatabaseInstanceNewProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

Returns:

this

processorFeatures

@Stability(Stable)
public DatabaseInstanceNewProps.Builder processorFeatures(ProcessorFeatures processorFeatures)

Sets the value of DatabaseInstanceNewProps.getProcessorFeatures()

Parameters:

processorFeatures - The number of CPU cores and the number of threads per core.

Returns:

this

publiclyAccessible

@Stability(Stable)
public DatabaseInstanceNewProps.Builder publiclyAccessible(Boolean publiclyAccessible)

Sets the value of DatabaseInstanceNewProps.getPubliclyAccessible()

Parameters:

publiclyAccessible - Indicates whether the DB instance is an internet-facing instance. If not specified, the instance's vpcSubnets will be used to determine if the instance is internet-facing or not.

Returns:

this

removalPolicy

@Stability(Stable)
public DatabaseInstanceNewProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of DatabaseInstanceNewProps.getRemovalPolicy()

Parameters:

removalPolicy - The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Returns:

this

s3ExportBuckets

@Stability(Stable)
public DatabaseInstanceNewProps.Builder s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)

Sets the value of DatabaseInstanceNewProps.getS3ExportBuckets()

Parameters:

s3ExportBuckets - S3 buckets that you want to load data into. This property must not be used if s3ExportRole is used.

For Microsoft SQL Server:

Returns:

this

s3ExportRole

@Stability(Stable)
public DatabaseInstanceNewProps.Builder s3ExportRole(IRole s3ExportRole)

Sets the value of DatabaseInstanceNewProps.getS3ExportRole()

Parameters:

s3ExportRole - Role that will be associated with this DB instance to enable S3 export. This property must not be used if s3ExportBuckets is used.

For Microsoft SQL Server:

Returns:

this

s3ImportBuckets

@Stability(Stable)
public DatabaseInstanceNewProps.Builder s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)

Sets the value of DatabaseInstanceNewProps.getS3ImportBuckets()

Parameters:

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:

Returns:

this

s3ImportRole

@Stability(Stable)
public DatabaseInstanceNewProps.Builder s3ImportRole(IRole s3ImportRole)

Sets the value of DatabaseInstanceNewProps.getS3ImportRole()

Parameters:

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:

Returns:

this

securityGroups

@Stability(Stable)
public DatabaseInstanceNewProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of DatabaseInstanceNewProps.getSecurityGroups()

Parameters:

securityGroups - The security groups to assign to the DB instance.

Returns:

this

storageThroughput

@Stability(Stable)
public DatabaseInstanceNewProps.Builder storageThroughput(Number storageThroughput)

Sets the value of DatabaseInstanceNewProps.getStorageThroughput()

Parameters:

storageThroughput - The storage throughput, specified in mebibytes per second (MiBps). Only applicable for GP3.

Returns:

this

storageType

@Stability(Stable)
public DatabaseInstanceNewProps.Builder storageType(StorageType storageType)

Sets the value of DatabaseInstanceNewProps.getStorageType()

Parameters:

storageType - The storage type. Storage types supported are gp2, io1, standard.

Returns:

this

subnetGroup

@Stability(Stable)
public DatabaseInstanceNewProps.Builder subnetGroup(ISubnetGroup subnetGroup)

Sets the value of DatabaseInstanceNewProps.getSubnetGroup()

Parameters:

subnetGroup - Existing subnet group for the instance.

Returns:

this

vpcSubnets

@Stability(Stable)
public DatabaseInstanceNewProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of DatabaseInstanceNewProps.getVpcSubnets()

Parameters:

vpcSubnets - The type of subnets to add to the created DB subnet group.

Returns:

this

build

@Stability(Stable)
public DatabaseInstanceNewProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DatabaseInstanceNewProps>

Returns:

a new instance of DatabaseInstanceNewProps

Throws:

NullPointerException - if any required attribute was not provided