software.amazon.awscdk.services.neptune

Interface CfnDBClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBClusterProps.Jsii$Proxy

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

Properties for defining a `CfnDBCluster`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.neptune.*;
 CfnDBClusterProps cfnDBClusterProps = CfnDBClusterProps.builder()
         .associatedRoles(List.of(DBClusterRoleProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .featureName("featureName")
                 .build()))
         .availabilityZones(List.of("availabilityZones"))
         .backupRetentionPeriod(123)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deletionProtection(false)
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .engineVersion("engineVersion")
         .iamAuthEnabled(false)
         .kmsKeyId("kmsKeyId")
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .restoreToTime("restoreToTime")
         .restoreType("restoreType")
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDBClusterProps.Builder	builder()
default Object	getAssociatedRoles() Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
default List<String>	getAvailabilityZones() Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
default Number	getBackupRetentionPeriod() Specifies the number of days for which automatic DB snapshots are retained.
default String	getDbClusterIdentifier() Contains a user-supplied DB cluster identifier.
default String	getDbClusterParameterGroupName() Provides the name of the DB cluster parameter group.
default String	getDbSubnetGroupName() Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
default Object	getDeletionProtection() Indicates whether or not the DB cluster has deletion protection enabled.
default List<String>	getEnableCloudwatchLogsExports() Specifies a list of log types that are enabled for export to CloudWatch Logs.
default String	getEngineVersion() Indicates the database engine version.
default Object	getIamAuthEnabled() True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
default String	getKmsKeyId() If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
default Number	getPort() Specifies the port that the database engine is listening on.
default String	getPreferredBackupWindow() Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` .
default String	getPreferredMaintenanceWindow() Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
default String	getRestoreToTime() Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
default String	getRestoreType() Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
default String	getSnapshotIdentifier() Specifies the identifier for a DB cluster snapshot.
default String	getSourceDbClusterIdentifier() Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
default Object	getStorageEncrypted() Indicates whether the DB cluster is encrypted.
default List<CfnTag>	getTags() The tags assigned to this cluster.
default Object	getUseLatestRestorableTime() Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
default List<String>	getVpcSecurityGroupIds() Provides a list of VPC security groups that the DB cluster belongs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAssociatedRoles

@Stability(value=Stable)
 @Nullable
default Object getAssociatedRoles()

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

getAvailabilityZones

@Stability(value=Stable)
 @Nullable
default List<String> getAvailabilityZones()

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

getBackupRetentionPeriod

@Stability(value=Stable)
 @Nullable
default Number getBackupRetentionPeriod()

Specifies the number of days for which automatic DB snapshots are retained.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

getDbClusterIdentifier

@Stability(value=Stable)
 @Nullable
default String getDbClusterIdentifier()

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

getDbClusterParameterGroupName

@Stability(value=Stable)
 @Nullable
default String getDbClusterParameterGroupName()

Provides the name of the DB cluster parameter group.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

getDbSubnetGroupName

@Stability(value=Stable)
 @Nullable
default String getDbSubnetGroupName()

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

getDeletionProtection

@Stability(value=Stable)
 @Nullable
default Object getDeletionProtection()

Indicates whether or not the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled.

getEnableCloudwatchLogsExports

@Stability(value=Stable)
 @Nullable
default List<String> getEnableCloudwatchLogsExports()

Specifies a list of log types that are enabled for export to CloudWatch Logs.

getEngineVersion

@Stability(value=Stable)
 @Nullable
default String getEngineVersion()

Indicates the database engine version.

getIamAuthEnabled

@Stability(value=Stable)
 @Nullable
default Object getIamAuthEnabled()

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

Specifies the port that the database engine is listening on.

getPreferredBackupWindow

@Stability(value=Stable)
 @Nullable
default String getPreferredBackupWindow()

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` .

An update may require some interruption.

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
default String getPreferredMaintenanceWindow()

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

getRestoreToTime

@Stability(value=Stable)
 @Nullable
default String getRestoreToTime()

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

getRestoreType

@Stability(value=Stable)
 @Nullable
default String getRestoreType()

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

getSnapshotIdentifier

@Stability(value=Stable)
 @Nullable
default String getSnapshotIdentifier()

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

getSourceDbClusterIdentifier

@Stability(value=Stable)
 @Nullable
default String getSourceDbClusterIdentifier()

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

getStorageEncrypted

@Stability(value=Stable)
 @Nullable
default Object getStorageEncrypted()

Indicates whether the DB cluster is encrypted.

If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The tags assigned to this cluster.

getUseLatestRestorableTime

@Stability(value=Stable)
 @Nullable
default Object getUseLatestRestorableTime()

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getVpcSecurityGroupIds()

Provides a list of VPC security groups that the DB cluster belongs to.

builder

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

Returns:

a CfnDBClusterProps.Builder of CfnDBClusterProps