Class Cluster

Provides a DAX Cluster resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var bar = new Aws.Dax.Cluster("bar", new Aws.Dax.ClusterArgs
    {
        ClusterName = "cluster-example",
        IamRoleArn = data.Aws_iam_role.Example.Arn,
        NodeType = "dax.r4.large",
        ReplicationFactor = 1,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Cluster

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Dax

Assembly: Pulumi.Aws.dll

Syntax

public class Cluster : CustomResource

Constructors

Cluster(String, ClusterArgs, CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

Declaration

public Cluster(string name, ClusterArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The ARN of the DAX cluster

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AvailabilityZones

List of Availability Zones in which the nodes will be created

Declaration

public Output<ImmutableArray<string>> AvailabilityZones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ClusterAddress

The DNS name of the DAX cluster without the port appended

Declaration

public Output<string> ClusterAddress { get; }

Property Value

Type	Description
Output<System.String>

ClusterName

Group identifier. DAX converts this name to lowercase

Declaration

public Output<string> ClusterName { get; }

Property Value

Type	Description
Output<System.String>

ConfigurationEndpoint

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

Declaration

public Output<string> ConfigurationEndpoint { get; }

Property Value

Type	Description
Output<System.String>

Description

Description for the cluster

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

IamRoleArn

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf

Declaration

public Output<string> IamRoleArn { get; }

Property Value

Type	Description
Output<System.String>

MaintenanceWindow

Specifies the weekly time range for when maintenance on the cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:05:00-sun:09:00

Declaration

public Output<string> MaintenanceWindow { get; }

Property Value

Type	Description
Output<System.String>

Nodes

List of node objects including id, address, port and availability_zone. Referenceable e.g. as ${aws_dax_cluster.test.nodes.0.address}

Declaration

public Output<ImmutableArray<ClusterNode>> Nodes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ClusterNode>>

NodeType

The compute and memory capacity of the nodes. See Nodes for supported node types

Declaration

public Output<string> NodeType { get; }

Property Value

Type	Description
Output<System.String>

NotificationTopicArn

An Amazon Resource Name (ARN) of an SNS topic to send DAX notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic

Declaration

public Output<string> NotificationTopicArn { get; }

Property Value

Type	Description
Output<System.String>

ParameterGroupName

Name of the parameter group to associate with this DAX cluster

Declaration

public Output<string> ParameterGroupName { get; }

Property Value

Type	Description
Output<System.String>

Port

The port used by the configuration endpoint

Declaration

public Output<int> Port { get; }

Property Value

Type	Description
Output<System.Int32>

ReplicationFactor

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

Declaration

public Output<int> ReplicationFactor { get; }

Property Value

Type	Description
Output<System.Int32>

SecurityGroupIds

One or more VPC security groups associated with the cluster

Declaration

public Output<ImmutableArray<string>> SecurityGroupIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ServerSideEncryption

Encrypt at rest options

Declaration

public Output<ClusterServerSideEncryption> ServerSideEncryption { get; }

Property Value

Type	Description
Output<ClusterServerSideEncryption>

SubnetGroupName

Name of the subnet group to be used for the cluster

Declaration

public Output<string> SubnetGroupName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, ClusterState, CustomResourceOptions)

Get an existing Cluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Cluster Get(string name, Input<string> id, ClusterState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Cluster