Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.299Z") @Stability(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)
         .copyTagsToSnapshot(false)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbInstanceParameterGroupName("dbInstanceParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deletionProtection(false)
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .engineVersion("engineVersion")
         .iamAuthEnabled(false)
         .kmsKeyId("kmsKeyId")
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .restoreToTime("restoreToTime")
         .restoreType("restoreType")
         .serverlessScalingConfiguration(ServerlessScalingConfigurationProperty.builder()
                 .maxCapacity(123)
                 .minCapacity(123)
                 .build())
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

  • Method Details

    • getAssociatedRoles

      @Stability(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(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(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.

    • getCopyTagsToSnapshot

      @Stability(Stable) @Nullable default Object getCopyTagsToSnapshot()
      If set to true , tags are copied to any snapshot of the DB cluster that is created..

    • getDbClusterIdentifier

      @Stability(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(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.

    • getDbInstanceParameterGroupName

      @Stability(Stable) @Nullable default String getDbInstanceParameterGroupName()
      The name of the DB parameter group to apply to all instances of the DB cluster.

      Used only in case of a major engine version upgrade request

      Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

      Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

      • The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.

    • getDbSubnetGroupName

      @Stability(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(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(Stable) @Nullable default List<String> getEnableCloudwatchLogsExports()
      Specifies a list of log types that are enabled for export to CloudWatch Logs.

    • getEngineVersion

      @Stability(Stable) @Nullable default String getEngineVersion()
      Indicates the database engine version.

    • getIamAuthEnabled

      @Stability(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(Stable) @Nullable default String getKmsKeyId()
      If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      AWS::Neptune::DBCluster.Port.

    • getPreferredBackupWindow

      @Stability(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(Stable) @Nullable default String getPreferredMaintenanceWindow()
      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • getRestoreToTime

      @Stability(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(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.

    • getServerlessScalingConfiguration

      @Stability(Stable) @Nullable default Object getServerlessScalingConfiguration()
      AWS::Neptune::DBCluster.ServerlessScalingConfiguration.

    • getSnapshotIdentifier

      @Stability(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(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(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(Stable) @Nullable default List<CfnTag> getTags()
      The tags assigned to this cluster.

    • getUseLatestRestorableTime

      @Stability(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(Stable) @Nullable default List<String> getVpcSecurityGroupIds()
      Provides a list of VPC security groups that the DB cluster belongs to.

    • builder

      @Stability(Stable) static CfnDBClusterProps.Builder builder()
      Returns:
      a CfnDBClusterProps.Builder of CfnDBClusterProps