Interface IStringParameterAttributes
Attributes for parameters of various types of string.
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public interface IStringParameterAttributes : ICommonStringParameterAttributes
Syntax (vb)
Public Interface IStringParameterAttributes
Inherits ICommonStringParameterAttributes
Remarks
See: ParameterType
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
Properties
Type | The type of the string parameter. |
Version | The version number of the value you wish to retrieve. |
Properties
Type
The type of the string parameter.
virtual Nullable<ParameterType> Type { get; }
Property Value
System.Nullable<ParameterType>
Remarks
Default: ParameterType.STRING
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.