Interface ICfnClusterProps
Properties for defining a CfnCluster
.
Namespace: Amazon.CDK.AWS.DocDBElastic
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnClusterProps
Syntax (vb)
Public Interface ICfnClusterProps
Remarks
See: 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",
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
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. |
BackupRetentionPeriod | The number of days for which automatic snapshots are retained. |
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. |
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 | 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. |
Properties
AdminUserName
The name of the Amazon DocumentDB elastic clusters administrator.
string AdminUserName { get; }
Property Value
System.String
Remarks
AdminUserPassword
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
virtual string AdminUserPassword { get; }
Property Value
System.String
Remarks
AuthType
The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
string AuthType { get; }
Property Value
System.String
Remarks
Valid types are PLAIN_TEXT
or SECRET_ARN
.
BackupRetentionPeriod
The number of days for which automatic snapshots are retained.
virtual Nullable<double> BackupRetentionPeriod { get; }
Property Value
System.Nullable<System.Double>
Remarks
ClusterName
The name of the new elastic cluster. This parameter is stored as a lowercase string.
string ClusterName { get; }
Property Value
System.String
Remarks
Constraints :
Example : my-cluster
KmsKeyId
The KMS key identifier to use to encrypt the new elastic cluster.
virtual string KmsKeyId { get; }
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.
PreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod
.
virtual string PreferredBackupWindow { get; }
Property Value
System.String
Remarks
PreferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
virtual string PreferredMaintenanceWindow { get; }
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.
double ShardCapacity { get; }
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.
double ShardCount { get; }
Property Value
System.Double
Remarks
ShardInstanceCount
The number of replica instances applying to all shards in the cluster.
virtual Nullable<double> ShardInstanceCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
A shardInstanceCount
value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
SubnetIds
The Amazon EC2 subnet IDs for the new elastic cluster.
virtual string[] SubnetIds { get; }
Property Value
System.String[]
Remarks
Tags
The tags to be assigned to the new elastic cluster.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
VpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the new elastic cluster.
virtual string[] VpcSecurityGroupIds { get; }
Property Value
System.String[]