Skip to main content

parameters_list_only

Lists parameters in a region or regions, for all properties use parameters

Overview

Nameparameters_list_only
TypeResource
DescriptionThe 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*.
Idaws.ssm.parameters_list_only

Fields

NameDatatypeDescription
typestringThe type of parameter.
valuestringThe parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
descriptionstringInformation about the parameter.
policiesstringInformation 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_patternstringA 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+$
tierstringThe parameter tier.
tagsobjectOptional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
data_typestringThe data type of the parameter, such as text or aws:ec2:image. The default is text.
namestringThe 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
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all parameters in a region.

SELECT
region,
name
FROM aws.ssm.parameters_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the parameters_list_only resource, see parameters