Package software.amazon.awssdk.services.serverlessapplicationrepository.model

Interface ParameterDefinition.Builder

    • Method Detail

      • allowedPattern

        ParameterDefinition.Builder allowedPattern​(String allowedPattern)

        A regular expression that represents the patterns to allow for String types.

        Parameters:
        allowedPattern - A regular expression that represents the patterns to allow for String types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowedValues

        ParameterDefinition.Builder allowedValues​(Collection<String> allowedValues)

        An array containing the list of values allowed for the parameter.

        Parameters:
        allowedValues - An array containing the list of values allowed for the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowedValues

        ParameterDefinition.Builder allowedValues​(String... allowedValues)

        An array containing the list of values allowed for the parameter.

        Parameters:
        allowedValues - An array containing the list of values allowed for the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • constraintDescription

        ParameterDefinition.Builder constraintDescription​(String constraintDescription)

        A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

        Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

        By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display the following customized error message:

        Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

        Parameters:
        constraintDescription - A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

        Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

        By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display the following customized error message:

        Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultValue

        ParameterDefinition.Builder defaultValue​(String defaultValue)

        A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

        Parameters:
        defaultValue - A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        ParameterDefinition.Builder description​(String description)

        A string of up to 4,000 characters that describes the parameter.

        Parameters:
        description - A string of up to 4,000 characters that describes the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxLength

        ParameterDefinition.Builder maxLength​(Integer maxLength)

        An integer value that determines the largest number of characters that you want to allow for String types.

        Parameters:
        maxLength - An integer value that determines the largest number of characters that you want to allow for String types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxValue

        ParameterDefinition.Builder maxValue​(Integer maxValue)

        A numeric value that determines the largest numeric value that you want to allow for Number types.

        Parameters:
        maxValue - A numeric value that determines the largest numeric value that you want to allow for Number types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minLength

        ParameterDefinition.Builder minLength​(Integer minLength)

        An integer value that determines the smallest number of characters that you want to allow for String types.

        Parameters:
        minLength - An integer value that determines the smallest number of characters that you want to allow for String types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minValue

        ParameterDefinition.Builder minValue​(Integer minValue)

        A numeric value that determines the smallest numeric value that you want to allow for Number types.

        Parameters:
        minValue - A numeric value that determines the smallest numeric value that you want to allow for Number types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        ParameterDefinition.Builder name​(String name)

        The name of the parameter.

        Parameters:
        name - The name of the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • noEcho

        ParameterDefinition.Builder noEcho​(Boolean noEcho)

        Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).

        Parameters:
        noEcho - Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • referencedByResources

        ParameterDefinition.Builder referencedByResources​(Collection<String> referencedByResources)

        A list of AWS SAM resources that use this parameter.

        Parameters:
        referencedByResources - A list of AWS SAM resources that use this parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • referencedByResources

        ParameterDefinition.Builder referencedByResources​(String... referencedByResources)

        A list of AWS SAM resources that use this parameter.

        Parameters:
        referencedByResources - A list of AWS SAM resources that use this parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        ParameterDefinition.Builder type​(String type)

        The type of the parameter.

        Valid values: String | Number | List<Number> | CommaDelimitedList

        String: A literal string.

        For example, users can specify "MyUserName".

        Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

        For example, users might specify "8888".

        List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

        For example, users might specify "80,20", and then Ref results in ["80","20"].

        CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.

        For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

        Parameters:
        type - The type of the parameter.

        Valid values: String | Number | List<Number> | CommaDelimitedList

        String: A literal string.

        For example, users can specify "MyUserName".

        Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

        For example, users might specify "8888".

        List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

        For example, users might specify "80,20", and then Ref results in ["80","20"].

        CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.

        For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

        Returns:
        Returns a reference to this object so that method calls can be chained together.