software.amazon.awscdk.services.ssm

Class StringListParameter.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.StringListParameter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StringListParameter>

Enclosing class:

StringListParameter

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

(experimental) A fluent builder for StringListParameter.

Method Summary

Modifier and Type	Method and Description
StringListParameter.Builder	allowedPattern(String allowedPattern) (experimental) A regular expression used to validate the parameter value.
StringListParameter	build()
static StringListParameter.Builder	create(software.constructs.Construct scope, String id)
StringListParameter.Builder	description(String description) (experimental) Information about the parameter that you want to add to the system.
StringListParameter.Builder	parameterName(String parameterName) (experimental) The name of the parameter.
StringListParameter.Builder	simpleName(Boolean simpleName) (experimental) Indicates of the parameter name is a simple name (i.e.
StringListParameter.Builder	stringListValue(List<String> stringListValue) (experimental) The values of the parameter.
StringListParameter.Builder	tier(ParameterTier tier) (experimental) The tier of the string parameter.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static StringListParameter.Builder create(software.constructs.Construct scope,
                                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of StringListParameter.Builder.

allowedPattern

@Stability(value=Experimental)
public StringListParameter.Builder allowedPattern(String allowedPattern)

(experimental) 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+$

Default: no validation is performed

Parameters:

allowedPattern - A regular expression used to validate the parameter value. This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public StringListParameter.Builder description(String description)

(experimental) Information about the parameter that you want to add to the system.

Default: none

Parameters:

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

Returns:

this

parameterName

@Stability(value=Experimental)
public StringListParameter.Builder parameterName(String parameterName)

(experimental) The name of the parameter.

Default: - a name will be generated by CloudFormation

Parameters:

parameterName - The name of the parameter. This parameter is required.

Returns:

this

simpleName

@Stability(value=Experimental)
public StringListParameter.Builder simpleName(Boolean simpleName)

(experimental) 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.

Default: - auto-detect based on `parameterName`

Parameters:

simpleName - Indicates of the parameter name is a simple name (i.e. does not include "/" separators). This parameter is required.

Returns:

this

tier

@Stability(value=Experimental)
public StringListParameter.Builder tier(ParameterTier tier)

(experimental) The tier of the string parameter.

Default: - undefined

Parameters:

tier - The tier of the string parameter. This parameter is required.

Returns:

this

stringListValue

@Stability(value=Experimental)
public StringListParameter.Builder stringListValue(List<String> stringListValue)

(experimental) The values of the parameter.

It may not reference another parameter and {{}} cannot be used in the value.

Parameters:

stringListValue - The values of the parameter. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public StringListParameter build()

Specified by:

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