Package software.amazon.awscdk.services.ssm

Class StringParameterProps.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.StringParameterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StringParameterProps>

Enclosing interface:

StringParameterProps

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

A builder for StringParameterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StringParameterProps.Builder	allowedPattern(String allowedPattern)	Sets the value of ParameterOptions.getAllowedPattern()
StringParameterProps	build()	Builds the configured instance.
StringParameterProps.Builder	dataType(ParameterDataType dataType)	Sets the value of StringParameterProps.getDataType()
StringParameterProps.Builder	description(String description)	Sets the value of ParameterOptions.getDescription()
StringParameterProps.Builder	parameterName(String parameterName)	Sets the value of ParameterOptions.getParameterName()
StringParameterProps.Builder	simpleName(Boolean simpleName)	Sets the value of ParameterOptions.getSimpleName()
StringParameterProps.Builder	stringValue(String stringValue)	Sets the value of StringParameterProps.getStringValue()
StringParameterProps.Builder	tier(ParameterTier tier)	Sets the value of ParameterOptions.getTier()
StringParameterProps.Builder	type(ParameterType type)	Deprecated. - type will always be 'String'

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

stringValue

@Stability(Stable)
public StringParameterProps.Builder stringValue(String stringValue)

Sets the value of StringParameterProps.getStringValue()

Parameters:

stringValue - The value of the parameter. This parameter is required. It may not reference another parameter and {{}} cannot be used in the value.

Returns:

this

dataType

@Stability(Stable)
public StringParameterProps.Builder dataType(ParameterDataType dataType)

Sets the value of StringParameterProps.getDataType()

Parameters:

dataType - The data type of the parameter, such as text or aws:ec2:image.

Returns:

this

type

@Stability(Deprecated)
@Deprecated
public StringParameterProps.Builder type(ParameterType type)

Deprecated.

- type will always be 'String'

Sets the value of StringParameterProps.getType()

Parameters:

type - The type of the string parameter.

Returns:

this

allowedPattern

@Stability(Stable)
public StringParameterProps.Builder allowedPattern(String allowedPattern)

Sets the value of ParameterOptions.getAllowedPattern()

Parameters:

allowedPattern - A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ^\d+$

Returns:

this

description

@Stability(Stable)
public StringParameterProps.Builder description(String description)

Sets the value of ParameterOptions.getDescription()

Parameters:

description - Information about the parameter that you want to add to the system.

Returns:

this

parameterName

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

Sets the value of ParameterOptions.getParameterName()

Parameters:

parameterName - The name of the parameter.

Returns:

this

simpleName

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

Sets the value of ParameterOptions.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

tier

@Stability(Stable)
public StringParameterProps.Builder tier(ParameterTier tier)

Sets the value of ParameterOptions.getTier()

Parameters:

tier - The tier of the string parameter.

Returns:

this

build

@Stability(Stable)
public StringParameterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StringParameterProps

Throws:

NullPointerException - if any required attribute was not provided