Interface IStringParameterAttributes

Attributes for parameters of various types of string.

Inherited Members

ICommonStringParameterAttributes.ParameterName

ICommonStringParameterAttributes.SimpleName

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IStringParameterAttributes : ICommonStringParameterAttributes

Syntax (vb)

Public Interface IStringParameterAttributes
    Inherits 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

Properties

ForceDynamicReference	Use a dynamic reference as the representation in CloudFormation template level.
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.

Properties

ForceDynamicReference

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

virtual Nullable<bool> ForceDynamicReference { get; }

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

Type

(deprecated) The type of the string parameter.

virtual Nullable<ParameterType> Type { get; }

Property Value

System.Nullable<ParameterType>

Remarks

Default: ParameterType.STRING

Stability: Deprecated

ValueType

The type of the string parameter value.

virtual Nullable<ParameterValueType> ValueType { get; }

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.

virtual Nullable<double> Version { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: The latest version will be retrieved.