Class CfnDBClusterProps

Properties for defining a CfnDBCluster.

Inheritance

System.Object

CfnDBClusterProps

Implements

ICfnDBClusterProps

Namespace: Amazon.CDK.AWS.Neptune

Assembly: Amazon.CDK.AWS.Neptune.dll

Syntax (csharp)

public class CfnDBClusterProps : Object, ICfnDBClusterProps

Syntax (vb)

Public Class CfnDBClusterProps
    Inherits Object
    Implements ICfnDBClusterProps

Remarks

Link: 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",
    DbSubnetGroupName = "dbSubnetGroupName",
    DeletionProtection = false,
    EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
    EngineVersion = "engineVersion",
    IamAuthEnabled = false,
    KmsKeyId = "kmsKeyId",
    Port = 123,
    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

Constructors

CfnDBClusterProps()

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.
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.
IamAuthEnabled	True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
KmsKeyId	If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
Port	`AWS::Neptune::DBCluster.Port`.
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	`AWS::Neptune::DBCluster.ServerlessScalingConfiguration`.
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.

Constructors

CfnDBClusterProps()

public CfnDBClusterProps()

Properties

AssociatedRoles

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

public object AssociatedRoles { get; set; }

Property Value

System.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.

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

AvailabilityZones

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

public string[] AvailabilityZones { get; set; }

Property Value

System.String[]

Remarks

Link: 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.

public Nullable<double> BackupRetentionPeriod { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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

Link: 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..

public object CopyTagsToSnapshot { get; set; }

Property Value

System.Object

Remarks

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

DbClusterIdentifier

Contains a user-supplied DB cluster identifier.

public string DbClusterIdentifier { get; set; }

Property Value

System.String

Remarks

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

Link: 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.

public string DbClusterParameterGroupName { get; set; }

Property Value

System.String

Remarks

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

Link: 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.

public string DbInstanceParameterGroupName { get; set; }

Property Value

System.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.

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

DbSubnetGroupName

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

public string DbSubnetGroupName { get; set; }

Property Value

System.String

Remarks

Link: 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.

public object DeletionProtection { get; set; }

Property Value

System.Object

Remarks

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

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

EnableCloudwatchLogsExports

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

public string[] EnableCloudwatchLogsExports { get; set; }

Property Value

System.String[]

Remarks

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

EngineVersion

Indicates the database engine version.

public string EngineVersion { get; set; }

Property Value

System.String

Remarks

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

IamAuthEnabled

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

public object IamAuthEnabled { get; set; }

Property Value

System.Object

Remarks

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

KmsKeyId

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

public string KmsKeyId { get; set; }

Property Value

System.String

Remarks

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

Port

AWS::Neptune::DBCluster.Port.

public Nullable<double> Port { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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

PreferredBackupWindow

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

public string PreferredBackupWindow { get; set; }

Property Value

System.String

Remarks

An update may require some interruption.

Link: 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).

public string PreferredMaintenanceWindow { get; set; }

Property Value

System.String

Remarks

Link: 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.

public string RestoreToTime { get; set; }

Property Value

System.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.

Link: 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.

public string RestoreType { get; set; }

Property Value

System.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.

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

ServerlessScalingConfiguration

AWS::Neptune::DBCluster.ServerlessScalingConfiguration.

public object ServerlessScalingConfiguration { get; set; }

Property Value

System.Object

Remarks

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

SnapshotIdentifier

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

public string SnapshotIdentifier { get; set; }

Property Value

System.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.

Link: 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.

public string SourceDbClusterIdentifier { get; set; }

Property Value

System.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.

Link: 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.

public object StorageEncrypted { get; set; }

Property Value

System.Object

Remarks

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.

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

UseLatestRestorableTime

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

public object UseLatestRestorableTime { get; set; }

Property Value

System.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.

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

VpcSecurityGroupIds

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

public string[] VpcSecurityGroupIds { get; set; }

Property Value

System.String[]

Remarks

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

Implements

ICfnDBClusterProps