Class CfnCluster
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
Inherited Members
Namespace: Amazon.CDK.AWS.DocDBElastic
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCluster
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html
CloudformationResource: AWS::DocDBElastic::Cluster
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.DocDBElastic;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
AdminUserName = "adminUserName",
AuthType = "authType",
ClusterName = "clusterName",
ShardCapacity = 123,
ShardCount = 123,
// the properties below are optional
AdminUserPassword = "adminUserPassword",
BackupRetentionPeriod = 123,
KmsKeyId = "kmsKeyId",
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
ShardInstanceCount = 123,
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCluster(Construct, String, ICfnClusterProps) |
Properties
AdminUserName | The name of the Amazon DocumentDB elastic clusters administrator. |
AdminUserPassword | The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. |
AttrClusterArn | |
AttrClusterEndpoint | The URL used to connect to the elastic cluster. |
AuthType | The authentication type used to determine where to fetch the password used for accessing the elastic cluster. |
BackupRetentionPeriod | The number of days for which automatic snapshots are retained. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | The name of the new elastic cluster. |
KmsKeyId | The KMS key identifier to use to encrypt the new elastic cluster. |
PreferredBackupWindow | The daily time range during which automated backups are created if automated backups are enabled, as determined by |
PreferredMaintenanceWindow | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
ShardCapacity | The number of vCPUs assigned to each elastic cluster shard. |
ShardCount | The number of shards assigned to the elastic cluster. |
ShardInstanceCount | The number of replica instances applying to all shards in the cluster. |
SubnetIds | The Amazon EC2 subnet IDs for the new elastic cluster. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to be assigned to the new elastic cluster. |
VpcSecurityGroupIds | A list of EC2 VPC security groups to associate with the new elastic cluster. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCluster(Construct, String, ICfnClusterProps)
public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnClusterProps
Resource properties.
Properties
AdminUserName
The name of the Amazon DocumentDB elastic clusters administrator.
public virtual string AdminUserName { get; set; }
Property Value
System.String
AdminUserPassword
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
public virtual string AdminUserPassword { get; set; }
Property Value
System.String
AttrClusterArn
public virtual string AttrClusterArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterArn
AttrClusterEndpoint
The URL used to connect to the elastic cluster.
public virtual string AttrClusterEndpoint { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterEndpoint
AuthType
The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
public virtual string AuthType { get; set; }
Property Value
System.String
BackupRetentionPeriod
The number of days for which automatic snapshots are retained.
public virtual Nullable<double> BackupRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
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
ClusterName
The name of the new elastic cluster.
public virtual string ClusterName { get; set; }
Property Value
System.String
Remarks
This parameter is stored as a lowercase string.
KmsKeyId
The KMS key identifier to use to encrypt the new elastic cluster.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
PreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod
.
public virtual string PreferredBackupWindow { get; set; }
Property Value
System.String
PreferredMaintenanceWindow
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
ShardCapacity
The number of vCPUs assigned to each elastic cluster shard.
public virtual double ShardCapacity { get; set; }
Property Value
System.Double
ShardCount
The number of shards assigned to the elastic cluster.
public virtual double ShardCount { get; set; }
Property Value
System.Double
ShardInstanceCount
The number of replica instances applying to all shards in the cluster.
public virtual Nullable<double> ShardInstanceCount { get; set; }
Property Value
System.Nullable<System.Double>
SubnetIds
The Amazon EC2 subnet IDs for the new elastic cluster.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to be assigned to the new elastic cluster.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the new elastic cluster.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
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>