Interface ICfnParameterProps

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Properties for defining a CfnParameter.

public interface ICfnParameterProps

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SSM;

             var tags;

             var cfnParameterProps = new CfnParameterProps {
                 Type = "type",
                 Value = "value",

                 // the properties below are optional
                 AllowedPattern = "allowedPattern",
                 DataType = "dataType",
                 Description = "description",
                 Name = "name",
                 Policies = "policies",
                 Tags = tags,
                 Tier = "tier"
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AllowedPattern

A regular expression used to validate the parameter value.

string? AllowedPattern { get; }

Property Value

string

Remarks

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

DataType

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

string? DataType { get; }

Property Value

string

Remarks

The default is text .

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

Description

Information about the parameter.

string? Description { get; }

Property Value

string

Remarks

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

Name

The name of the parameter.

string? Name { get; }

Property Value

string

Remarks

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: <code>arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName</code>

Link: 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.

string? Policies { get; }

Property Value

string

Remarks

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

Tags

Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

object? Tags { get; }

Property Value

object

Remarks

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

Tier

The parameter tier.

string? Tier { get; }

Property Value

string

Remarks

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

Type

The type of parameter.

string Type { get; }

Property Value

string

Remarks

AWS CloudFormation doesn't support creating a <code>SecureString</code> parameter type.

Allowed Values : String | StringList

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

Value

The parameter value.

string Value { get; }

Property Value

string

Remarks

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

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