Class CfnCluster

Creates a DAX cluster.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCluster

Implements

IInspectable

IClusterRef

IConstruct

IDependable

IEnvironmentAware

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

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DAX

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCluster : CfnResource, IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnCluster Inherits CfnResource Implements IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::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.DAX;

             var tags;

             var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
                 IamRoleArn = "iamRoleArn",
                 NodeType = "nodeType",
                 ReplicationFactor = 123,

                 // the properties below are optional
                 AvailabilityZones = new [] { "availabilityZones" },
                 ClusterEndpointEncryptionType = "clusterEndpointEncryptionType",
                 ClusterName = "clusterName",
                 Description = "description",
                 NetworkType = "networkType",
                 NotificationTopicArn = "notificationTopicArn",
                 ParameterGroupName = "parameterGroupName",
                 PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SseSpecification = new SSESpecificationProperty {
                     SseEnabled = false
                 },
                 SubnetGroupName = "subnetGroupName",
                 Tags = tags
             });

Synopsis

Constructors

CfnCluster(Construct, string, ICfnClusterProps)

Create a new AWS::DAX::Cluster.

Properties

AttrArn	Returns the ARN of the DAX cluster. For example:.
AttrClusterDiscoveryEndpoint	Returns the endpoint of the DAX cluster. For example:.
AttrClusterDiscoveryEndpointUrl	Returns the endpoint URL of the DAX cluster.
AttrId	Creates a DAX cluster.
AvailabilityZones	The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a DAX cluster.
ClusterEndpointEncryptionType	The encryption type of the cluster's endpoint.
ClusterName	The name of the DAX cluster.
ClusterRef	A reference to a Cluster resource.
Description	The description of the cluster.
IamRoleArn	A valid Amazon Resource Name (ARN) that identifies an IAM role.
NetworkType	The IP address type of the cluster.
NodeType	The node type for the nodes in the cluster.
NotificationTopicArn	The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
ParameterGroupName	The parameter group to be associated with the DAX cluster.
PreferredMaintenanceWindow	A range of time when maintenance of DAX cluster software will be performed.
ReplicationFactor	The number of nodes in the DAX cluster.
SecurityGroupIds	A list of security group IDs to be assigned to each node in the DAX cluster.
SseSpecification	Represents the settings used to enable server-side encryption on the cluster.
SubnetGroupName	The name of the subnet group to be used for the replication group.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A set of tags to associate with the DAX cluster.

Methods

ArnForCluster(IClusterRef)	Creates a DAX cluster.
FromClusterArn(Construct, string, string)	Creates a new IClusterRef from an ARN.
FromClusterName(Construct, string, string)	Creates a new IClusterRef from a clusterName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnCluster(object)	Checks whether the given object is a CfnCluster.
RenderProperties(IDictionary<string, object>)	Creates a DAX cluster.

Constructors

CfnCluster(Construct, string, ICfnClusterProps)

Create a new AWS::DAX::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 DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

Properties

AttrArn

Returns the ARN of the DAX cluster. For example:.

public virtual string AttrArn { get; }

Property Value

string

Remarks

{ "Fn::GetAtt": [" MyDAXCluster ", "Arn"] }

Returns a value similar to the following:

arn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster

CloudformationAttribute: Arn

AttrClusterDiscoveryEndpoint

Returns the endpoint of the DAX cluster. For example:.

public virtual string AttrClusterDiscoveryEndpoint { get; }

Property Value

string

Remarks

{ "Fn::GetAtt": [" MyDAXCluster ", "ClusterDiscoveryEndpoint"] }

Returns a value similar to the following:

mydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111

CloudformationAttribute: ClusterDiscoveryEndpoint

AttrClusterDiscoveryEndpointUrl

Returns the endpoint URL of the DAX cluster.

public virtual string AttrClusterDiscoveryEndpointUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: ClusterDiscoveryEndpointURL

AttrId

Creates a DAX cluster.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AvailabilityZones

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.

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

Property Value

string[]

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::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

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

CfnProperties

Creates a DAX 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 DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

ClusterEndpointEncryptionType

The encryption type of the cluster's endpoint.

public virtual string? ClusterEndpointEncryptionType { get; set; }

Property Value

string

Remarks

Available values are:.

ClusterName

The name of the DAX cluster.

public virtual string? ClusterName { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

ClusterRef

A reference to a Cluster resource.

public virtual IClusterReference ClusterRef { get; }

Property Value

IClusterReference

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

Description

The description of the cluster.

public virtual string? Description { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

IamRoleArn

A valid Amazon Resource Name (ARN) that identifies an IAM role.

public virtual string IamRoleArn { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

NetworkType

The IP address type of the cluster.

public virtual string? NetworkType { get; set; }

Property Value

string

Remarks

Values are:.

NodeType

The node type for the nodes in the cluster.

public virtual string NodeType { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

NotificationTopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

public virtual string? NotificationTopicArn { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

ParameterGroupName

The parameter group to be associated with the DAX cluster.

public virtual string? ParameterGroupName { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

PreferredMaintenanceWindow

A range of time when maintenance of DAX cluster software will be performed.

public virtual string? PreferredMaintenanceWindow { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

ReplicationFactor

The number of nodes in the DAX cluster.

public virtual double ReplicationFactor { get; set; }

Property Value

double

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

SecurityGroupIds

A list of security group IDs to be assigned to each node in the DAX cluster.

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

Property Value

string[]

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

SseSpecification

Represents the settings used to enable server-side encryption on the cluster.

public virtual object? SseSpecification { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnCluster.ISSESpecificationProperty

SubnetGroupName

The name of the subnet group to be used for the replication group.

public virtual string? SubnetGroupName { get; set; }

Property Value

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

TagsRaw

A set of tags to associate with the DAX cluster.

public virtual object? TagsRaw { get; set; }

Property Value

object

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

Methods

ArnForCluster(IClusterRef)

Creates a DAX cluster.

public static string ArnForCluster(IClusterRef resource)

Parameters

resource IClusterRef

Returns

string

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::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.DAX;

             var tags;

             var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
                 IamRoleArn = "iamRoleArn",
                 NodeType = "nodeType",
                 ReplicationFactor = 123,

                 // the properties below are optional
                 AvailabilityZones = new [] { "availabilityZones" },
                 ClusterEndpointEncryptionType = "clusterEndpointEncryptionType",
                 ClusterName = "clusterName",
                 Description = "description",
                 NetworkType = "networkType",
                 NotificationTopicArn = "notificationTopicArn",
                 ParameterGroupName = "parameterGroupName",
                 PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SseSpecification = new SSESpecificationProperty {
                     SseEnabled = false
                 },
                 SubnetGroupName = "subnetGroupName",
                 Tags = tags
             });

FromClusterArn(Construct, string, string)

Creates a new IClusterRef from an ARN.

public static IClusterRef FromClusterArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IClusterRef

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

FromClusterName(Construct, string, string)

Creates a new IClusterRef from a clusterName.

public static IClusterRef FromClusterName(Construct scope, string id, string clusterName)

Parameters

scope Construct

id string

clusterName string

Returns

IClusterRef

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

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.

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

IsCfnCluster(object)

Checks whether the given object is a CfnCluster.

public static bool IsCfnCluster(object x)

Parameters

x object

Returns

bool

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a DAX cluster.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

All nodes in the cluster run the same DAX caching software.

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

CloudformationResource: AWS::DAX::Cluster

ExampleMetadata: fixture=_generated

Implements

IInspectable

IClusterRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable