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:: AWS CloudFormation doesn’t support creating a SecureString parameter type. Allowed Values : String | StringList

  • 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 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

  • policies (Optional[str]) – Information about the policies assigned to a parameter. Assigning parameter policies in the AWS Systems Manager User Guide .

  • tags (Optional[Any]) – 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.

Link

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.
import aws_cdk.aws_ssm as ssm

# tags: Any

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,
    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+$

Link

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

Return type

Optional[str]

data_type

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

The default is text .

Link

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

Return type

Optional[str]

description

Information about the parameter.

Link

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

Return type

Optional[str]

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 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

Link

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

Return type

Optional[str]

policies

Information about the policies assigned to a parameter.

Assigning parameter policies in the AWS Systems Manager User Guide .

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Any

tier

The parameter tier.

Link

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

Return type

Optional[str]

type

The type of parameter.

AWS CloudFormation doesn’t support creating a SecureString parameter type.

Allowed Values : String | StringList

Link

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

Return type

str

value

The parameter value.

If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

Link

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

Return type

str