Class CfnDBCluster
A CloudFormation AWS::Neptune::DBCluster
.
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.AWS.Neptune.dll
Syntax (csharp)
public class CfnDBCluster : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBCluster
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Neptune::DBCluster
resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.
Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.
If no DeletionPolicy
is set for AWS::Neptune::DBCluster
resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy
should be set to Snapshot
. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute .
You can use AWS::Neptune::DBCluster.DeletionProtection
to help guard against unintended deletion of your DB cluster.
CloudformationResource: AWS::Neptune::DBCluster
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 cfnDBCluster = new CfnDBCluster(this, "MyCfnDBCluster", 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
CfnDBCluster(Construct, String, ICfnDBClusterProps) | Create a new |
CfnDBCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AssociatedRoles | Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. |
AttrClusterResourceId | The resource id for the DB cluster. |
AttrEndpoint | The connection endpoint for the DB cluster. |
AttrPort | The port number on which the DB cluster accepts connections. |
AttrReadEndpoint | The reader endpoint for 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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CopyTagsToSnapshot | If set to |
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 |
Port |
|
PreferredBackupWindow | Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the |
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 |
|
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBCluster(Construct, String, ICfnDBClusterProps)
Create a new AWS::Neptune::DBCluster
.
public CfnDBCluster(Construct scope, string id, ICfnDBClusterProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDBClusterProps
- resource properties.
CfnDBCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AssociatedRoles
Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
public virtual 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.
AttrClusterResourceId
The resource id for the DB cluster.
public virtual string AttrClusterResourceId { get; }
Property Value
System.String
Remarks
For example: cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
CloudformationAttribute: ClusterResourceId
AttrEndpoint
The connection endpoint for the DB cluster.
public virtual string AttrEndpoint { get; }
Property Value
System.String
Remarks
For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
CloudformationAttribute: Endpoint
AttrPort
The port number on which the DB cluster accepts connections.
public virtual string AttrPort { get; }
Property Value
System.String
Remarks
For example: 8182
.
CloudformationAttribute: Port
AttrReadEndpoint
The reader endpoint for the DB cluster.
public virtual string AttrReadEndpoint { get; }
Property Value
System.String
Remarks
For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
CloudformationAttribute: ReadEndpoint
AvailabilityZones
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
public virtual string[] AvailabilityZones { get; set; }
Property Value
System.String[]
Remarks
BackupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are retained.
public virtual 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.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CopyTagsToSnapshot
If set to true
, tags are copied to any snapshot of the DB cluster that is created..
public virtual object CopyTagsToSnapshot { get; set; }
Property Value
System.Object
Remarks
DbClusterIdentifier
Contains a user-supplied DB cluster identifier.
public virtual string DbClusterIdentifier { get; set; }
Property Value
System.String
Remarks
This identifier is the unique key that identifies a DB cluster.
DbClusterParameterGroupName
Provides the name of the DB cluster parameter group.
public virtual 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.
DbInstanceParameterGroupName
The name of the DB parameter group to apply to all instances of the DB cluster.
public virtual 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.
DbSubnetGroupName
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
public virtual string DbSubnetGroupName { get; set; }
Property Value
System.String
Remarks
DeletionProtection
Indicates whether or not the DB cluster has deletion protection enabled.
public virtual object DeletionProtection { get; set; }
Property Value
System.Object
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.
public virtual string[] EnableCloudwatchLogsExports { get; set; }
Property Value
System.String[]
Remarks
EngineVersion
Indicates the database engine version.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
IamAuthEnabled
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
public virtual object IamAuthEnabled { get; set; }
Property Value
System.Object
Remarks
KmsKeyId
If StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
Port
AWS::Neptune::DBCluster.Port
.
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
PreferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
.
public virtual string PreferredBackupWindow { get; set; }
Property Value
System.String
Remarks
An update may require some interruption.
PreferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
Remarks
RestoreToTime
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
public virtual 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.
RestoreType
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
public virtual 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.
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
AWS::Neptune::DBCluster.ServerlessScalingConfiguration
.
public virtual object ServerlessScalingConfiguration { get; set; }
Property Value
System.Object
Remarks
SnapshotIdentifier
Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
public virtual 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.
SourceDbClusterIdentifier
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
public virtual 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.
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.
public virtual 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.
Tags
The tags assigned to this cluster.
public virtual TagManager Tags { get; }
Property Value
Remarks
UseLatestRestorableTime
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
public virtual 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.
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.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>