Interface IParameterOptions

Properties needed to create a new SSM Parameter.

Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IParameterOptions
Syntax (vb)
Public Interface IParameterOptions
Remarks

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 parameterOptions = new ParameterOptions {
    AllowedPattern = "allowedPattern",
    Description = "description",
    ParameterName = "parameterName",
    SimpleName = false,
    Tier = ParameterTier.ADVANCED
};

Synopsis

Properties

AllowedPattern

A regular expression used to validate the parameter value.
Description

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

The name of the parameter.
SimpleName

Indicates whether the parameter name is a simple name.
Tier

The tier of the string parameter.

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: ^\d+$

Default: no validation is performed

Description

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

virtual string Description { get; }
Property Value

System.String

Remarks

Default: none

ParameterName

The name of the parameter.

virtual string ParameterName { get; }
Property Value

System.String

Remarks

Default: - a name will be generated by CloudFormation

SimpleName

Indicates whether the parameter name is a simple name.

virtual Nullable<bool> SimpleName { get; }
Property Value

System.Nullable<System.Boolean>

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

Tier

The tier of the string parameter.

virtual Nullable<ParameterTier> Tier { get; }
Property Value

System.Nullable<ParameterTier>

Remarks

Default: - undefined