software.amazon.awscdk.services.ssm

Class StringParameterAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.StringParameterAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StringParameterAttributes>

Enclosing interface:

StringParameterAttributes

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

A builder for StringParameterAttributes

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StringParameterAttributes	build() Builds the configured instance.
StringParameterAttributes.Builder	parameterName(String parameterName) Sets the value of CommonStringParameterAttributes.getParameterName()
StringParameterAttributes.Builder	simpleName(Boolean simpleName) Sets the value of CommonStringParameterAttributes.getSimpleName()
StringParameterAttributes.Builder	type(ParameterType type) Deprecated. - use valueType instead
StringParameterAttributes.Builder	valueType(ParameterValueType valueType) Sets the value of StringParameterAttributes.getValueType()
StringParameterAttributes.Builder	version(Number version) Sets the value of StringParameterAttributes.getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

type

@Stability(value=Deprecated)
 @Deprecated
public StringParameterAttributes.Builder type(ParameterType type)

Deprecated. - use valueType instead

Sets the value of StringParameterAttributes.getType()

Parameters:

type - The type of the string parameter.

Returns:

this

valueType

@Stability(value=Stable)
public StringParameterAttributes.Builder valueType(ParameterValueType valueType)

Sets the value of StringParameterAttributes.getValueType()

Parameters:

valueType - The type of the string parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

Returns:

this

version

@Stability(value=Stable)
public StringParameterAttributes.Builder version(Number version)

Sets the value of StringParameterAttributes.getVersion()

Parameters:

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

Returns:

this

parameterName

@Stability(value=Stable)
public StringParameterAttributes.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(value=Stable)
public StringParameterAttributes.Builder simpleName(Boolean simpleName)

Sets the value of CommonStringParameterAttributes.getSimpleName()

Parameters:

simpleName - Indicates of the parameter name is a simple name (i.e. does not include "/" separators). This is only 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(value=Stable)
public StringParameterAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StringParameterAttributes

Throws:

NullPointerException - if any required attribute was not provided