Class StringParameterProps

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Properties needed to create a String SSM parameter.

public class StringParameterProps : IStringParameterProps, IParameterOptions

Inheritance

object

StringParameterProps

Implements

IStringParameterProps

IParameterOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

new StringParameter(this, "Parameter", new StringParameterProps {
                AllowedPattern = ".*",
                Description = "The value Foo",
                ParameterName = "FooParameter",
                StringValue = "Foo",
                Tier = ParameterTier.ADVANCED
            });

Remarks

ExampleMetadata: infused

Constructors

StringParameterProps()

public StringParameterProps()

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

DataType

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

public ParameterDataType? DataType { get; set; }

Property Value

ParameterDataType?

Remarks

Default: ParameterDataType.TEXT

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

StringValue

The value of the parameter.

public string StringValue { 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

Type

The type of the string parameter.

public ParameterType? Type { get; set; }

Property Value

ParameterType?

Remarks

Default: ParameterType.STRING