Package software.amazon.awscdk.services.ssm

Class CommonStringParameterAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CommonStringParameterAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CommonStringParameterAttributes>

Enclosing interface:

CommonStringParameterAttributes

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

A builder for CommonStringParameterAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CommonStringParameterAttributes	build()	Builds the configured instance.
CommonStringParameterAttributes.Builder	parameterName(String parameterName)	Sets the value of CommonStringParameterAttributes.getParameterName()
CommonStringParameterAttributes.Builder	simpleName(Boolean simpleName)	Sets the value of CommonStringParameterAttributes.getSimpleName()

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

parameterName

@Stability(Stable)
public CommonStringParameterAttributes.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 CommonStringParameterAttributes.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 CommonStringParameterAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CommonStringParameterAttributes

Throws:

NullPointerException - if any required attribute was not provided