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.

dax¶

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.

class pulumi_aws.dax.Cluster(resource_name, opts=None, availability_zones=None, cluster_name=None, description=None, iam_role_arn=None, maintenance_window=None, node_type=None, notification_topic_arn=None, parameter_group_name=None, replication_factor=None, security_group_ids=None, server_side_encryption=None, subnet_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a DAX Cluster resource.

import pulumi
import pulumi_aws as aws

bar = aws.dax.Cluster("bar",
    cluster_name="cluster-example",
    iam_role_arn=data["aws_iam_role"]["example"]["arn"],
    node_type="dax.r4.large",
    replication_factor=1)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
availability_zones (pulumi.Input[list]) – List of Availability Zones in which the nodes will be created
cluster_name (pulumi.Input[str]) – Group identifier. DAX converts this name to lowercase
description (pulumi.Input[str]) – Description for the cluster
iam_role_arn (pulumi.Input[str]) – 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
maintenance_window (pulumi.Input[str]) – 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
node_type (pulumi.Input[str]) – The compute and memory capacity of the nodes. See Nodes for supported node types
notification_topic_arn (pulumi.Input[str]) – 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
parameter_group_name (pulumi.Input[str]) – Name of the parameter group to associate with this DAX cluster
replication_factor (pulumi.Input[float]) – The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas
security_group_ids (pulumi.Input[list]) – One or more VPC security groups associated with the cluster
server_side_encryption (pulumi.Input[dict]) – Encrypt at rest options
subnet_group_name (pulumi.Input[str]) – Name of the subnet group to be used for the cluster
tags (pulumi.Input[dict]) – A map of tags to assign to the resource

The server_side_encryption object supports the following:

enabled (pulumi.Input[bool]) - Whether to enable encryption at rest. Defaults to false.

arn: pulumi.Output[str] = None¶: The ARN of the DAX cluster

availability_zones: pulumi.Output[list] = None¶: List of Availability Zones in which the nodes will be created

cluster_address: pulumi.Output[str] = None¶: The DNS name of the DAX cluster without the port appended

cluster_name: pulumi.Output[str] = None¶: Group identifier. DAX converts this name to lowercase

configuration_endpoint: pulumi.Output[str] = None¶: The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

description: pulumi.Output[str] = None¶: Description for the cluster

iam_role_arn: pulumi.Output[str] = None¶: 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

maintenance_window: pulumi.Output[str] = None¶: 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

node_type: pulumi.Output[str] = None¶: The compute and memory capacity of the nodes. See Nodes for supported node types

nodes: pulumi.Output[list] = None¶

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

address (str)
availability_zone (str)
id (str)
port (float) - The port used by the configuration endpoint

notification_topic_arn: pulumi.Output[str] = None¶: 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

parameter_group_name: pulumi.Output[str] = None¶: Name of the parameter group to associate with this DAX cluster

port: pulumi.Output[float] = None¶: The port used by the configuration endpoint

replication_factor: pulumi.Output[float] = None¶: The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

security_group_ids: pulumi.Output[list] = None¶: One or more VPC security groups associated with the cluster

server_side_encryption: pulumi.Output[dict] = None¶

Encrypt at rest options

enabled (bool) - Whether to enable encryption at rest. Defaults to false.

subnet_group_name: pulumi.Output[str] = None¶: Name of the subnet group to be used for the cluster

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource

static get(resource_name, id, opts=None, arn=None, availability_zones=None, cluster_address=None, cluster_name=None, configuration_endpoint=None, description=None, iam_role_arn=None, maintenance_window=None, node_type=None, nodes=None, notification_topic_arn=None, parameter_group_name=None, port=None, replication_factor=None, security_group_ids=None, server_side_encryption=None, subnet_group_name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the DAX cluster
availability_zones (pulumi.Input[list]) – List of Availability Zones in which the nodes will be created
cluster_address (pulumi.Input[str]) – The DNS name of the DAX cluster without the port appended
cluster_name (pulumi.Input[str]) – Group identifier. DAX converts this name to lowercase
configuration_endpoint (pulumi.Input[str]) – The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number
description (pulumi.Input[str]) – Description for the cluster
iam_role_arn (pulumi.Input[str]) – 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
maintenance_window (pulumi.Input[str]) – 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
node_type (pulumi.Input[str]) –
The compute and memory capacity of the nodes. See Nodes for supported node types
nodes (pulumi.Input[list]) – List of node objects including id, address, port and availability_zone. Referenceable e.g. as ${aws_dax_cluster.test.nodes.0.address}
notification_topic_arn (pulumi.Input[str]) – 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
parameter_group_name (pulumi.Input[str]) – Name of the parameter group to associate with this DAX cluster
port (pulumi.Input[float]) – The port used by the configuration endpoint
replication_factor (pulumi.Input[float]) – The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas
security_group_ids (pulumi.Input[list]) – One or more VPC security groups associated with the cluster
server_side_encryption (pulumi.Input[dict]) – Encrypt at rest options
subnet_group_name (pulumi.Input[str]) – Name of the subnet group to be used for the cluster
tags (pulumi.Input[dict]) – A map of tags to assign to the resource

The nodes object supports the following:

address (pulumi.Input[str])
availability_zone (pulumi.Input[str])
id (pulumi.Input[str])
port (pulumi.Input[float]) - The port used by the configuration endpoint

The server_side_encryption object supports the following:

enabled (pulumi.Input[bool]) - Whether to enable encryption at rest. Defaults to false.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.dax.ParameterGroup(resource_name, opts=None, description=None, name=None, parameters=None, __props__=None, __name__=None, __opts__=None)¶

Provides a DAX Parameter Group resource.

import pulumi
import pulumi_aws as aws

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the parameter group.
name (pulumi.Input[str]) – The name of the parameter group.
parameters (pulumi.Input[list]) – The parameters of the parameter group.

The parameters object supports the following:

name (pulumi.Input[str]) - The name of the parameter.
value (pulumi.Input[str]) - The value for the parameter.

description: pulumi.Output[str] = None¶: A description of the parameter group.

name: pulumi.Output[str] = None¶: The name of the parameter group.

parameters: pulumi.Output[list] = None¶

The parameters of the parameter group.

name (str) - The name of the parameter.
value (str) - The value for the parameter.

static get(resource_name, id, opts=None, description=None, name=None, parameters=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the parameter group.
name (pulumi.Input[str]) – The name of the parameter group.
parameters (pulumi.Input[list]) – The parameters of the parameter group.

The parameters object supports the following:

name (pulumi.Input[str]) - The name of the parameter.
value (pulumi.Input[str]) - The value for the parameter.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.dax.SubnetGroup(resource_name, opts=None, description=None, name=None, subnet_ids=None, __props__=None, __name__=None, __opts__=None)¶

Provides a DAX Subnet Group resource.

import pulumi
import pulumi_aws as aws

example = aws.dax.SubnetGroup("example", subnet_ids=[
    aws_subnet["example1"]["id"],
    aws_subnet["example2"]["id"],
])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the subnet group.
name (pulumi.Input[str]) – The name of the subnet group.
subnet_ids (pulumi.Input[list]) – A list of VPC subnet IDs for the subnet group.

description: pulumi.Output[str] = None¶: A description of the subnet group.

name: pulumi.Output[str] = None¶: The name of the subnet group.

subnet_ids: pulumi.Output[list] = None¶: A list of VPC subnet IDs for the subnet group.

vpc_id: pulumi.Output[str] = None¶: VPC ID of the subnet group.

static get(resource_name, id, opts=None, description=None, name=None, subnet_ids=None, vpc_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the subnet group.
name (pulumi.Input[str]) – The name of the subnet group.
subnet_ids (pulumi.Input[list]) – A list of VPC subnet IDs for the subnet group.
vpc_id (pulumi.Input[str]) – VPC ID of the subnet group.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

dax¶

On This Page