Package software.amazon.awscdk.services.ssm

Class ListParameterAttributes.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • elementType

      @Stability(Stable) public ListParameterAttributes.Builder elementType(ParameterValueType elementType)
      Sets the value of ListParameterAttributes.getElementType()
      Parameters:
      elementType - The type of the string list parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

      Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

      Returns:
      this

    • version

      @Stability(Stable) public ListParameterAttributes.Builder version(Number version)
      Sets the value of ListParameterAttributes.getVersion()
      Parameters:
      version - The version number of the value you wish to retrieve.
      Returns:
      this

    • parameterName

      @Stability(Stable) public ListParameterAttributes.Builder parameterName(String parameterName)
      Sets the value of CommonStringParameterAttributes.getParameterName()
      Parameters:
      parameterName - The name of the parameter store value. This parameter is required. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
      Returns:
      this

    • simpleName

      @Stability(Stable) public ListParameterAttributes.Builder simpleName(Boolean simpleName)
      Sets the value of CommonStringParameterAttributes.getSimpleName()
      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

    • build

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