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.

virtual string AllowedPattern { get; }

Property Value

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

virtual string DataType { get; }

Property Value

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

virtual string Description { get; }

Property Value

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

virtual string Name { get; }

Property Value

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

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.

virtual string Policies { get; }

Property Value

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

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.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.

virtual string Tier { get; }

Property Value

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

System.String

Remarks

Parameters of type SecureString 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

System.String

Remarks

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

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