Package software.amazon.awscdk.services.rds

Class InstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.InstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<InstanceProps>

Enclosing interface:

InstanceProps

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

A builder for InstanceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InstanceProps.Builder	allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)	Sets the value of InstanceProps.getAllowMajorVersionUpgrade()
InstanceProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of InstanceProps.getAutoMinorVersionUpgrade()
InstanceProps	build()	Builds the configured instance.
InstanceProps.Builder	deleteAutomatedBackups(Boolean deleteAutomatedBackups)	Sets the value of InstanceProps.getDeleteAutomatedBackups()
InstanceProps.Builder	enablePerformanceInsights(Boolean enablePerformanceInsights)	Sets the value of InstanceProps.getEnablePerformanceInsights()
InstanceProps.Builder	instanceType(InstanceType instanceType)	Sets the value of InstanceProps.getInstanceType()
InstanceProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of InstanceProps.getParameterGroup()
InstanceProps.Builder	parameters(Map<String,String> parameters)	Sets the value of InstanceProps.getParameters()
InstanceProps.Builder	performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)	Sets the value of InstanceProps.getPerformanceInsightEncryptionKey()
InstanceProps.Builder	performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)	Sets the value of InstanceProps.getPerformanceInsightRetention()
InstanceProps.Builder	publiclyAccessible(Boolean publiclyAccessible)	Sets the value of InstanceProps.getPubliclyAccessible()
InstanceProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of InstanceProps.getSecurityGroups()
InstanceProps.Builder	vpc(IVpc vpc)	Sets the value of InstanceProps.getVpc()
InstanceProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of InstanceProps.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 InstanceProps.Builder vpc(IVpc vpc)

Sets the value of InstanceProps.getVpc()

Parameters:

vpc - What subnets to run the RDS instances in. This parameter is required. Must be at least 2 subnets in two different AZs.

Returns:

this

allowMajorVersionUpgrade

@Stability(Stable)
public InstanceProps.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

Sets the value of InstanceProps.getAllowMajorVersionUpgrade()

Parameters:

allowMajorVersionUpgrade - Whether to allow upgrade of major version for the DB instance.

Returns:

this

autoMinorVersionUpgrade

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

Sets the value of InstanceProps.getAutoMinorVersionUpgrade()

Parameters:

autoMinorVersionUpgrade - Whether to enable automatic upgrade of minor version for the DB instance.

Returns:

this

deleteAutomatedBackups

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

Sets the value of InstanceProps.getDeleteAutomatedBackups()

Parameters:

deleteAutomatedBackups - Whether to remove automated backups immediately after the DB instance is deleted for the DB instance.

Returns:

this

enablePerformanceInsights

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

Sets the value of InstanceProps.getEnablePerformanceInsights()

Parameters:

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

Returns:

this

instanceType

@Stability(Stable)
public InstanceProps.Builder instanceType(InstanceType instanceType)

Sets the value of InstanceProps.getInstanceType()

Parameters:

instanceType - What type of instance to start for the replicas.

Returns:

this

parameterGroup

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

Sets the value of InstanceProps.getParameterGroup()

Parameters:

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

Returns:

this

parameters

@Stability(Stable)
public InstanceProps.Builder parameters(Map<String,String> parameters)

Sets the value of InstanceProps.getParameters()

Parameters:

parameters - The parameters in the DBParameterGroup to create automatically. You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.

Returns:

this

performanceInsightEncryptionKey

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

Sets the value of InstanceProps.getPerformanceInsightEncryptionKey()

Parameters:

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

Returns:

this

performanceInsightRetention

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

Sets the value of InstanceProps.getPerformanceInsightRetention()

Parameters:

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

Returns:

this

publiclyAccessible

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

Sets the value of InstanceProps.getPubliclyAccessible()

Parameters:

publiclyAccessible - Indicates whether the DB instance is an internet-facing instance.

Returns:

this

securityGroups

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

Sets the value of InstanceProps.getSecurityGroups()

Parameters:

securityGroups - Security group.

Returns:

this

vpcSubnets

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

Sets the value of InstanceProps.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the instances within the VPC.

Returns:

this

build

@Stability(Stable)
public InstanceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of InstanceProps

Throws:

NullPointerException - if any required attribute was not provided