Interface IParameterOptions

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Properties needed to create a new SSM Parameter.

public interface IParameterOptions

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
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

AllowedPattern

A regular expression used to validate the parameter value.

string? AllowedPattern { get; }

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.

string? Description { get; }

Property Value

string

Remarks

Default: none

ParameterName

The name of the parameter.

string? ParameterName { get; }

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).

bool? SimpleName { get; }

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

Tier

The tier of the string parameter.

ParameterTier? Tier { get; }

Property Value

ParameterTier?

Remarks

Default: - undefined