Interface ISecureStringParameterAttributes

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Attributes for secure string parameters.

public interface ISecureStringParameterAttributes : ICommonStringParameterAttributes

Inherited Members

ICommonStringParameterAttributes.ParameterName

ICommonStringParameterAttributes.SimpleName

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
            });

Remarks

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

Properties

EncryptionKey

The encryption key that is used to encrypt this parameter.

IKey? EncryptionKey { get; }

Property Value

IKey

Remarks

Default: - default master key

Version

The version number of the value you wish to retrieve.

double? Version { get; }

Property Value

double?

Remarks

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