ParameterDefinition (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.serverlessapplicationrepository.model.ParameterDefinition

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ParameterDefinition.Builder,ParameterDefinition>

@Generated(value="software.amazon.awssdk:codegen")
public final class ParameterDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParameterDefinition.Builder,ParameterDefinition>

Parameters supported by the application.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ParameterDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ParameterDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`allowedPattern()` A regular expression that represents the patterns to allow for String types.
`List<String>`	`allowedValues()` An array containing the list of values allowed for the parameter.
`static ParameterDefinition.Builder`	`builder()`
`String`	`constraintDescription()` A string that explains a constraint when the constraint is violated.
`String`	`defaultValue()` A value of the appropriate type for the template to use if no value is specified when a stack is created.
`String`	`description()` A string of up to 4,000 characters that describes the parameter.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxLength()` An integer value that determines the largest number of characters that you want to allow for String types.
`Integer`	`maxValue()` A numeric value that determines the largest numeric value that you want to allow for Number types.
`Integer`	`minLength()` An integer value that determines the smallest number of characters that you want to allow for String types.
`Integer`	`minValue()` A numeric value that determines the smallest numeric value that you want to allow for Number types.
`String`	`name()` The name of the parameter.
`Boolean`	`noEcho()` Whether to mask the parameter value whenever anyone makes a call that describes the stack.
`List<String>`	`referencedByResources()` A list of AWS SAM resources that use this parameter.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ParameterDefinition.Builder>`	`serializableBuilderClass()`
`ParameterDefinition.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`type()` The type of the parameter.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - allowedPattern
```
public String allowedPattern()
```
    A regular expression that represents the patterns to allow for String types.
    
    Returns:
    
    A regular expression that represents the patterns to allow for String types.
  - allowedValues
```
public List<String> allowedValues()
```
    An array containing the list of values allowed for the parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array containing the list of values allowed for the parameter.
  - constraintDescription
```
public 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.
    
    Returns:
    
    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.
  - defaultValue
```
public 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.
    
    Returns:
    
    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.
  - description
```
public String description()
```
    A string of up to 4,000 characters that describes the parameter.
    
    Returns:
    
    A string of up to 4,000 characters that describes the parameter.
  - maxLength
```
public Integer maxLength()
```
    An integer value that determines the largest number of characters that you want to allow for String types.
    
    Returns:
    
    An integer value that determines the largest number of characters that you want to allow for String types.
  - maxValue
```
public Integer maxValue()
```
    A numeric value that determines the largest numeric value that you want to allow for Number types.
    
    Returns:
    
    A numeric value that determines the largest numeric value that you want to allow for Number types.
  - minLength
```
public Integer minLength()
```
    An integer value that determines the smallest number of characters that you want to allow for String types.
    
    Returns:
    
    An integer value that determines the smallest number of characters that you want to allow for String types.
  - minValue
```
public Integer minValue()
```
    A numeric value that determines the smallest numeric value that you want to allow for Number types.
    
    Returns:
    
    A numeric value that determines the smallest numeric value that you want to allow for Number types.
  - name
```
public String name()
```
    The name of the parameter.
    
    Returns:
    
    The name of the parameter.
  - noEcho
```
public 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 (*****).
    
    Returns:
    
    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 (*****).
  - referencedByResources
```
public List<String> referencedByResources()
```
    A list of AWS SAM resources that use this parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of AWS SAM resources that use this parameter.
  - type
```
public 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"].
    
    Returns:
    
    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"].
  - toBuilder
```
public ParameterDefinition.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ParameterDefinition.Builder,ParameterDefinition>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ParameterDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ParameterDefinition.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ParameterDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

allowedPattern

allowedValues

constraintDescription

defaultValue

description

maxLength

maxValue

minLength

minValue

name

noEcho

referencedByResources

type

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields