Class CfnCluster
A CloudFormation AWS::DocDBElastic::Cluster
.
Inherited Members
Namespace: Amazon.CDK.AWS.DocDBElastic
Assembly: Amazon.CDK.AWS.DocDBElastic.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCluster
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
CloudformationResource: AWS::DocDBElastic::Cluster
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.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.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",
KmsKeyId = "kmsKeyId",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnCluster(Construct, String, ICfnClusterProps) | Create a new |
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 |
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 | |
AuthType | The authentication type used to determine where to fetch the password used for accessing the elastic cluster. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | The name of the new elastic cluster. This parameter is stored as a lowercase string. |
KmsKeyId | The KMS key identifier to use to encrypt the new elastic cluster. |
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. |
SubnetIds | The Amazon EC2 subnet IDs for the new elastic cluster. |
Tags | 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(Construct, String, ICfnClusterProps)
Create a new AWS::DocDBElastic::Cluster
.
public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnClusterProps
- resource properties.
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
Properties
AdminUserName
The name of the Amazon DocumentDB elastic clusters administrator.
public virtual string AdminUserName { get; set; }
Property Value
System.String
Remarks
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
Remarks
AttrClusterArn
public virtual string AttrClusterArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterArn
AttrClusterEndpoint
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
Remarks
Valid types are PLAIN_TEXT
or SECRET_ARN
.
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. This parameter is stored as a lowercase string.
public virtual string ClusterName { get; set; }
Property Value
System.String
Remarks
Constraints :
Example : my-cluster
KmsKeyId
The KMS key identifier to use to encrypt the new elastic cluster.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
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
Remarks
Format : ddd:hh24:mi-ddd:hh24:mi
Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints : Minimum 30-minute window.
ShardCapacity
The number of vCPUs assigned to each elastic cluster shard.
public virtual double ShardCapacity { get; set; }
Property Value
System.Double
Remarks
Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
ShardCount
The number of shards assigned to the elastic cluster.
public virtual double ShardCount { get; set; }
Property Value
System.Double
Remarks
SubnetIds
The Amazon EC2 subnet IDs for the new elastic cluster.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
Tags
The tags to be assigned to the new elastic cluster.
public virtual TagManager Tags { get; }
Property Value
Remarks
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[]
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>