Class StringListParameterProps

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Properties needed to create a StringList SSM Parameter.

public class StringListParameterProps : IStringListParameterProps, IParameterOptions

Inheritance

object

StringListParameterProps

Implements

IStringListParameterProps

IParameterOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// Create a new SSM Parameter holding a String
            var param = new StringParameter(stack, "StringParameter", new StringParameterProps {
                // description: 'Some user-friendly description',
                // name: 'ParameterName',
                StringValue = "Initial parameter value"
            });

            // Grant read access to some Role
            param.GrantRead(role);

            // Create a new SSM Parameter holding a StringList
            var listParameter = new StringListParameter(stack, "StringListParameter", new StringListParameterProps {
                // description: 'Some user-friendly description',
                // name: 'ParameterName',
                StringListValue = new [] { "Initial parameter value A", "Initial parameter value B" }
            });

Remarks

ExampleMetadata: lit=test/integ.parameter.lit.ts infused

Constructors

StringListParameterProps()

public StringListParameterProps()

Properties

AllowedPattern

A regular expression used to validate the parameter value.

public string? AllowedPattern { get; set; }

Property Value

string

Remarks

For example, for String types with values restricted to numbers, you can specify the following: ^\d+$

Default: no validation is performed

Description

Information about the parameter that you want to add to the system.

public string? Description { get; set; }

Property Value

string

Remarks

Default: none

ParameterName

The name of the parameter.

public string? ParameterName { get; set; }

Property Value

string

Remarks

Default: - a name will be generated by CloudFormation

SimpleName

Indicates of the parameter name is a simple name (i.e. does not include "/" separators).

public bool? SimpleName { get; set; }

Property Value

bool?

Remarks

This is only required only if parameterName is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs.

If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

Default: - auto-detect based on parameterName

StringListValue

The values of the parameter.

public string[] StringListValue { get; set; }

Property Value

string[]

Remarks

It may not reference another parameter and {{}} cannot be used in the value.

Tier

The tier of the string parameter.

public ParameterTier? Tier { get; set; }

Property Value

ParameterTier?

Remarks

Default: - undefined