Interface ICfnDBClusterProps
Properties for defining a CfnDBCluster.
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnDBClusterPropsSyntax (vb)
Public Interface ICfnDBClusterPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Neptune;
var cfnDBClusterProps = new CfnDBClusterProps {
AssociatedRoles = new [] { new DBClusterRoleProperty {
RoleArn = "roleArn",
// the properties below are optional
FeatureName = "featureName"
} },
AvailabilityZones = new [] { "availabilityZones" },
BackupRetentionPeriod = 123,
CopyTagsToSnapshot = false,
DbClusterIdentifier = "dbClusterIdentifier",
DbClusterParameterGroupName = "dbClusterParameterGroupName",
DbInstanceParameterGroupName = "dbInstanceParameterGroupName",
DbPort = 123,
DbSubnetGroupName = "dbSubnetGroupName",
DeletionProtection = false,
EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
EngineVersion = "engineVersion",
IamAuthEnabled = false,
KmsKeyId = "kmsKeyId",
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
RestoreToTime = "restoreToTime",
RestoreType = "restoreType",
ServerlessScalingConfiguration = new ServerlessScalingConfigurationProperty {
MaxCapacity = 123,
MinCapacity = 123
},
SnapshotIdentifier = "snapshotIdentifier",
SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
StorageEncrypted = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UseLatestRestorableTime = false,
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
};Synopsis
Properties
| Associated |
Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. |
| Availability |
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. |
| Backup |
Specifies the number of days for which automatic DB snapshots are retained. |
| Copy |
If set to |
| Db |
Contains a user-supplied DB cluster identifier. |
| Db |
Provides the name of the DB cluster parameter group. |
| Db |
The name of the DB parameter group to apply to all instances of the DB cluster. |
| Db |
The port number on which the DB instances in the DB cluster accept connections. |
| Db |
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. |
| Deletion |
Indicates whether or not the DB cluster has deletion protection enabled. |
| Enable |
Specifies a list of log types that are enabled for export to CloudWatch Logs. |
| Engine |
Indicates the database engine version. |
| Iam |
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. |
| Kms |
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as |
| Preferred |
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the |
| Preferred |
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
| Restore |
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
| Restore |
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
| Serverless |
Contains the scaling configuration of an Neptune Serverless DB cluster. |
| Snapshot |
Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. |
| Source |
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
| Storage |
Indicates whether the DB cluster is encrypted. |
| Tags | The tags assigned to this cluster. |
| Use |
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
| Vpc |
Provides a list of VPC security groups that the DB cluster belongs to. |
Properties
AssociatedRoles
Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
virtual object AssociatedRoles { get; }Property Value
System.
Remarks
IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.
AvailabilityZones
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
virtual string[] AvailabilityZones { get; }Property Value
System.
Remarks
BackupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are retained.
virtual Nullable<double> BackupRetentionPeriod { get; }Property Value
System.
Remarks
An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.
Default: - 1
CopyTagsToSnapshot
If set to true , tags are copied to any snapshot of the DB cluster that is created..
virtual object CopyTagsToSnapshot { get; }Property Value
System.
Remarks
DbClusterIdentifier
Contains a user-supplied DB cluster identifier.
virtual string DbClusterIdentifier { get; }Property Value
System.
Remarks
This identifier is the unique key that identifies a DB cluster.
DbClusterParameterGroupName
Provides the name of the DB cluster parameter group.
virtual string DbClusterParameterGroupName { get; }Property Value
System.
Remarks
An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.
DbInstanceParameterGroupName
The name of the DB parameter group to apply to all instances of the DB cluster.
virtual string DbInstanceParameterGroupName { get; }Property Value
System.
Remarks
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.
DbPort
The port number on which the DB instances in the DB cluster accept connections.
virtual Nullable<double> DbPort { get; }Property Value
System.
Remarks
If not specified, the default port used is 8182 .
The Port property will soon be deprecated. Please update existing templates to use the new DBPort property that has the same functionality.
DbSubnetGroupName
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
virtual string DbSubnetGroupName { get; }Property Value
System.
Remarks
DeletionProtection
Indicates whether or not the DB cluster has deletion protection enabled.
virtual object DeletionProtection { get; }Property Value
System.
Remarks
The database can't be deleted when deletion protection is enabled.
EnableCloudwatchLogsExports
Specifies a list of log types that are enabled for export to CloudWatch Logs.
virtual string[] EnableCloudwatchLogsExports { get; }Property Value
System.
Remarks
EngineVersion
Indicates the database engine version.
virtual string EngineVersion { get; }Property Value
System.
Remarks
IamAuthEnabled
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
virtual object IamAuthEnabled { get; }Property Value
System.
Remarks
KmsKeyId
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 .
virtual string KmsKeyId { get; }Property Value
System.
Remarks
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
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
virtual string PreferredBackupWindow { get; }Property Value
System.
Remarks
An update may require some interruption.
PreferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
virtual string PreferredMaintenanceWindow { get; }Property Value
System.
Remarks
RestoreToTime
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
virtual string RestoreToTime { get; }Property Value
System.
Remarks
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
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
virtual string RestoreType { get; }Property Value
System.
Remarks
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.
Default: - "full-copy"
ServerlessScalingConfiguration
Contains the scaling configuration of an Neptune Serverless DB cluster.
virtual object ServerlessScalingConfiguration { get; }Property Value
System.
Remarks
SnapshotIdentifier
Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
virtual string SnapshotIdentifier { get; }Property Value
System.
Remarks
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
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
virtual string SourceDbClusterIdentifier { get; }Property Value
System.
Remarks
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
Indicates whether the DB cluster is encrypted.
virtual object StorageEncrypted { get; }Property Value
System.
Remarks
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
UseLatestRestorableTime
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
virtual object UseLatestRestorableTime { get; }Property Value
System.
Remarks
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
Provides a list of VPC security groups that the DB cluster belongs to.
virtual string[] VpcSecurityGroupIds { get; }Property Value
System.