Interface ICfnDBClusterProps

Properties for defining a CfnDBCluster.

Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnDBClusterProps
Syntax (vb)
Public Interface ICfnDBClusterProps
Remarks

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",
                 GlobalClusterIdentifier = "globalClusterIdentifier",
                 IamAuthEnabled = false,
                 KmsKeyId = "kmsKeyId",
                 NetworkType = "networkType",
                 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

AssociatedRoles

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

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

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

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

Contains a user-supplied DB cluster identifier.
DbClusterParameterGroupName

Provides the name of the DB cluster parameter group.
DbInstanceParameterGroupName

The name of the DB parameter group to apply to all instances of the DB cluster.
DbPort

The port number on which the DB instances in the DB cluster accept connections.
DbSubnetGroupName

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

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

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

Indicates the database engine version.
GlobalClusterIdentifier

The ID of the Neptune global database to which this new DB cluster should be added.
IamAuthEnabled

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
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 .
NetworkType

The network type of the DB cluster.
PreferredBackupWindow

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

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

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

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

Contains the scaling configuration of an Neptune Serverless DB cluster.
SnapshotIdentifier

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

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

Indicates whether the DB cluster is encrypted.
Tags

The tags assigned to this cluster.
UseLatestRestorableTime

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

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.

object? AssociatedRoles { get; }
Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-associatedroles

Type union: either IResolvable or (either IResolvable or CfnDBCluster.IDBClusterRoleProperty)[]

AvailabilityZones

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

string[]? AvailabilityZones { get; }
Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-availabilityzones

BackupRetentionPeriod

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

double? BackupRetentionPeriod { get; }
Property Value

double?

Remarks

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

Default: - 1

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-backupretentionperiod

CopyTagsToSnapshot

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

object? CopyTagsToSnapshot { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-copytagstosnapshot

Type union: either bool or IResolvable

DbClusterIdentifier

Contains a user-supplied DB cluster identifier.

string? DbClusterIdentifier { get; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusteridentifier

DbClusterParameterGroupName

Provides the name of the DB cluster parameter group.

string? DbClusterParameterGroupName { get; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusterparametergroupname

DbInstanceParameterGroupName

The name of the DB parameter group to apply to all instances of the DB cluster.

string? DbInstanceParameterGroupName { get; }
Property Value

string

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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbinstanceparametergroupname

    DbPort

    The port number on which the DB instances in the DB cluster accept connections.

    double? DbPort { get; }
    Property Value

    double?

    Remarks

    If not specified, the default port used is 8182 .

    The <code>Port</code> property will soon be deprecated. Please update existing templates to use the new <code>DBPort</code> property that has the same functionality.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbport

    DbSubnetGroupName

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

    string? DbSubnetGroupName { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbsubnetgroupname

    DeletionProtection

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

    object? DeletionProtection { get; }
    Property Value

    object

    Remarks

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

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-deletionprotection

    Type union: either bool or IResolvable

    EnableCloudwatchLogsExports

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

    string[]? EnableCloudwatchLogsExports { get; }
    Property Value

    string[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-enablecloudwatchlogsexports

    EngineVersion

    Indicates the database engine version.

    string? EngineVersion { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-engineversion

    GlobalClusterIdentifier

    The ID of the Neptune global database to which this new DB cluster should be added.

    string? GlobalClusterIdentifier { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-globalclusteridentifier

    IamAuthEnabled

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

    object? IamAuthEnabled { get; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-iamauthenabled

    Type union: either bool or IResolvable

    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 .

    object? KmsKeyId { get; }
    Property Value

    object

    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 .

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-kmskeyid

    Type union: either string or IKeyRef

    NetworkType

    The network type of the DB cluster.

    string? NetworkType { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-networktype

    PreferredBackupWindow

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

    string? PreferredBackupWindow { get; }
    Property Value

    string

    Remarks

    An update may require some interruption.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredbackupwindow

    PreferredMaintenanceWindow

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

    string? PreferredMaintenanceWindow { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredmaintenancewindow

    RestoreToTime

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

    string? RestoreToTime { get; }
    Property Value

    string

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretotime

    RestoreType

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

    string? RestoreType { get; }
    Property Value

    string

    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"

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretype

    ServerlessScalingConfiguration

    Contains the scaling configuration of an Neptune Serverless DB cluster.

    object? ServerlessScalingConfiguration { get; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-serverlessscalingconfiguration

    Type union: either IResolvable or CfnDBCluster.IServerlessScalingConfigurationProperty

    SnapshotIdentifier

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

    string? SnapshotIdentifier { get; }
    Property Value

    string

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier

    SourceDbClusterIdentifier

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

    string? SourceDbClusterIdentifier { get; }
    Property Value

    string

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-sourcedbclusteridentifier

    StorageEncrypted

    Indicates whether the DB cluster is encrypted.

    object? StorageEncrypted { get; }
    Property Value

    object

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-storageencrypted

    Type union: either bool or IResolvable

    Tags

    The tags assigned to this cluster.

    ICfnTag[]? Tags { get; }
    Property Value

    ICfnTag[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-tags

    UseLatestRestorableTime

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

    object? UseLatestRestorableTime { get; }
    Property Value

    object

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-uselatestrestorabletime

    Type union: either bool or IResolvable

    VpcSecurityGroupIds

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

    object[]? VpcSecurityGroupIds { get; }
    Property Value

    object[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-vpcsecuritygroupids

    Type union: (either string or ISecurityGroupRef)[]