Class ListParameterAttributes

Attributes for parameters of string list type.

Inheritance
object
ListParameterAttributes
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ListParameterAttributes : IListParameterAttributes, ICommonStringParameterAttributes
Syntax (vb)
Public Class ListParameterAttributes Implements IListParameterAttributes, ICommonStringParameterAttributes
Remarks

See: ParameterType

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 listParameterAttributes = new ListParameterAttributes {
                 ParameterName = "parameterName",

                 // the properties below are optional
                 ElementType = ParameterValueType.STRING,
                 SimpleName = false,
                 Version = 123
             };

Synopsis

Constructors

ListParameterAttributes()

Attributes for parameters of string list type.

Properties

ElementType

The type of the string list parameter value.
ParameterName

The name of the parameter store value.
SimpleName

Indicates whether the parameter name is a simple name.
Version

The version number of the value you wish to retrieve.

Constructors

ListParameterAttributes()

Attributes for parameters of string list type.

public ListParameterAttributes()
Remarks

See: ParameterType

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 listParameterAttributes = new ListParameterAttributes {
                 ParameterName = "parameterName",

                 // the properties below are optional
                 ElementType = ParameterValueType.STRING,
                 SimpleName = false,
                 Version = 123
             };

Properties

ElementType

The type of the string list parameter value.

public ParameterValueType? ElementType { get; set; }
Property Value

ParameterValueType?

Remarks

Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

Default: ParameterValueType.STRING

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types

ParameterName

The name of the parameter store value.

public string ParameterName { get; set; }
Property Value

string

Remarks

This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

SimpleName

Indicates whether the parameter name is a simple name.

public bool? SimpleName { get; set; }
Property Value

bool?

Remarks

A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN.

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

Version

The version number of the value you wish to retrieve.

public double? Version { get; set; }
Property Value

double?

Remarks

Default: The latest version will be retrieved.

Implements