Interface ICommonStringParameterAttributes

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Common attributes for string parameters.

public interface ICommonStringParameterAttributes

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 commonStringParameterAttributes = new CommonStringParameterAttributes {
                ParameterName = "parameterName",

                // the properties below are optional
                SimpleName = false
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

ParameterName

The name of the parameter store value.

string ParameterName { get; }

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