Package software.amazon.awscdk.services.ssm

Class StringParameter.Builder

java.lang.Object
software.amazon.awscdk.services.ssm.StringParameter.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<StringParameter>
Enclosing class:
StringParameter
@Stability(Stable) public static final class StringParameter.Builder extends Object implements software.amazon.jsii.Builder<StringParameter>
A fluent builder for StringParameter.

  • Method Details

    • create

      @Stability(Stable) public static StringParameter.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of StringParameter.Builder.

    • allowedPattern

      @Stability(Stable) public StringParameter.Builder allowedPattern(String 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

      @Stability(Stable) public StringParameter.Builder description(String 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

      @Stability(Stable) public StringParameter.Builder parameterName(String 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

      @Stability(Stable) public StringParameter.Builder simpleName(Boolean 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.

      Default: - auto-detect based on `parameterName`

      Parameters:
      simpleName - Indicates whether the parameter name is a simple name. This parameter is required.
      Returns:
      this

    • tier

      @Stability(Stable) public StringParameter.Builder tier(ParameterTier tier)
      The tier of the string parameter.

      Default: - undefined

      Parameters:
      tier - The tier of the string parameter. This parameter is required.
      Returns:
      this

    • stringValue

      @Stability(Stable) public StringParameter.Builder stringValue(String stringValue)
      The value of the parameter.

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

      Parameters:
      stringValue - The value of the parameter. This parameter is required.
      Returns:
      this

    • dataType

      @Stability(Stable) public StringParameter.Builder dataType(ParameterDataType dataType)
      The data type of the parameter, such as text or aws:ec2:image.

      Default: ParameterDataType.TEXT

      Parameters:
      dataType - The data type of the parameter, such as text or aws:ec2:image. This parameter is required.
      Returns:
      this

    • type

      @Stability(Deprecated) @Deprecated public StringParameter.Builder type(ParameterType type)
      Deprecated.
      • type will always be 'String'
      (deprecated) The type of the string parameter.

      Default: ParameterType.STRING

      Parameters:
      type - The type of the string parameter. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public StringParameter build()
      Specified by:
      build in interface software.amazon.jsii.Builder<StringParameter>
      Returns:
      a newly built instance of StringParameter.