Class ParameterOptions.Builder

java.lang.Object
software.amazon.awscdk.services.ssm.ParameterOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ParameterOptions>
Enclosing interface:
ParameterOptions

@Stability(Stable) public static final class ParameterOptions.Builder extends Object implements software.amazon.jsii.Builder<ParameterOptions>
A builder for ParameterOptions
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • allowedPattern

      @Stability(Stable) public ParameterOptions.Builder allowedPattern(String allowedPattern)
      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 ParameterOptions.Builder description(String description)
      Parameters:
      description - Information about the parameter that you want to add to the system.
      Returns:
      this
    • parameterName

      @Stability(Stable) public ParameterOptions.Builder parameterName(String parameterName)
      Parameters:
      parameterName - The name of the parameter.
      Returns:
      this
    • simpleName

      @Stability(Stable) public ParameterOptions.Builder simpleName(Boolean simpleName)
      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 ParameterOptions.Builder tier(ParameterTier tier)
      Sets the value of ParameterOptions.getTier()
      Parameters:
      tier - The tier of the string parameter.
      Returns:
      this
    • build

      @Stability(Stable) public ParameterOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<ParameterOptions>
      Returns:
      a new instance of ParameterOptions
      Throws:
      NullPointerException - if any required attribute was not provided