parameter_tags
Expands all tag keys and values for parameters
in a region
Overview
Name | parameter_tags |
Type | Resource |
Description | The AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource . On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name , aws:cloudformation:logical-id , and aws:cloudformation:stack-id , in addition to any custom tags you specify.To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource . For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*. |
Id | aws.ssm.parameter_tags |
Fields
Name | Datatype | Description |
---|---|---|
type | string | The type of parameter. |
value | string | The parameter value. If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field. |
description | string | Information about the parameter. |
policies | string | Information about the policies assigned to a parameter. [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*. |
allowed_pattern | string | A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ |
tier | string | The parameter tier. |
data_type | string | The data type of the parameter, such as text or aws:ec2:image . The default is text . |
name | string | The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName |
tag_key | string | Tag key. |
tag_value | string | Tag value. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Expands tags for all parameters
in a region.
SELECT
region,
type,
value,
description,
policies,
allowed_pattern,
tier,
data_type,
name,
tag_key,
tag_value
FROM aws.ssm.parameter_tags
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the parameter_tags
resource, see parameters