Class SecureStringParameterAttributes

Attributes for secure string parameters.

Inheritance
System.Object
SecureStringParameterAttributes
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public class SecureStringParameterAttributes : Object, ISecureStringParameterAttributes, ICommonStringParameterAttributes
Syntax (vb)
Public Class SecureStringParameterAttributes
    Inherits Object
    Implements ISecureStringParameterAttributes, ICommonStringParameterAttributes
Remarks

ExampleMetadata: lit=test/integ.parameter-store-string.lit.ts infused

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

SecureStringParameterAttributes()

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.
ParameterName

The name of the parameter store value.
SimpleName

Indicates of the parameter name is a simple name (i.e. does not include "/" separators).
Version

The version number of the value you wish to retrieve.

Constructors

SecureStringParameterAttributes()

public SecureStringParameterAttributes()

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.

public IKey EncryptionKey { get; set; }
Property Value

IKey

Remarks

Default: - default master key

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 of the parameter name is a simple name (i.e. does not include "/" separators).

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

System.Nullable<System.Boolean>

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

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: - AWS CloudFormation uses the latest version of the parameter

Implements