Package software.amazon.awscdk.services.ssm

Class SecureStringParameterAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.SecureStringParameterAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SecureStringParameterAttributes>

Enclosing interface:

SecureStringParameterAttributes

@Stability(Stable)
public static final class SecureStringParameterAttributes.Builder
extends Object
implements software.amazon.jsii.Builder<SecureStringParameterAttributes>

A builder for SecureStringParameterAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SecureStringParameterAttributes	build()	Builds the configured instance.
SecureStringParameterAttributes.Builder	encryptionKey(IKey encryptionKey)	Sets the value of SecureStringParameterAttributes.getEncryptionKey()
SecureStringParameterAttributes.Builder	parameterName(String parameterName)	Sets the value of CommonStringParameterAttributes.getParameterName()
SecureStringParameterAttributes.Builder	simpleName(Boolean simpleName)	Sets the value of CommonStringParameterAttributes.getSimpleName()
SecureStringParameterAttributes.Builder	version(Number version)	Sets the value of SecureStringParameterAttributes.getVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

encryptionKey

@Stability(Stable)
public SecureStringParameterAttributes.Builder encryptionKey(IKey encryptionKey)

Sets the value of SecureStringParameterAttributes.getEncryptionKey()

Parameters:

encryptionKey - The encryption key that is used to encrypt this parameter.

Returns:

this

version

@Stability(Stable)
public SecureStringParameterAttributes.Builder version(Number version)

Sets the value of SecureStringParameterAttributes.getVersion()

Parameters:

version - The version number of the value you wish to retrieve.

Returns:

this

parameterName

@Stability(Stable)
public SecureStringParameterAttributes.Builder parameterName(String parameterName)

Sets the value of CommonStringParameterAttributes.getParameterName()

Parameters:

parameterName - The name of the parameter store value. This parameter is required. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

Returns:

this

simpleName

@Stability(Stable)
public SecureStringParameterAttributes.Builder simpleName(Boolean simpleName)

Sets the value of CommonStringParameterAttributes.getSimpleName()

Parameters:

simpleName - Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN.

This is required only if parameterName is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs.

If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

Returns:

this

build

@Stability(Stable)
public SecureStringParameterAttributes build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SecureStringParameterAttributes>

Returns:

a new instance of SecureStringParameterAttributes

Throws:

NullPointerException - if any required attribute was not provided