Class DatabaseCluster
(experimental) Create a clustered database with a given number of instances.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.DocDB
Assembly: Amazon.CDK.AWS.DocDB.dll
Syntax (csharp)
public class DatabaseCluster : Resource, IDatabaseCluster, IResource, IConstruct, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget
Syntax (vb)
Public Class DatabaseCluster
Inherits Resource
Implements IDatabaseCluster, IResource, IConstruct, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget
Remarks
Stability: Experimental
Resource: AWS::DocDB::DBCluster
Synopsis
Constructors
DatabaseCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DatabaseCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
DatabaseCluster(Construct, String, IDatabaseClusterProps) |
Properties
ClusterEndpoint | (experimental) The endpoint to use for read/write operations. |
ClusterIdentifier | (experimental) Identifier of the cluster. |
ClusterReadEndpoint | (experimental) Endpoint to use for load-balanced read-only operations. |
ClusterResourceIdentifier | (experimental) The resource id for the cluster; |
Connections | (experimental) The connections object to implement IConectable. |
DEFAULT_NUM_INSTANCES | (experimental) The default number of instances in the DocDB cluster if none are specified. |
DEFAULT_PORT | (experimental) The default port Document DB listens on. |
InstanceEndpoints | (experimental) Endpoints which address each individual replica. |
InstanceIdentifiers | (experimental) Identifiers of the replicas. |
Secret | (experimental) The secret attached to this cluster. |
SecurityGroupId | (experimental) Security group identifier of this database. |
Methods
AddRotationMultiUser(String, IRotationMultiUserOptions) | (experimental) Adds the multi user rotation to this cluster. |
AddRotationSingleUser(Duration) | (experimental) Adds the single user rotation of the master password to this cluster. |
AsSecretAttachmentTarget() | (experimental) Renders the secret attachment target specifications. |
FromDatabaseClusterAttributes(Construct, String, IDatabaseClusterAttributes) | (experimental) Import an existing DatabaseCluster from properties. |
Constructors
DatabaseCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DatabaseCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DatabaseCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DatabaseCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
DatabaseCluster(Construct, String, IDatabaseClusterProps)
public DatabaseCluster(Construct scope, string id, IDatabaseClusterProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IDatabaseClusterProps
Remarks
Stability: Experimental
Properties
ClusterEndpoint
(experimental) The endpoint to use for read/write operations.
public virtual Endpoint ClusterEndpoint { get; }
Property Value
Remarks
Stability: Experimental
ClusterIdentifier
(experimental) Identifier of the cluster.
public virtual string ClusterIdentifier { get; }
Property Value
System.String
Remarks
Stability: Experimental
ClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.
public virtual Endpoint ClusterReadEndpoint { get; }
Property Value
Remarks
Stability: Experimental
ClusterResourceIdentifier
(experimental) The resource id for the cluster;
public virtual string ClusterResourceIdentifier { 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.
Stability: Experimental
Attribute: ClusterResourceId
Connections
(experimental) The connections object to implement IConectable.
public virtual Connections_ Connections { get; }
Property Value
Remarks
Stability: Experimental
DEFAULT_NUM_INSTANCES
(experimental) The default number of instances in the DocDB cluster if none are specified.
public static double DEFAULT_NUM_INSTANCES { get; }
Property Value
System.Double
Remarks
Stability: Experimental
DEFAULT_PORT
(experimental) The default port Document DB listens on.
public static double DEFAULT_PORT { get; }
Property Value
System.Double
Remarks
Stability: Experimental
InstanceEndpoints
(experimental) Endpoints which address each individual replica.
public virtual Endpoint[] InstanceEndpoints { get; }
Property Value
Endpoint[]
Remarks
Stability: Experimental
InstanceIdentifiers
(experimental) Identifiers of the replicas.
public virtual string[] InstanceIdentifiers { get; }
Property Value
System.String[]
Remarks
Stability: Experimental
Secret
(experimental) The secret attached to this cluster.
public virtual ISecret Secret { get; }
Property Value
Remarks
Stability: Experimental
SecurityGroupId
(experimental) Security group identifier of this database.
public virtual string SecurityGroupId { get; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
AddRotationMultiUser(String, IRotationMultiUserOptions)
(experimental) Adds the multi user rotation to this cluster.
public virtual SecretRotation AddRotationMultiUser(string id, IRotationMultiUserOptions options)
Parameters
- id System.String
- options IRotationMultiUserOptions
Returns
Remarks
Stability: Experimental
AddRotationSingleUser(Duration)
(experimental) Adds the single user rotation of the master password to this cluster.
public virtual SecretRotation AddRotationSingleUser(Duration automaticallyAfter = null)
Parameters
- automaticallyAfter Duration
Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
Returns
Remarks
Stability: Experimental
AsSecretAttachmentTarget()
(experimental) Renders the secret attachment target specifications.
public virtual ISecretAttachmentTargetProps AsSecretAttachmentTarget()
Returns
Remarks
Stability: Experimental
FromDatabaseClusterAttributes(Construct, String, IDatabaseClusterAttributes)
(experimental) Import an existing DatabaseCluster from properties.
public static IDatabaseCluster FromDatabaseClusterAttributes(Construct scope, string id, IDatabaseClusterAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs IDatabaseClusterAttributes
Returns
Remarks
Stability: Experimental