Class CfnCluster
A CloudFormation AWS::MemoryDB::Cluster
.
Inherited Members
Namespace: Amazon.CDK.AWS.MemoryDB
Assembly: Amazon.CDK.AWS.MemoryDB.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCluster
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a cluster . All nodes in the cluster run the same protocol-compliant engine software.
CloudformationResource: AWS::MemoryDB::Cluster
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-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.MemoryDB;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
AclName = "aclName",
ClusterName = "clusterName",
NodeType = "nodeType",
// the properties below are optional
AutoMinorVersionUpgrade = false,
ClusterEndpoint = new EndpointProperty {
Address = "address",
Port = 123
},
DataTiering = "dataTiering",
Description = "description",
EngineVersion = "engineVersion",
FinalSnapshotName = "finalSnapshotName",
KmsKeyId = "kmsKeyId",
MaintenanceWindow = "maintenanceWindow",
NumReplicasPerShard = 123,
NumShards = 123,
ParameterGroupName = "parameterGroupName",
Port = 123,
SecurityGroupIds = new [] { "securityGroupIds" },
SnapshotArns = new [] { "snapshotArns" },
SnapshotName = "snapshotName",
SnapshotRetentionLimit = 123,
SnapshotWindow = "snapshotWindow",
SnsTopicArn = "snsTopicArn",
SnsTopicStatus = "snsTopicStatus",
SubnetGroupName = "subnetGroupName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TlsEnabled = false
});
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
AclName | The name of the Access Control List to associate with the cluster . |
AttrArn | When you pass the logical ID of this resource to the intrinsic |
AttrClusterEndpointAddress | The address of the cluster 's configuration endpoint. |
AttrClusterEndpointPort | The port used by the cluster configuration endpoint. |
AttrParameterGroupStatus | The status of the parameter group used by the cluster , for example |
AttrStatus | The status of the cluster. |
AutoMinorVersionUpgrade | When set to true, the cluster will automatically receive minor engine version upgrades after launch. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterEndpoint | The cluster 's configuration endpoint. |
ClusterName | The name of the cluster . |
DataTiering | Enables data tiering. |
Description | A description of the cluster . |
EngineVersion | The Redis engine version used by the cluster . |
FinalSnapshotName | The user-supplied name of a final cluster snapshot. |
KmsKeyId | The ID of the KMS key used to encrypt the cluster . |
MaintenanceWindow | Specifies the weekly time range during which maintenance on the cluster is performed. |
NodeType | The cluster 's node type. |
NumReplicasPerShard | The number of replicas to apply to each shard. |
NumShards | The number of shards in the cluster . |
ParameterGroupName | The name of the parameter group used by the cluster . |
Port | The port used by the cluster . |
SecurityGroupIds | A list of security group names to associate with this cluster . |
SnapshotArns | A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. |
SnapshotName | The name of a snapshot from which to restore data into the new cluster . |
SnapshotRetentionLimit | The number of days for which MemoryDB retains automatic snapshots before deleting them. |
SnapshotWindow | The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. |
SnsTopicArn | When you pass the logical ID of this resource to the intrinsic |
SnsTopicStatus | The SNS topic must be in Active status to receive notifications. |
SubnetGroupName | The name of the subnet group used by the cluster . |
Tags | An array of key-value pairs to apply to this resource. |
TlsEnabled | A flag to indicate if In-transit encryption is enabled. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCluster(Construct, String, ICfnClusterProps)
Create a new AWS::MemoryDB::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
AclName
The name of the Access Control List to associate with the cluster .
public virtual string AclName { get; set; }
Property Value
System.String
Remarks
AttrArn
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref returns the ARN of the cluster , such as arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ARN
AttrClusterEndpointAddress
The address of the cluster 's configuration endpoint.
public virtual string AttrClusterEndpointAddress { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterEndpoint.Address
AttrClusterEndpointPort
The port used by the cluster configuration endpoint.
public virtual double AttrClusterEndpointPort { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: ClusterEndpoint.Port
AttrParameterGroupStatus
The status of the parameter group used by the cluster , for example active
or applying
.
public virtual string AttrParameterGroupStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ParameterGroupStatus
AttrStatus
The status of the cluster.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
For example, 'available', 'updating' or 'creating'.
CloudformationAttribute: Status
AutoMinorVersionUpgrade
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
public virtual object AutoMinorVersionUpgrade { get; set; }
Property Value
System.Object
Remarks
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
ClusterEndpoint
The cluster 's configuration endpoint.
public virtual object ClusterEndpoint { get; set; }
Property Value
System.Object
Remarks
ClusterName
The name of the cluster .
public virtual string ClusterName { get; set; }
Property Value
System.String
Remarks
DataTiering
Enables data tiering.
public virtual string DataTiering { get; set; }
Property Value
System.String
Remarks
Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .
Description
A description of the cluster .
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EngineVersion
The Redis engine version used by the cluster .
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
FinalSnapshotName
The user-supplied name of a final cluster snapshot.
public virtual string FinalSnapshotName { get; set; }
Property Value
System.String
Remarks
This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
KmsKeyId
The ID of the KMS key used to encrypt the cluster .
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
MaintenanceWindow
Specifies the weekly time range during which maintenance on the cluster is performed.
public virtual string MaintenanceWindow { get; set; }
Property Value
System.String
Remarks
It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
(24H Clock UTC). The minimum maintenance window is a 60 minute period.
Pattern : ddd:hh24:mi-ddd:hh24:mi
NodeType
The cluster 's node type.
public virtual string NodeType { get; set; }
Property Value
System.String
Remarks
NumReplicasPerShard
The number of replicas to apply to each shard.
public virtual Nullable<double> NumReplicasPerShard { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default value : 1
Maximum value : 5
NumShards
The number of shards in the cluster .
public virtual Nullable<double> NumShards { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
ParameterGroupName
The name of the parameter group used by the cluster .
public virtual string ParameterGroupName { get; set; }
Property Value
System.String
Remarks
Port
The port used by the cluster .
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
SecurityGroupIds
A list of security group names to associate with this cluster .
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
SnapshotArns
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
public virtual string[] SnapshotArns { get; set; }
Property Value
System.String[]
Remarks
The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
SnapshotName
The name of a snapshot from which to restore data into the new cluster .
public virtual string SnapshotName { get; set; }
Property Value
System.String
Remarks
The snapshot status changes to restoring while the new cluster is being created.
SnapshotRetentionLimit
The number of days for which MemoryDB retains automatic snapshots before deleting them.
public virtual Nullable<double> SnapshotRetentionLimit { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
SnapshotWindow
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
public virtual string SnapshotWindow { get; set; }
Property Value
System.String
Remarks
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
SnsTopicArn
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic
.
public virtual string SnsTopicArn { get; set; }
Property Value
System.String
Remarks
SnsTopicStatus
The SNS topic must be in Active status to receive notifications.
public virtual string SnsTopicStatus { get; set; }
Property Value
System.String
Remarks
SubnetGroupName
The name of the subnet group used by the cluster .
public virtual string SubnetGroupName { get; set; }
Property Value
System.String
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
TlsEnabled
A flag to indicate if In-transit encryption is enabled.
public virtual object TlsEnabled { get; set; }
Property Value
System.Object
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>