parameter

Gets an individual parameter resource

Overview

Name	parameter
Type	Resource
Description	parameter
Id	awscc.ssm.parameter

Fields

Name	Datatype	Description
type	string	The type of parameter.<br/> Although ``SecureString`` is included in the list of valid values, CFNlong does *not* currently support creating a ``SecureString`` parameter type.
value	string	The parameter value.<br/> 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.<br/> [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.
tags	object	Optional 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_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.<br/> 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 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``
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
type,
value,
description,
policies,
allowed_pattern,
tier,
tags,
data_type,
name
FROM awscc.ssm.parameter
WHERE data__Identifier = '<Name>';

Permissions

To operate on the parameter resource, the following permissions are required:

Read

ssm:GetParameters

Update

ssm:PutParameter,
ssm:AddTagsToResource,
ssm:RemoveTagsFromResource,
ssm:GetParameters

Delete

ssm:DeleteParameter