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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:08.026Z")
 @Stability(value=Experimental)
public interface SecureStringParameterAttributes
extends software.amazon.jsii.JsiiSerializable, CommonStringParameterAttributes

(experimental) Attributes for secure string parameters.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.ssm.*;
 Key key;
 SecureStringParameterAttributes secureStringParameterAttributes = SecureStringParameterAttributes.builder()
         .parameterName("parameterName")
         .version(123)
         // the properties below are optional
         .encryptionKey(key)
         .simpleName(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

getEncryptionKey

@Stability(value=Experimental)
 @Nullable
default IKey getEncryptionKey()

(experimental) The encryption key that is used to encrypt this parameter.

Default: - default master key

getVersion

@Stability(value=Experimental)
 @NotNull
Number getVersion()

(experimental) The version number of the value you wish to retrieve.

This is required for secure strings.

builder

@Stability(value=Experimental)
static SecureStringParameterAttributes.Builder builder()

Specified by:

builder in interface CommonStringParameterAttributes

Returns:

a SecureStringParameterAttributes.Builder of SecureStringParameterAttributes