AWS::DAX::ParameterGroup
Use the AWS CloudFormation AWS::DAX::ParameterGroup
resource to create a parameter group
for use with Amazon DynamoDB.
For more information, see ParameterGroup
in the Amazon DynamoDB Developer Guide.
Syntax
JSON
{ "Type": "AWS::DAX::ParameterGroup", "Properties": { "
ParameterGroupName
":String
, "Description
":String
, "ParameterNameValues
": {String
:String, ...
} } }
YAML
Type: "AWS::DAX::ParameterGroup" Properties:
ParameterGroupName
:String
Description
:String
ParameterNameValues
: {String
:String, ...
}
Properties
ParameterGroupName
-
The name of the parameter group.
Required: No
Type: String
Update requires: Updates are not supported.
Description
-
A description of the parameter group.
Required: No
Type: String
Update requires: No interruption;
ParameterNameValues
-
A map of DAX parameter names and values.
Required: No
Type: String to String map
Update requires: No interruption
Return Values
Ref
When you provide the logical ID of this resource to the Ref
intrinsic
function, Ref
returns the ARN 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
Fn::GetAtt
returns a value for a specified attribute of this type.
The following are the available attributes and sample return values.
ParameterGroupName
-
Returns the name of the parameter group. For example:
{ "Fn::GetAtt": ["
MyDAXParameterGroup
", "ParameterGroupName"] }Returns a value similar to the following:
mydaxparametergroup
For more information about using Fn::GetAtt
, see Fn::GetAtt.
Example
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", "ParameterGroupDescription": "Description for my DAX parameter group", "ParameterNameValues": { "query-ttl-millis": "75000", "record-ttl-millis": "88000" } } } }, "Outputs": { "ParameterGroup": { "Value": "daxParamGroup" } } }
YAML
AWSTemplateFormatVersion: "2010-09-09" Description: "DAX parameter group" Resources: daxParamGroup: Type: AWS::DAX::ParameterGroup Properties: ParameterGroupName: "MyDAXParameterGroup" ParameterGroupDescription: "Description for my DAX parameter group" ParameterNameValues: "query-ttl-millis" : "75000" "record-ttl-millis" : "88000" Outputs: ParameterGroup: Value: !Ref daxParamGroup