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
-
Method Summary
Modifier and TypeMethodDescriptionallowedPattern
(String allowedPattern) Sets the value ofParameterOptions.getAllowedPattern()
build()
Builds the configured instance.dataType
(ParameterDataType dataType) Sets the value ofStringParameterProps.getDataType()
description
(String description) Sets the value ofParameterOptions.getDescription()
parameterName
(String parameterName) Sets the value ofParameterOptions.getParameterName()
simpleName
(Boolean simpleName) Sets the value ofParameterOptions.getSimpleName()
stringValue
(String stringValue) Sets the value ofStringParameterProps.getStringValue()
tier
(ParameterTier tier) Sets the value ofParameterOptions.getTier()
type
(ParameterType type) Sets the value ofStringParameterProps.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
stringValue
Sets the value ofStringParameterProps.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
Sets the value ofStringParameterProps.getDataType()
- Parameters:
dataType
- The data type of the parameter, such astext
oraws:ec2:image
.- Returns:
this
-
type
Sets the value ofStringParameterProps.getType()
- Parameters:
type
- The type of the string parameter.- Returns:
this
-
allowedPattern
Sets the value ofParameterOptions.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
Sets the value ofParameterOptions.getDescription()
- Parameters:
description
- Information about the parameter that you want to add to the system.- Returns:
this
-
parameterName
Sets the value ofParameterOptions.getParameterName()
- Parameters:
parameterName
- The name of the parameter.- Returns:
this
-
simpleName
Sets the value ofParameterOptions.getSimpleName()
- Parameters:
simpleName
- Indicates of the parameter name is a simple name (i.e. does not include "/" separators). This is only required only ifparameterName
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.- Returns:
this
-
tier
Sets the value ofParameterOptions.getTier()
- Parameters:
tier
- The tier of the string parameter.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<StringParameterProps>
- Returns:
- a new instance of
StringParameterProps
- Throws:
NullPointerException
- if any required attribute was not provided
-