Package software.amazon.awscdk.services.ssm

Interface SecureStringParameterAttributes

All Superinterfaces:

CommonStringParameterAttributes, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SecureStringParameterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.180Z")
@Stability(Stable)
public interface SecureStringParameterAttributes
extends software.amazon.jsii.JsiiSerializable, CommonStringParameterAttributes

Attributes for secure string parameters.

Example:

 Number parameterVersion = Token.asNumber(Map.of("Ref", "MyParameter"));
 // 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());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SecureStringParameterAttributes.Builder	builder()
default IKey	getEncryptionKey()	The encryption key that is used to encrypt this 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 Details

getEncryptionKey

@Stability(Stable)
@Nullable
default IKey getEncryptionKey()

The encryption key that is used to encrypt this parameter.

Default: - default master key

getVersion

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

The version number of the value you wish to retrieve.

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

builder

@Stability(Stable)
static SecureStringParameterAttributes.Builder builder()

Returns:

a SecureStringParameterAttributes.Builder of SecureStringParameterAttributes