Class CfnCluster
Creates a DAX cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.DAX
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 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",
NotificationTopicArn = "notificationTopicArn",
ParameterGroupName = "parameterGroupName",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
SecurityGroupIds = new [] { "securityGroupIds" },
SseSpecification = new SSESpecificationProperty {
SseEnabled = false
},
SubnetGroupName = "subnetGroupName",
Tags = tags
});
Synopsis
Constructors
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 |
CfnCluster(Construct, String, ICfnClusterProps) |
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 | |
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 | |
ClusterEndpointEncryptionType | The encryption type of the cluster's endpoint. |
ClusterName | The name of the DAX cluster. |
Description | The description of the cluster. |
IamRoleArn | A valid Amazon Resource Name (ARN) that identifies an IAM role. |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnCluster(Construct, String, ICfnClusterProps)
public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnClusterProps
Resource properties.
Properties
AttrArn
Returns the ARN of the DAX cluster. For example:.
public virtual string AttrArn { get; }
Property Value
System.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
System.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
System.String
Remarks
CloudformationAttribute: ClusterDiscoveryEndpointURL
AttrId
public virtual string AttrId { get; }
Property Value
System.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
System.String[]
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
ClusterEndpointEncryptionType
The encryption type of the cluster's endpoint.
public virtual string ClusterEndpointEncryptionType { get; set; }
Property Value
System.String
Remarks
Available values are:.
ClusterName
The name of the DAX cluster.
public virtual string ClusterName { get; set; }
Property Value
System.String
Description
The description of the cluster.
public virtual string Description { get; set; }
Property Value
System.String
IamRoleArn
A valid Amazon Resource Name (ARN) that identifies an IAM role.
public virtual string IamRoleArn { get; set; }
Property Value
System.String
NodeType
The node type for the nodes in the cluster.
public virtual string NodeType { get; set; }
Property Value
System.String
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
System.String
ParameterGroupName
The parameter group to be associated with the DAX cluster.
public virtual string ParameterGroupName { get; set; }
Property Value
System.String
PreferredMaintenanceWindow
A range of time when maintenance of DAX cluster software will be performed.
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
ReplicationFactor
The number of nodes in the DAX cluster.
public virtual double ReplicationFactor { get; set; }
Property Value
System.Double
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
System.String[]
SseSpecification
Represents the settings used to enable server-side encryption on the cluster.
public virtual object SseSpecification { get; set; }
Property Value
System.Object
SubnetGroupName
The name of the subnet group to be used for the replication group.
public virtual string SubnetGroupName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A set of tags to associate with the DAX cluster.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
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>