Interface ICfnParameterProps

Properties for defining a CfnParameter.

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnParameterProps

Syntax (vb)

Public Interface ICfnParameterProps

Remarks

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

ExampleMetadata: fixture=_generated

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 cfnParameterProps = new CfnParameterProps {
                 Type = "type",
                 Value = "value",

                 // the properties below are optional
                 AllowedPattern = "allowedPattern",
                 DataType = "dataType",
                 Description = "description",
                 Name = "name",
                 Policies = "policies",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Tier = "tier"
             };

Synopsis

Properties

AllowedPattern	A regular expression used to validate the parameter value.
DataType	The data type of the parameter, such as text or aws:ec2:image .
Description	Information about the parameter.
Name	The name of the parameter.
Policies	Information about the policies assigned to a parameter.
Tags	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
Tier	The parameter tier.
Type	The type of parameter.
Value	The parameter value.

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

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

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

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

string? Policies { get; }

Property Value

string

Remarks

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

IDictionary<string, string>? Tags { get; }

Property Value

IDictionary<string, string>

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.

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

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

Parameters of type <code>SecureString</code> are not supported by AWS CloudFormation .

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

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