Cluster class
Provides a DAX Cluster resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const bar = new aws.dax.Cluster("bar", {
clusterName: "cluster-example",
iamRoleArn: example.arn,
nodeType: "dax.r4.large",
replicationFactor: 1,
});
import pulumi
import pulumi_aws as aws
bar = aws.dax.Cluster("bar",
cluster_name="cluster-example",
iam_role_arn=example["arn"],
node_type="dax.r4.large",
replication_factor=1)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var bar = new Aws.Dax.Cluster("bar", new()
{
ClusterName = "cluster-example",
IamRoleArn = example.Arn,
NodeType = "dax.r4.large",
ReplicationFactor = 1,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dax"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dax.NewCluster(ctx, "bar", &dax.ClusterArgs{
ClusterName: pulumi.String("cluster-example"),
IamRoleArn: pulumi.Any(example.Arn),
NodeType: pulumi.String("dax.r4.large"),
ReplicationFactor: pulumi.Int(1),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dax_cluster" "bar" {
cluster_name = "cluster-example"
iam_role_arn = example.arn
node_type = "dax.r4.large"
replication_factor = 1
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dax.Cluster;
import com.pulumi.aws.dax.ClusterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var bar = new Cluster("bar", ClusterArgs.builder()
.clusterName("cluster-example")
.iamRoleArn(example.arn())
.nodeType("dax.r4.large")
.replicationFactor(1)
.build());
}
}
resources:
bar:
type: aws:dax:Cluster
properties:
clusterName: cluster-example
iamRoleArn: ${example.arn}
nodeType: dax.r4.large
replicationFactor: 1
Import
Using pulumi import, import DAX Clusters using the clusterName. For example:
$ pulumi import aws:dax/cluster:Cluster my_cluster my_cluster
Constructors
- Cluster(String name, {ClusterArgs? args, CustomResourceOptions? options})
-
Creates a new Cluster.
nameThe Pulumi resource name.argsArguments used to configure this Cluster. The set of arguments for Cluster.optionsResource options controlling this resource's behavior. - Cluster.reference(String urn)
- Creates a typed reference to an existing Cluster resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the DAX cluster
latefinal
-
availabilityZones
↔ Output<
List< String> ?> -
List of Availability Zones in which the
nodes will be created
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
clusterAddress
↔ Output<
String> -
The DNS name of the DAX cluster without the port appended
latefinal
-
clusterEndpointEncryptionType
↔ Output<
String?> -
The type of encryption the
cluster's endpoint should support. Valid values are:
NONEandTLS. Default value isNONE.latefinal -
clusterName
↔ Output<
String> -
Group identifier. DAX converts this name to
lowercase
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configurationEndpoint
↔ Output<
String> -
The configuration endpoint for this DAX cluster,
consisting of a DNS name and a port number
latefinal
-
description
↔ Output<
String?> -
Description for the cluster
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
iamRoleArn
↔ Output<
String> -
Valid 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
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
maintenanceWindow
↔ Output<
String> -
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:00latefinal -
nodes
↔ Output<
List< ClusterNode> > -
List of node objects including
id,address,portandavailabilityZone. Referenceable e.g., as${aws_dax_cluster.test.nodes.0.address}latefinal -
nodeType
↔ Output<
String> -
The compute and memory capacity of the nodes. See
Nodes for supported node types
latefinal
-
notificationTopicArn
↔ Output<
String?> -
ARN of an
SNS topic to send DAX notifications to. Example:
arn:aws:sns:us-east-1:012345678999:my_sns_topiclatefinal -
parameterGroupName
↔ Output<
String> -
Name of the parameter group to associate
with this DAX cluster
latefinal
-
port
↔ Output<
int> -
The port used by the configuration endpoint
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
replicationFactor
↔ Output<
int> -
The number of nodes in the DAX cluster. A
replication factor of 1 will create a single-node cluster, without any read
replicas
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroupIds
↔ Output<
List< String> > -
One or more VPC security groups associated
with the cluster
latefinal
-
serverSideEncryption
↔ Output<
ClusterServerSideEncryption?> -
Encrypt at rest options
latefinal
-
subnetGroupName
↔ Output<
String> -
Name of the subnet group to be used for the
cluster
latefinal
-
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited