CfnParameterProps
- class aws_cdk.aws_ssm.CfnParameterProps(*, type, value, allowed_pattern=None, data_type=None, description=None, name=None, policies=None, tags=None, tier=None)
Bases:
object
Properties for defining a
CfnParameter
.- Parameters:
type (
str
) – The type of parameter.value (
str
) – The parameter value. .. epigraph:: If type isStringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.allowed_pattern (
Optional
[str
]) – A regular expression used to validate the parameter value. For example, forString
types with values restricted to numbers, you can specify the following:AllowedPattern=^\d+$
data_type (
Optional
[str
]) – The data type of the parameter, such astext
oraws:ec2:image
. The default istext
.description (
Optional
[str
]) – Information about the parameter.name (
Optional
[str
]) – The name of the parameter. .. epigraph:: 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
policies (
Optional
[str
]) – Information about the policies assigned to a parameter. Assigning parameter policies in the AWS Systems Manager User Guide .tags (
Optional
[Mapping
[str
,str
]]) – 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 Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.tier (
Optional
[str
]) – The parameter tier.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ssm as ssm cfn_parameter_props = ssm.CfnParameterProps( type="type", value="value", # the properties below are optional allowed_pattern="allowedPattern", data_type="dataType", description="description", name="name", policies="policies", tags={ "tags_key": "tags" }, tier="tier" )
Attributes
- allowed_pattern
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+$
- data_type
The data type of the parameter, such as
text
oraws:ec2:image
.The default is
text
.
- description
Information about the parameter.
- name
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
- policies
Information about the policies assigned to a parameter.
Assigning parameter policies in the AWS Systems Manager User Guide .
- tags
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 Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- tier
The parameter tier.
- type
The type of parameter.
- value
The parameter value.
If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.