software.amazon.awscdk.services.ssm

Interface StringParameterAttributes

All Superinterfaces:

CommonStringParameterAttributes, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StringParameterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.972Z")
 @Stability(value=Stable)
public interface StringParameterAttributes
extends software.amazon.jsii.JsiiSerializable, CommonStringParameterAttributes

Attributes for parameters of various types of string.

Example:

 // Retrieve the latest value of the non-secret parameter
 // with name "/My/String/Parameter".
 String stringValue = StringParameter.fromStringParameterAttributes(this, "MyValue", StringParameterAttributes.builder()
         .parameterName("/My/Public/Parameter")
         .build()).getStringValue();
 String stringValueVersionFromToken = StringParameter.fromStringParameterAttributes(this, "MyValueVersionFromToken", StringParameterAttributes.builder()
         .parameterName("/My/Public/Parameter")
         // parameter version from token
         .version(parameterVersion)
         .build()).getStringValue();
 // Retrieve a specific version of the secret (SecureString) parameter.
 // 'version' is always required.
 IStringParameter secretValue = StringParameter.fromSecureStringParameterAttributes(this, "MySecureValue", SecureStringParameterAttributes.builder()
         .parameterName("/My/Secret/Parameter")
         .version(5)
         .build());
 IStringParameter secretValueVersionFromToken = StringParameter.fromSecureStringParameterAttributes(this, "MySecureValueVersionFromToken", SecureStringParameterAttributes.builder()
         .parameterName("/My/Secret/Parameter")
         // parameter version from token
         .version(parameterVersion)
         .build());
 

See Also:

ParameterType

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StringParameterAttributes.Builder A builder for StringParameterAttributes
static class	StringParameterAttributes.Jsii$Proxy An implementation for StringParameterAttributes

Method Summary

Modifier and Type	Method and Description
static StringParameterAttributes.Builder	builder()
default ParameterType	getType() The type of the string parameter.
default Number	getVersion() The version number of the value you wish to retrieve.

Methods inherited from interface software.amazon.awscdk.services.ssm.CommonStringParameterAttributes

getParameterName, getSimpleName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getType

@Stability(value=Stable)
 @Nullable
default ParameterType getType()

The type of the string parameter.

Default: ParameterType.STRING

getVersion

@Stability(value=Stable)
 @Nullable
default Number getVersion()

The version number of the value you wish to retrieve.

Default: The latest version will be retrieved.

builder

@Stability(value=Stable)
static StringParameterAttributes.Builder builder()

Specified by:

builder in interface CommonStringParameterAttributes

Returns:

a StringParameterAttributes.Builder of StringParameterAttributes