Class CfnClusterProps

Properties for defining a CfnCluster.

Inheritance

System.Object

CfnClusterProps

Implements

ICfnClusterProps

Namespace: Amazon.CDK.AWS.DocDBElastic

Assembly: Amazon.CDK.AWS.DocDBElastic.dll

Syntax (csharp)

public class CfnClusterProps : Object, ICfnClusterProps

Syntax (vb)

Public Class CfnClusterProps
    Inherits Object
    Implements ICfnClusterProps

Remarks

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 cfnClusterProps = 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

CfnClusterProps()

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.
AuthType	The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
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.

Constructors

CfnClusterProps()

public CfnClusterProps()

Properties

AdminUserName

The name of the Amazon DocumentDB elastic clusters administrator.

public string AdminUserName { get; set; }

Property Value

System.String

Remarks

Constraints :

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminusername

AdminUserPassword

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

public string AdminUserPassword { get; set; }

Property Value

System.String

Remarks

Constraints :

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminuserpassword

AuthType

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

public string AuthType { get; set; }

Property Value

System.String

Remarks

Valid types are PLAIN_TEXT or SECRET_ARN .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-authtype

ClusterName

The name of the new elastic cluster. This parameter is stored as a lowercase string.

public string ClusterName { get; set; }

Property Value

System.String

Remarks

Constraints :

Example : my-cluster

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-clustername

KmsKeyId

The KMS key identifier to use to encrypt the new elastic cluster.

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

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

PreferredMaintenanceWindow

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredmaintenancewindow

ShardCapacity

The number of vCPUs assigned to each elastic cluster shard.

public double ShardCapacity { get; set; }

Property Value

System.Double

Remarks

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcapacity

ShardCount

The number of shards assigned to the elastic cluster.

public double ShardCount { get; set; }

Property Value

System.Double

Remarks

Maximum is 32.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcount

SubnetIds

The Amazon EC2 subnet IDs for the new elastic cluster.

public string[] SubnetIds { get; set; }

Property Value

System.String[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-subnetids

VpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the new elastic cluster.

public string[] VpcSecurityGroupIds { get; set; }

Property Value

System.String[]

Remarks

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

Implements

ICfnClusterProps