Package software.amazon.awscdk.services.ssm

Class CfnParameterProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • type

      @Stability(Stable) public CfnParameterProps.Builder type(String type)
      Sets the value of CfnParameterProps.getType()
      Parameters:
      type - The type of parameter. This parameter is required.

      AWS CloudFormation doesn't support creating a SecureString parameter type.

      Allowed Values : String | StringList

      Returns:
      this

    • value

      @Stability(Stable) public CfnParameterProps.Builder value(String value)
      Sets the value of CfnParameterProps.getValue()
      Parameters:
      value - The parameter value. This parameter is required.

      If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

      Returns:
      this

    • allowedPattern

      @Stability(Stable) public CfnParameterProps.Builder allowedPattern(String allowedPattern)
      Sets the value of CfnParameterProps.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: AllowedPattern=^\d+$
      Returns:
      this

    • dataType

      @Stability(Stable) public CfnParameterProps.Builder dataType(String dataType)
      Sets the value of CfnParameterProps.getDataType()
      Parameters:
      dataType - The data type of the parameter, such as text or aws:ec2:image . The default is text .
      Returns:
      this

    • description

      @Stability(Stable) public CfnParameterProps.Builder description(String description)
      Sets the value of CfnParameterProps.getDescription()
      Parameters:
      description - Information about the parameter.
      Returns:
      this

    • name

      @Stability(Stable) public CfnParameterProps.Builder name(String name)
      Sets the value of CfnParameterProps.getName()
      Parameters:
      name - The name of the parameter.

      The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

      Returns:
      this

    • policies

      @Stability(Stable) public CfnParameterProps.Builder policies(String policies)
      Sets the value of CfnParameterProps.getPolicies()
      Parameters:
      policies - Information about the policies assigned to a parameter. Assigning parameter policies in the AWS Systems Manager User Guide .
      Returns:
      this

    • tags

      @Stability(Stable) public CfnParameterProps.Builder tags(Object tags)
      Sets the value of CfnParameterProps.getTags()
      Parameters:
      tags - Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
      Returns:
      this

    • tier

      @Stability(Stable) public CfnParameterProps.Builder tier(String tier)
      Sets the value of CfnParameterProps.getTier()
      Parameters:
      tier - The parameter tier.
      Returns:
      this

    • build

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