Class StringParameterAttributes

Attributes for parameters of various types of string.

Inheritance

System.Object

StringParameterAttributes

Implements

IStringParameterAttributes

ICommonStringParameterAttributes

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StringParameterAttributes : Object, IStringParameterAttributes, ICommonStringParameterAttributes

Syntax (vb)

Public Class StringParameterAttributes
    Inherits Object
    Implements IStringParameterAttributes, ICommonStringParameterAttributes

Remarks

See: ParameterType

ExampleMetadata: infused

Examples

var parameterVersion = Token.AsNumber(new Dictionary<string, string> { { "Ref", "MyParameter" } });

// Retrieve the latest value of the non-secret parameter
// with name "/My/String/Parameter".
var stringValue = StringParameter.FromStringParameterAttributes(this, "MyValue", new StringParameterAttributes {
    ParameterName = "/My/Public/Parameter"
}).StringValue;
var stringValueVersionFromToken = StringParameter.FromStringParameterAttributes(this, "MyValueVersionFromToken", new StringParameterAttributes {
    ParameterName = "/My/Public/Parameter",
    // parameter version from token
    Version = parameterVersion
}).StringValue;

// Retrieve a specific version of the secret (SecureString) parameter.
// 'version' is always required.
var secretValue = StringParameter.FromSecureStringParameterAttributes(this, "MySecureValue", new SecureStringParameterAttributes {
    ParameterName = "/My/Secret/Parameter",
    Version = 5
});
var secretValueVersionFromToken = StringParameter.FromSecureStringParameterAttributes(this, "MySecureValueVersionFromToken", new SecureStringParameterAttributes {
    ParameterName = "/My/Secret/Parameter",
    // parameter version from token
    Version = parameterVersion
});

Synopsis

Constructors

StringParameterAttributes()

Properties

ForceDynamicReference	Use a dynamic reference as the representation in CloudFormation template level.
ParameterName	The name of the parameter store value.
SimpleName	Indicates whether the parameter name is a simple name.
Type	(deprecated) The type of the string parameter.
ValueType	The type of the string parameter value.
Version	The version number of the value you wish to retrieve.

Constructors

StringParameterAttributes()

public StringParameterAttributes()

Properties

ForceDynamicReference

Use a dynamic reference as the representation in CloudFormation template level.

public Nullable<bool> ForceDynamicReference { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

By default, CDK tries to deduce an appropriate representation based on the parameter value (a CfnParameter or a dynamic reference). Use this flag to override the representation when it does not work.

Default: false

ParameterName

The name of the parameter store value.

public string ParameterName { get; set; }

Property Value

System.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 whether the parameter name is a simple name.

public Nullable<bool> SimpleName { get; set; }

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

Type

(deprecated) The type of the string parameter.

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

Property Value

System.Nullable<ParameterType>

Remarks

Default: ParameterType.STRING

Stability: Deprecated

ValueType

The type of the string parameter value.

public Nullable<ParameterValueType> ValueType { get; set; }

Property Value

System.Nullable<ParameterValueType>

Remarks

Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

Default: ParameterValueType.STRING

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types

Version

The version number of the value you wish to retrieve.

public Nullable<double> Version { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: The latest version will be retrieved.

Implements

IStringParameterAttributes

ICommonStringParameterAttributes