Class StringParameterProps

Properties needed to create a String SSM parameter.

Inheritance
System.Object
StringParameterProps
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public class StringParameterProps : Object, IStringParameterProps, IParameterOptions
Syntax (vb)
Public Class StringParameterProps
    Inherits Object
    Implements IStringParameterProps, IParameterOptions
Remarks

ExampleMetadata: infused

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

Synopsis

Constructors

StringParameterProps()

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 that you want to add to the system.
ParameterName

The name of the parameter.
SimpleName

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

The value of the parameter.
Tier

The tier of the string parameter.
Type

The type of the string parameter.

Constructors

StringParameterProps()

public StringParameterProps()

Properties

AllowedPattern

A regular expression used to validate the parameter value.

public string AllowedPattern { get; set; }
Property Value

System.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 Nullable<ParameterDataType> DataType { get; set; }
Property Value

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

System.String

Remarks

Default: none

ParameterName

The name of the parameter.

public string ParameterName { get; set; }
Property Value

System.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 Nullable<bool> SimpleName { get; set; }
Property Value

System.Nullable<System.Boolean>

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

System.String

Remarks

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

Tier

The tier of the string parameter.

public Nullable<ParameterTier> Tier { get; set; }
Property Value

System.Nullable<ParameterTier>

Remarks

Default: - undefined

Type

The type of the string parameter.

public Nullable<ParameterType> Type { get; set; }
Property Value

System.Nullable<ParameterType>

Remarks

Default: ParameterType.STRING

Implements