Interface ISecureStringParameterAttributes

Attributes for secure string parameters.

Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISecureStringParameterAttributes : ICommonStringParameterAttributes
Syntax (vb)
Public Interface ISecureStringParameterAttributes
    Inherits ICommonStringParameterAttributes
Remarks

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

EncryptionKey

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

The version number of the value you wish to retrieve.

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.

virtual IKey EncryptionKey { get; }
Property Value

IKey

Remarks

Default: - default master key

Version

The version number of the value you wish to retrieve.

virtual Nullable<double> Version { get; }
Property Value

System.Nullable<System.Double>

Remarks

Default: - AWS CloudFormation uses the latest version of the parameter