software.amazon.awscdk.services.rds

Interface InstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.494Z")
 @Stability(value=Stable)
public interface InstanceProps
extends software.amazon.jsii.JsiiSerializable

Instance properties for database instances.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_2_08_1).build()))
         .credentials(Credentials.fromGeneratedSecret("clusteradmin")) // Optional - will default to 'admin' username and generated password
         .instanceProps(InstanceProps.builder()
                 // optional , defaults to t3.medium
                 .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.SMALL))
                 .vpcSubnets(SubnetSelection.builder()
                         .subnetType(SubnetType.PRIVATE_WITH_EGRESS)
                         .build())
                 .vpc(vpc)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstanceProps.Builder A builder for InstanceProps
static class	InstanceProps.Jsii$Proxy An implementation for InstanceProps

Method Summary

Modifier and Type	Method and Description
static InstanceProps.Builder	builder()
default Boolean	getAllowMajorVersionUpgrade() Whether to allow upgrade of major version for the DB instance.
default Boolean	getAutoMinorVersionUpgrade() Whether to enable automatic upgrade of minor version for the DB instance.
default Boolean	getDeleteAutomatedBackups() Whether to remove automated backups immediately after the DB instance is deleted for the DB instance.
default Boolean	getEnablePerformanceInsights() Whether to enable Performance Insights for the DB instance.
default InstanceType	getInstanceType() What type of instance to start for the replicas.
default IParameterGroup	getParameterGroup() The DB parameter group to associate with the instance.
default Map<String,String>	getParameters() The parameters in the DBParameterGroup to create automatically.
default IKey	getPerformanceInsightEncryptionKey() The AWS KMS key for encryption of Performance Insights data.
default PerformanceInsightRetention	getPerformanceInsightRetention() The amount of time, in days, to retain Performance Insights data.
default Boolean	getPubliclyAccessible() Indicates whether the DB instance is an internet-facing instance.
default List<ISecurityGroup>	getSecurityGroups() Security group.
IVpc	getVpc() What subnets to run the RDS instances in.
default SubnetSelection	getVpcSubnets() Where to place the instances within the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getVpc

@Stability(value=Stable)
 @NotNull
IVpc getVpc()

What subnets to run the RDS instances in.

Must be at least 2 subnets in two different AZs.

getAllowMajorVersionUpgrade

@Stability(value=Stable)
 @Nullable
default Boolean getAllowMajorVersionUpgrade()

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

Default: - false

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @Nullable
default Boolean getAutoMinorVersionUpgrade()

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

Default: - true

getDeleteAutomatedBackups

@Stability(value=Stable)
 @Nullable
default Boolean getDeleteAutomatedBackups()

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

Default: - true

getEnablePerformanceInsights

@Stability(value=Stable)
 @Nullable
default Boolean getEnablePerformanceInsights()

Whether to enable Performance Insights for the DB instance.

Default: - false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.

getInstanceType

@Stability(value=Stable)
 @Nullable
default InstanceType getInstanceType()

What type of instance to start for the replicas.

Default: - t3.medium (or, more precisely, db.t3.medium)

getParameterGroup

@Stability(value=Stable)
 @Nullable
default IParameterGroup getParameterGroup()

The DB parameter group to associate with the instance.

Default: no parameter group

getParameters

@Stability(value=Stable)
 @Nullable
default Map<String,String> getParameters()

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.

Default: - None

getPerformanceInsightEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getPerformanceInsightEncryptionKey()

The AWS KMS key for encryption of Performance Insights data.

Default: - default master key

getPerformanceInsightRetention

@Stability(value=Stable)
 @Nullable
default PerformanceInsightRetention getPerformanceInsightRetention()

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

Default: 7

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
default Boolean getPubliclyAccessible()

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

Default: - `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise

getSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

Security group.

Default: a new security group is created.

getVpcSubnets

@Stability(value=Stable)
 @Nullable
default SubnetSelection getVpcSubnets()

Where to place the instances within the VPC.

Default: - the Vpc default strategy if not specified.

builder

@Stability(value=Stable)
static InstanceProps.Builder builder()

Returns:

a InstanceProps.Builder of InstanceProps