interface CfnDBClusterProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Neptune.CfnDBClusterProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsneptune#CfnDBClusterProps |
![]() | software.amazon.awscdk.services.neptune.CfnDBClusterProps |
![]() | aws_cdk.aws_neptune.CfnDBClusterProps |
![]() | aws-cdk-lib » aws_neptune » CfnDBClusterProps |
Properties for defining a CfnDBCluster
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_neptune as neptune } from 'aws-cdk-lib';
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',
dbPort: 123,
dbSubnetGroupName: 'dbSubnetGroupName',
deletionProtection: false,
enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
engineVersion: 'engineVersion',
iamAuthEnabled: false,
kmsKeyId: 'kmsKeyId',
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
Name | Type | Description |
---|---|---|
associated | IResolvable | IResolvable | DBCluster [] | Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. |
availability | string[] | Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. |
backup | number | Specifies the number of days for which automatic DB snapshots are retained. |
copy | boolean | IResolvable | If set to true , tags are copied to any snapshot of the DB cluster that is created.. |
db | string | Contains a user-supplied DB cluster identifier. |
db | string | Provides the name of the DB cluster parameter group. |
db | string | The name of the DB parameter group to apply to all instances of the DB cluster. |
db | number | The port number on which the DB instances in the DB cluster accept connections. |
db | string | Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. |
deletion | boolean | IResolvable | Indicates whether or not the DB cluster has deletion protection enabled. |
enable | string[] | Specifies a list of log types that are enabled for export to CloudWatch Logs. |
engine | string | Indicates the database engine version. |
iam | boolean | IResolvable | True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. |
kms | string | The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef . |
preferred | string | Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod . |
preferred | string | Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
restore | string | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
restore | string | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
serverless | IResolvable | Serverless | Contains the scaling configuration of an Neptune Serverless DB cluster. |
snapshot | string | Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. |
source | string | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
storage | boolean | IResolvable | Indicates whether the DB cluster is encrypted. |
tags? | Cfn [] | The tags assigned to this cluster. |
use | boolean | IResolvable | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
vpc | string[] | Provides a list of VPC security groups that the DB cluster belongs to. |
associatedRoles?
Type:
IResolvable
|
IResolvable
|
DBCluster
[]
(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, default: 1)
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.
dbPort?
Type:
number
(optional)
The port number on which the DB instances in the DB cluster accept connections.
If not specified, the default port used is 8182
.
The
Port
property will soon be deprecated. Please update existing templates to use the newDBPort
property that has the same functionality.
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)
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
.
If you enable the StorageEncrypted
property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted
property to true
.
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, default: "full-copy")
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
|
Serverless
(optional)
Contains the scaling configuration of an Neptune Serverless DB cluster.
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 KmsKeyId
property, then you must enable encryption and set this property to true
.
If you enable the StorageEncrypted
property but don't specify the KmsKeyId
property, then the default KMS key is used. If you specify the KmsKeyId
property, then that KMS key is used to encrypt the database instances in the DB cluster.
If you specify the SourceDBClusterIdentifier
property, and don't specify this property or disable it, the value is inherited from the source DB cluster. If the source DB cluster is encrypted, the KmsKeyId
property from the source cluster is used.
If you specify the DBSnapshotIdentifier
and don't specify this property or disable it, the value is inherited from the snapshot and the specified KmsKeyId
property from the snapshot is used.
tags?
Type:
Cfn
[]
(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.