DatabaseClusterProps (software.amazon.awscdk:monocdk 1.180.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: DatabaseClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:53.578Z")
 @Stability(value=Experimental)
public interface DatabaseClusterProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a new database cluster.

Example:

 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .vpc(vpc)
         .instanceType(InstanceType.R5_LARGE)
         .instances(2)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DatabaseClusterProps.Builder` A builder for `DatabaseClusterProps`
`static class`	`DatabaseClusterProps.Jsii$Proxy` An implementation for `DatabaseClusterProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static DatabaseClusterProps.Builder`	`builder()`
`default List<IRole>`	`getAssociatedRoles()` (experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
`default Boolean`	`getAutoMinorVersionUpgrade()` (experimental) If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.
`default Duration`	`getBackupRetention()` (experimental) How many days to retain the backup.
`default IClusterParameterGroup`	`getClusterParameterGroup()` (experimental) Additional parameters to pass to the database engine.
`default String`	`getDbClusterName()` (experimental) An optional identifier for the cluster.
`default Boolean`	`getDeletionProtection()` (experimental) Indicates whether the DB cluster should have deletion protection enabled.
`default EngineVersion`	`getEngineVersion()` (experimental) What version of the database to start.
`default Boolean`	`getIamAuthentication()` (experimental) Map AWS Identity and Access Management (IAM) accounts to database accounts.
`default String`	`getInstanceIdentifierBase()` (experimental) Base identifier for instances.
`default Number`	`getInstances()` (experimental) Number of Neptune compute instances.
`InstanceType`	`getInstanceType()` (experimental) What type of instance to start for the replicas.
`default IKey`	`getKmsKey()` (experimental) The KMS key for storage encryption.
`default IParameterGroup`	`getParameterGroup()` (experimental) The DB parameter group to associate with the instance.
`default Number`	`getPort()` (experimental) The port the Neptune cluster will listen on.
`default String`	`getPreferredBackupWindow()` (experimental) A daily time range in 24-hours UTC format in which backups preferably execute.
`default String`	`getPreferredMaintenanceWindow()` (experimental) A weekly time range in which maintenance should preferably execute.
`default RemovalPolicy`	`getRemovalPolicy()` (experimental) The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
`default List<ISecurityGroup>`	`getSecurityGroups()` (experimental) Security group.
`default Boolean`	`getStorageEncrypted()` (experimental) Whether to enable storage encryption.
`default ISubnetGroup`	`getSubnetGroup()` (experimental) Existing subnet group for the cluster.
`IVpc`	`getVpc()` (experimental) What subnets to run the Neptune instances in.
`default SubnetSelection`	`getVpcSubnets()` (experimental) Where to place the instances within the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getInstanceType
```
@Stability(value=Experimental)
 @NotNull
InstanceType getInstanceType()
```
    (experimental) What type of instance to start for the replicas.
  - getVpc
```
@Stability(value=Experimental)
 @NotNull
IVpc getVpc()
```
    (experimental) What subnets to run the Neptune instances in.
    Must be at least 2 subnets in two different AZs.
  - getAssociatedRoles
```
@Stability(value=Experimental)
 @Nullable
default List<IRole> getAssociatedRoles()
```
    (experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
    Default: - No role is attached to the cluster.
  - getAutoMinorVersionUpgrade
```
@Stability(value=Experimental)
 @Nullable
default Boolean getAutoMinorVersionUpgrade()
```
    (experimental) If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.
    Default: - false
  - getBackupRetention
```
@Stability(value=Experimental)
 @Nullable
default Duration getBackupRetention()
```
    (experimental) How many days to retain the backup.
    Default: - cdk.Duration.days(1)
  - getClusterParameterGroup
```
@Stability(value=Experimental)
 @Nullable
default IClusterParameterGroup getClusterParameterGroup()
```
    (experimental) Additional parameters to pass to the database engine.
    Default: - No parameter group.
  - getDbClusterName
```
@Stability(value=Experimental)
 @Nullable
default String getDbClusterName()
```
    (experimental) An optional identifier for the cluster.
    Default: - A name is automatically generated.
  - getDeletionProtection
```
@Stability(value=Experimental)
 @Nullable
default Boolean getDeletionProtection()
```
    (experimental) Indicates whether the DB cluster should have deletion protection enabled.
    Default: - true if ``removalPolicy`` is RETAIN, false otherwise
  - getEngineVersion
```
@Stability(value=Experimental)
 @Nullable
default EngineVersion getEngineVersion()
```
    (experimental) What version of the database to start.
    Default: - The default engine version.
  - getIamAuthentication
```
@Stability(value=Experimental)
 @Nullable
default Boolean getIamAuthentication()
```
    (experimental) Map AWS Identity and Access Management (IAM) accounts to database accounts.
    Default: - `false`
  - getInstanceIdentifierBase
```
@Stability(value=Experimental)
 @Nullable
default String getInstanceIdentifierBase()
```
    (experimental) Base identifier for instances.
    Every replica is named by appending the replica number to this string, 1-based.
    Default: - `dbClusterName` is used with the word "Instance" appended. If `dbClusterName` is not provided, the identifier is automatically generated.
  - getInstances
```
@Stability(value=Experimental)
 @Nullable
default Number getInstances()
```
    (experimental) Number of Neptune compute instances.
    Default: 1
  - getKmsKey
```
@Stability(value=Experimental)
 @Nullable
default IKey getKmsKey()
```
    (experimental) The KMS key for storage encryption.
    Default: - default master key.
  - getParameterGroup
```
@Stability(value=Experimental)
 @Nullable
default IParameterGroup getParameterGroup()
```
    (experimental) The DB parameter group to associate with the instance.
    Default: no parameter group
  - getPort
```
@Stability(value=Experimental)
 @Nullable
default Number getPort()
```
    (experimental) The port the Neptune cluster will listen on.
    Default: - The default engine port
  - getPreferredBackupWindow
```
@Stability(value=Experimental)
 @Nullable
default String getPreferredBackupWindow()
```
    (experimental) A daily time range in 24-hours UTC format in which backups preferably execute.
    Must be at least 30 minutes long.
    Example: '01:00-02:00'
    Default: - a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see
  - getPreferredMaintenanceWindow
```
@Stability(value=Experimental)
 @Nullable
default String getPreferredMaintenanceWindow()
```
    (experimental) A weekly time range in which maintenance should preferably execute.
    Must be at least 30 minutes long.
    Example: 'tue:04:17-tue:04:47'
    Default: - 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
  - getRemovalPolicy
```
@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()
```
    (experimental) The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
    This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.
    Default: - Retain cluster.
  - getSecurityGroups
```
@Stability(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()
```
    (experimental) Security group.
    Default: a new security group is created.
  - getStorageEncrypted
```
@Stability(value=Experimental)
 @Nullable
default Boolean getStorageEncrypted()
```
    (experimental) Whether to enable storage encryption.
    Default: true
  - getSubnetGroup
```
@Stability(value=Experimental)
 @Nullable
default ISubnetGroup getSubnetGroup()
```
    (experimental) Existing subnet group for the cluster.
    Default: - a new subnet group will be created.
  - getVpcSubnets
```
@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()
```
    (experimental) Where to place the instances within the VPC.
    Default: private subnets
  - builder
```
@Stability(value=Experimental)
static DatabaseClusterProps.Builder builder()
```
    Returns:
    
    a DatabaseClusterProps.Builder of DatabaseClusterProps

Interface DatabaseClusterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getInstanceType

getVpc

getAssociatedRoles

getAutoMinorVersionUpgrade

getBackupRetention

getClusterParameterGroup

getDbClusterName

getDeletionProtection

getEngineVersion

getIamAuthentication

getInstanceIdentifierBase

getInstances

getKmsKey

getParameterGroup

getPort

getPreferredBackupWindow

getPreferredMaintenanceWindow

getRemovalPolicy

getSecurityGroups

getStorageEncrypted

getSubnetGroup

getVpcSubnets

builder