1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. dax

Module dax

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource Cluster

class Cluster extends CustomResource

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: aws_iam_role_example.arn,
    nodeType: "dax.r4.large",
    replicationFactor: 1,
});

constructor

new Cluster(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cluster

Returns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the DAX cluster

property availabilityZones

public availabilityZones: pulumi.Output<string[] | undefined>;

List of Availability Zones in which the nodes will be created

property clusterAddress

public clusterAddress: pulumi.Output<string>;

The DNS name of the DAX cluster without the port appended

property clusterName

public clusterName: pulumi.Output<string>;

Group identifier. DAX converts this name to lowercase

property configurationEndpoint

public configurationEndpoint: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

Description for the cluster

property iamRoleArn

public iamRoleArn: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maintenanceWindow

public maintenanceWindow: pulumi.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:00

property nodeType

public nodeType: pulumi.Output<string>;

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

property nodes

public nodes: pulumi.Output<ClusterNode[]>;

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

property notificationTopicArn

public notificationTopicArn: pulumi.Output<string | undefined>;

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

property parameterGroupName

public parameterGroupName: pulumi.Output<string>;

Name of the parameter group to associate with this DAX cluster

property port

public port: pulumi.Output<number>;

The port used by the configuration endpoint

property replicationFactor

public replicationFactor: pulumi.Output<number>;

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

property securityGroupIds

public securityGroupIds: pulumi.Output<string[]>;

One or more VPC security groups associated with the cluster

property serverSideEncryption

public serverSideEncryption: pulumi.Output<ClusterServerSideEncryption | undefined>;

Encrypt at rest options

property subnetGroupName

public subnetGroupName: pulumi.Output<string>;

Name of the subnet group to be used for the cluster

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ParameterGroup

class ParameterGroup extends CustomResource

Provides a DAX Parameter Group resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.dax.ParameterGroup("example", {
    parameters: [
        {
            name: "query-ttl-millis",
            value: "100000",
        },
        {
            name: "record-ttl-millis",
            value: "100000",
        },
    ],
});

constructor

new ParameterGroup(name: string, args?: ParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ParameterGroupState, opts?: pulumi.CustomResourceOptions): ParameterGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ParameterGroup

Returns true if the given object is an instance of ParameterGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

A description of the parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the parameter group.

property parameters

public parameters: pulumi.Output<ParameterGroupParameter[]>;

The parameters of the parameter group.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SubnetGroup

class SubnetGroup extends CustomResource

Provides a DAX Subnet Group resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.dax.SubnetGroup("example", {
    subnetIds: [
        aws_subnet_example1.id,
        aws_subnet_example2.id,
    ],
});

constructor

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetGroupState, opts?: pulumi.CustomResourceOptions): SubnetGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetGroup

Returns true if the given object is an instance of SubnetGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

A description of the subnet group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the subnet group.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

A list of VPC subnet IDs for the subnet group.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

VPC ID of the subnet group.

Others

interface ClusterArgs

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

List of Availability Zones in which the nodes will be created

property clusterName

clusterName: pulumi.Input<string>;

Group identifier. DAX converts this name to lowercase

property description

description?: pulumi.Input<string>;

Description for the cluster

property iamRoleArn

iamRoleArn: pulumi.Input<string>;

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

property maintenanceWindow

maintenanceWindow?: pulumi.Input<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:00

property nodeType

nodeType: pulumi.Input<string>;

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

property notificationTopicArn

notificationTopicArn?: pulumi.Input<string>;

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

property parameterGroupName

parameterGroupName?: pulumi.Input<string>;

Name of the parameter group to associate with this DAX cluster

property replicationFactor

replicationFactor: pulumi.Input<number>;

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

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

One or more VPC security groups associated with the cluster

property serverSideEncryption

serverSideEncryption?: pulumi.Input<ClusterServerSideEncryption>;

Encrypt at rest options

property subnetGroupName

subnetGroupName?: pulumi.Input<string>;

Name of the subnet group to be used for the cluster

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource

interface ClusterState

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the DAX cluster

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

List of Availability Zones in which the nodes will be created

property clusterAddress

clusterAddress?: pulumi.Input<string>;

The DNS name of the DAX cluster without the port appended

property clusterName

clusterName?: pulumi.Input<string>;

Group identifier. DAX converts this name to lowercase

property configurationEndpoint

configurationEndpoint?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

Description for the cluster

property iamRoleArn

iamRoleArn?: pulumi.Input<string>;

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

property maintenanceWindow

maintenanceWindow?: pulumi.Input<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:00

property nodeType

nodeType?: pulumi.Input<string>;

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

property nodes

nodes?: pulumi.Input<pulumi.Input<ClusterNode>[]>;

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

property notificationTopicArn

notificationTopicArn?: pulumi.Input<string>;

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

property parameterGroupName

parameterGroupName?: pulumi.Input<string>;

Name of the parameter group to associate with this DAX cluster

property port

port?: pulumi.Input<number>;

The port used by the configuration endpoint

property replicationFactor

replicationFactor?: pulumi.Input<number>;

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

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

One or more VPC security groups associated with the cluster

property serverSideEncryption

serverSideEncryption?: pulumi.Input<ClusterServerSideEncryption>;

Encrypt at rest options

property subnetGroupName

subnetGroupName?: pulumi.Input<string>;

Name of the subnet group to be used for the cluster

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource

interface ParameterGroupArgs

interface ParameterGroupArgs

The set of arguments for constructing a ParameterGroup resource.

property description

description?: pulumi.Input<string>;

A description of the parameter group.

property name

name?: pulumi.Input<string>;

The name of the parameter group.

property parameters

parameters?: pulumi.Input<pulumi.Input<ParameterGroupParameter>[]>;

The parameters of the parameter group.

interface ParameterGroupState

interface ParameterGroupState

Input properties used for looking up and filtering ParameterGroup resources.

property description

description?: pulumi.Input<string>;

A description of the parameter group.

property name

name?: pulumi.Input<string>;

The name of the parameter group.

property parameters

parameters?: pulumi.Input<pulumi.Input<ParameterGroupParameter>[]>;

The parameters of the parameter group.

interface SubnetGroupArgs

interface SubnetGroupArgs

The set of arguments for constructing a SubnetGroup resource.

property description

description?: pulumi.Input<string>;

A description of the subnet group.

property name

name?: pulumi.Input<string>;

The name of the subnet group.

property subnetIds

subnetIds: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs for the subnet group.

interface SubnetGroupState

interface SubnetGroupState

Input properties used for looking up and filtering SubnetGroup resources.

property description

description?: pulumi.Input<string>;

A description of the subnet group.

property name

name?: pulumi.Input<string>;

The name of the subnet group.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs for the subnet group.

property vpcId

vpcId?: pulumi.Input<string>;

VPC ID of the subnet group.