AWS::DAX::ParameterGroup - AWS CloudFormation

AWS::DAX::ParameterGroup

A named set of parameters that are applied to all of the nodes in a DAX cluster.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::DAX::ParameterGroup", "Properties" : { "Description" : String, "ParameterGroupName" : String, "ParameterNameValues" : Json } }

YAML

Type: AWS::DAX::ParameterGroup Properties: Description: String ParameterGroupName: String ParameterNameValues: Json

Properties

Description

A description of the parameter group.

Required: No

Type: String

Update requires: No interruption

ParameterGroupName

The name of the parameter group.

Required: No

Type: String

Update requires: Replacement

ParameterNameValues

An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

Note

record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings.

Required: No

Type: Json

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the created parameter group. For example:

{ "Ref": "MyDAXParameterGroup" }

Returns a value similar to the following:

my-dax-parameter-group

For more information about using the Ref function, see Ref.

Fn::GetAtt

Examples

Create Parameter Group

The following example creates a DAX parameter group.

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "DAX parameter group", "Resources": { "daxParamGroup": { "Type": "AWS::DAX::ParameterGroup", "Properties": { "ParameterGroupName": "MyDAXParameterGroup", "Description": "Description for my DAX parameter group", "ParameterNameValues": { "query-ttl-millis": "75000", "record-ttl-millis": "88000" } } } }, "Outputs": { "ParameterGroup": { "Value": { "Ref": "daxParamGroup" } } } }

YAML

AWSTemplateFormatVersion: "2010-09-09" Description: "DAX parameter group" Resources: daxParamGroup: Type: AWS::DAX::ParameterGroup Properties: ParameterGroupName: "MyDAXParameterGroup" Description: "Description for my DAX parameter group" ParameterNameValues: "query-ttl-millis" : "75000" "record-ttl-millis" : "88000" Outputs: ParameterGroup: Value: !Ref daxParamGroup