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(Stable)
public static final class StringListParameter.Builder
extends Object
implements software.amazon.jsii.Builder<StringListParameter>
A fluent builder for
StringListParameter
.-
Method Summary
Modifier and TypeMethodDescriptionallowedPattern
(String allowedPattern) A regular expression used to validate the parameter value.build()
static StringListParameter.Builder
description
(String description) Information about the parameter that you want to add to the system.parameterName
(String parameterName) The name of the parameter.simpleName
(Boolean simpleName) Indicates of the parameter name is a simple name (i.e.stringListValue
(List<String> stringListValue) The values of the parameter.tier
(ParameterTier tier) The tier of the string parameter.
-
Method Details
-
create
@Stability(Stable) 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
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
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
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
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 betrue
(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
The tier of the string parameter.Default: - undefined
- Parameters:
tier
- The tier of the string parameter. This parameter is required.- Returns:
this
-
stringListValue
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
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<StringListParameter>
- Returns:
- a newly built instance of
StringListParameter
.
-