Class CfnCluster

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

CfnElement

CfnRefElement

CfnResource

CfnCluster

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.MemoryDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCluster : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnCluster Inherits CfnResource Implements IInspectable, ITaggable

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::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.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",
                 Engine = "engine",
                 EngineVersion = "engineVersion",
                 FinalSnapshotName = "finalSnapshotName",
                 IpDiscovery = "ipDiscovery",
                 KmsKeyId = "kmsKeyId",
                 MaintenanceWindow = "maintenanceWindow",
                 MultiRegionClusterName = "multiRegionClusterName",
                 NetworkType = "networkType",
                 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)

Specifies a cluster .

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 `Ref` function, Ref returns the ARN of the cluster , such as `arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster`.
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 `active` or `applying` .
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	Specifies a cluster .
ClusterEndpoint	The cluster 's configuration endpoint.
ClusterName	The name of the cluster .
DataTiering	Enables data tiering.
Description	A description of the cluster .
Engine	The name of the engine used by the cluster.
EngineVersion	The Redis engine version used by the cluster .
FinalSnapshotName	The user-supplied name of a final cluster snapshot.
IpDiscovery	The mechanism that the cluster uses to discover IP addresses.
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.
MultiRegionClusterName	The name of the multi-Region cluster that this cluster belongs to.
NetworkType	The IP address type for the cluster.
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 `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
SnsTopicStatus	The SNS topic must be in Active status to receive notifications.
SubnetGroupName	The name of the subnet group used by the cluster .
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	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>)	Specifies a cluster .

Constructors

CfnCluster(Construct, string, ICfnClusterProps)

Specifies a cluster .

public CfnCluster(Construct scope, string id, ICfnClusterProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnClusterProps: Resource properties.

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

Properties

AclName

The name of the Access Control List to associate with the cluster .

public virtual string AclName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

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

Remarks

CloudformationAttribute: ARN

AttrClusterEndpointAddress

The address of the cluster 's configuration endpoint.

public virtual string AttrClusterEndpointAddress { get; }

Property Value

Remarks

CloudformationAttribute: ClusterEndpoint.Address

AttrClusterEndpointPort

The port used by the cluster configuration endpoint.

public virtual double AttrClusterEndpointPort { get; }

Property Value

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

Remarks

CloudformationAttribute: ParameterGroupStatus

AttrStatus

The status of the cluster.

public virtual string AttrStatus { get; }

Property Value

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a cluster .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

ClusterEndpoint

The cluster 's configuration endpoint.

public virtual object? ClusterEndpoint { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

ClusterName

The name of the cluster .

public virtual string ClusterName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

DataTiering

Enables data tiering.

public virtual string? DataTiering { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

Description

A description of the cluster .

public virtual string? Description { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

Engine

The name of the engine used by the cluster.

public virtual string? Engine { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

EngineVersion

The Redis engine version used by the cluster .

public virtual string? EngineVersion { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

FinalSnapshotName

The user-supplied name of a final cluster snapshot.

public virtual string? FinalSnapshotName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

IpDiscovery

The mechanism that the cluster uses to discover IP addresses.

public virtual string? IpDiscovery { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

KmsKeyId

The ID of the KMS key used to encrypt the cluster .

public virtual string? KmsKeyId { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

MaintenanceWindow

Specifies the weekly time range during which maintenance on the cluster is performed.

public virtual string? MaintenanceWindow { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

MultiRegionClusterName

The name of the multi-Region cluster that this cluster belongs to.

public virtual string? MultiRegionClusterName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

NetworkType

The IP address type for the cluster.

public virtual string? NetworkType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

NodeType

The cluster 's node type.

public virtual string NodeType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

NumReplicasPerShard

The number of replicas to apply to each shard.

public virtual double? NumReplicasPerShard { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

NumShards

The number of shards in the cluster .

public virtual double? NumShards { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

ParameterGroupName

The name of the parameter group used by the cluster .

public virtual string? ParameterGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

Port

The port used by the cluster .

public virtual double? Port { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

SecurityGroupIds

A list of security group names to associate with this cluster .

public virtual string[]? SecurityGroupIds { get; set; }

Property Value

string[]

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

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

string[]

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

SnapshotName

The name of a snapshot from which to restore data into the new cluster .

public virtual string? SnapshotName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

SnapshotRetentionLimit

The number of days for which MemoryDB retains automatic snapshots before deleting them.

public virtual double? SnapshotRetentionLimit { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

SnsTopicStatus

The SNS topic must be in Active status to receive notifications.

public virtual string? SnsTopicStatus { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

SubnetGroupName

The name of the subnet group used by the cluster .

public virtual string? SubnetGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

All nodes in the cluster run the same protocol-compliant engine software.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

CloudformationResource: AWS::MemoryDB::Cluster

ExampleMetadata: fixture=_generated

TlsEnabled

A flag to indicate if In-transit encryption is enabled.

public virtual object? TlsEnabled { get; set; }

Property Value