1.204.0

interface CfnDBClusterProps

LanguageType name
.NETAmazon.CDK.AWS.Neptune.CfnDBClusterProps
Javasoftware.amazon.awscdk.services.neptune.CfnDBClusterProps
Pythonaws_cdk.aws_neptune.CfnDBClusterProps
TypeScript @aws-cdk/aws-neptune » CfnDBClusterProps

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 * as neptune from '@aws-cdk/aws-neptune';
const cfnDBClusterProps: neptune.CfnDBClusterProps = {
  associatedRoles: [{
    roleArn: 'roleArn',

    // the properties below are optional
    featureName: 'featureName',
  }],
  availabilityZones: ['availabilityZones'],
  backupRetentionPeriod: 123,
  copyTagsToSnapshot: false,
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  dbInstanceParameterGroupName: 'dbInstanceParameterGroupName',
  dbSubnetGroupName: 'dbSubnetGroupName',
  deletionProtection: false,
  enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
  engineVersion: 'engineVersion',
  iamAuthEnabled: false,
  kmsKeyId: 'kmsKeyId',
  port: 123,
  preferredBackupWindow: 'preferredBackupWindow',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  restoreToTime: 'restoreToTime',
  restoreType: 'restoreType',
  serverlessScalingConfiguration: {
    maxCapacity: 123,
    minCapacity: 123,
  },
  snapshotIdentifier: 'snapshotIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  useLatestRestorableTime: false,
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};

Properties

NameTypeDescription
associatedRoles?IResolvable | DBClusterRoleProperty | IResolvable[]Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
availabilityZones?string[]Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backupRetentionPeriod?numberSpecifies the number of days for which automatic DB snapshots are retained.
copyTagsToSnapshot?boolean | IResolvableIf set to true , tags are copied to any snapshot of the DB cluster that is created..
dbClusterIdentifier?stringContains a user-supplied DB cluster identifier.
dbClusterParameterGroupName?stringProvides the name of the DB cluster parameter group.
dbInstanceParameterGroupName?stringThe name of the DB parameter group to apply to all instances of the DB cluster.
dbSubnetGroupName?stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletionProtection?boolean | IResolvableIndicates whether or not the DB cluster has deletion protection enabled.
enableCloudwatchLogsExports?string[]Specifies a list of log types that are enabled for export to CloudWatch Logs.
engineVersion?stringIndicates the database engine version.
iamAuthEnabled?boolean | IResolvableTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kmsKeyId?stringIf StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.
port?numberAWS::Neptune::DBCluster.Port.
preferredBackupWindow?stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
preferredMaintenanceWindow?stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restoreToTime?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
restoreType?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
serverlessScalingConfiguration?IResolvable | ServerlessScalingConfigurationPropertyAWS::Neptune::DBCluster.ServerlessScalingConfiguration.
snapshotIdentifier?stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
sourceDbClusterIdentifier?stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
storageEncrypted?boolean | IResolvableIndicates whether the DB cluster is encrypted.
tags?CfnTag[]The tags assigned to this cluster.
useLatestRestorableTime?boolean | IResolvableCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
vpcSecurityGroupIds?string[]Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles?

Type: IResolvable | DBClusterRoleProperty | IResolvable[] (optional)

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.

availabilityZones?

Type: string[] (optional)

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

backupRetentionPeriod?

Type: number (optional)

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.

copyTagsToSnapshot?

Type: boolean | IResolvable (optional)

If set to true , tags are copied to any snapshot of the DB cluster that is created..

dbClusterIdentifier?

Type: string (optional)

Contains a user-supplied DB cluster identifier.

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

dbClusterParameterGroupName?

Type: string (optional)

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.

dbInstanceParameterGroupName?

Type: string (optional)

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.

dbSubnetGroupName?

Type: string (optional)

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

deletionProtection?

Type: boolean | IResolvable (optional)

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

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

enableCloudwatchLogsExports?

Type: string[] (optional)

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

engineVersion?

Type: string (optional)

Indicates the database engine version.

iamAuthEnabled?

Type: boolean | IResolvable (optional)

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

kmsKeyId?

Type: string (optional)

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

port?

Type: number (optional)

AWS::Neptune::DBCluster.Port.

preferredBackupWindow?

Type: string (optional)

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.

preferredMaintenanceWindow?

Type: string (optional)

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

restoreToTime?

Type: string (optional)

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.

restoreType?

Type: string (optional)

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.

serverlessScalingConfiguration?

Type: IResolvable | ServerlessScalingConfigurationProperty (optional)

AWS::Neptune::DBCluster.ServerlessScalingConfiguration.

snapshotIdentifier?

Type: string (optional)

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.

sourceDbClusterIdentifier?

Type: string (optional)

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.

storageEncrypted?

Type: boolean | IResolvable (optional)

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.

tags?

Type: CfnTag[] (optional)

The tags assigned to this cluster.

useLatestRestorableTime?

Type: boolean | IResolvable (optional)

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.

vpcSecurityGroupIds?

Type: string[] (optional)

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

← PreviousNext →