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. .. epigraph:: Parameters of type SecureString are not supported by AWS CloudFormation .
value (str) – The parameter value. .. epigraph:: If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.
allowed_pattern (Optional[str]) – 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 (Optional[str]) – The data type of the parameter, such as text or aws:ec2:image . The default is text .
description (Optional[str]) – Information about the parameter.
name (Optional[str]) – The name of the parameter. .. epigraph:: The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager . The maximum length for a parameter name that you specify is 1011 characters. This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: arn:aws:ssm:us-east-2:111122223333:parameter/ .
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+$

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern

data_type

The data type of the parameter, such as text or aws:ec2:image .

The default is text .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype

description

Information about the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description

name

The name of the parameter.

The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager . The maximum length for a parameter name that you specify is 1011 characters.

This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: arn:aws:ssm:us-east-2:111122223333:parameter/ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name

policies

Information about the policies assigned to a parameter.

Assigning parameter policies in the AWS Systems Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies

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.