@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ParameterDefinition extends Object implements Serializable, Cloneable, StructuredPojo
Parameters supported by the application.
Constructor and Description |
---|
ParameterDefinition() |
Modifier and Type | Method and Description |
---|---|
ParameterDefinition |
clone() |
boolean |
equals(Object obj) |
String |
getAllowedPattern()
A regular expression that represents the patterns to allow for String types.
|
List<String> |
getAllowedValues()
Array containing the list of values allowed for the parameter.
|
String |
getConstraintDescription()
A string that explains a constraint when the constraint is violated.
|
String |
getDefaultValue()
A value of the appropriate type for the template to use if no value is specified when a stack is created.
|
String |
getDescription()
A string of up to 4,000 characters that describes the parameter.
|
Integer |
getMaxLength()
An integer value that determines the largest number of characters you want to allow for String types.
|
Integer |
getMaxValue()
A numeric value that determines the largest numeric value you want to allow for Number types.
|
Integer |
getMinLength()
An integer value that determines the smallest number of characters you want to allow for String types.
|
Integer |
getMinValue()
A numeric value that determines the smallest numeric value you want to allow for Number types.
|
String |
getName()
The name of the parameter.
|
Boolean |
getNoEcho()
Whether to mask the parameter value whenever anyone makes a call that describes the stack.
|
List<String> |
getReferencedByResources()
A list of AWS SAM resources that use this parameter.
|
String |
getType()
The type of the parameter.
|
int |
hashCode() |
Boolean |
isNoEcho()
Whether to mask the parameter value whenever anyone makes a call that describes the stack.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAllowedPattern(String allowedPattern)
A regular expression that represents the patterns to allow for String types.
|
void |
setAllowedValues(Collection<String> allowedValues)
Array containing the list of values allowed for the parameter.
|
void |
setConstraintDescription(String constraintDescription)
A string that explains a constraint when the constraint is violated.
|
void |
setDefaultValue(String defaultValue)
A value of the appropriate type for the template to use if no value is specified when a stack is created.
|
void |
setDescription(String description)
A string of up to 4,000 characters that describes the parameter.
|
void |
setMaxLength(Integer maxLength)
An integer value that determines the largest number of characters you want to allow for String types.
|
void |
setMaxValue(Integer maxValue)
A numeric value that determines the largest numeric value you want to allow for Number types.
|
void |
setMinLength(Integer minLength)
An integer value that determines the smallest number of characters you want to allow for String types.
|
void |
setMinValue(Integer minValue)
A numeric value that determines the smallest numeric value you want to allow for Number types.
|
void |
setName(String name)
The name of the parameter.
|
void |
setNoEcho(Boolean noEcho)
Whether to mask the parameter value whenever anyone makes a call that describes the stack.
|
void |
setReferencedByResources(Collection<String> referencedByResources)
A list of AWS SAM resources that use this parameter.
|
void |
setType(String type)
The type of the parameter.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
ParameterDefinition |
withAllowedPattern(String allowedPattern)
A regular expression that represents the patterns to allow for String types.
|
ParameterDefinition |
withAllowedValues(Collection<String> allowedValues)
Array containing the list of values allowed for the parameter.
|
ParameterDefinition |
withAllowedValues(String... allowedValues)
Array containing the list of values allowed for the parameter.
|
ParameterDefinition |
withConstraintDescription(String constraintDescription)
A string that explains a constraint when the constraint is violated.
|
ParameterDefinition |
withDefaultValue(String defaultValue)
A value of the appropriate type for the template to use if no value is specified when a stack is created.
|
ParameterDefinition |
withDescription(String description)
A string of up to 4,000 characters that describes the parameter.
|
ParameterDefinition |
withMaxLength(Integer maxLength)
An integer value that determines the largest number of characters you want to allow for String types.
|
ParameterDefinition |
withMaxValue(Integer maxValue)
A numeric value that determines the largest numeric value you want to allow for Number types.
|
ParameterDefinition |
withMinLength(Integer minLength)
An integer value that determines the smallest number of characters you want to allow for String types.
|
ParameterDefinition |
withMinValue(Integer minValue)
A numeric value that determines the smallest numeric value you want to allow for Number types.
|
ParameterDefinition |
withName(String name)
The name of the parameter.
|
ParameterDefinition |
withNoEcho(Boolean noEcho)
Whether to mask the parameter value whenever anyone makes a call that describes the stack.
|
ParameterDefinition |
withReferencedByResources(Collection<String> referencedByResources)
A list of AWS SAM resources that use this parameter.
|
ParameterDefinition |
withReferencedByResources(String... referencedByResources)
A list of AWS SAM resources that use this parameter.
|
ParameterDefinition |
withType(String type)
The type of the parameter.
|
public void setAllowedPattern(String allowedPattern)
A regular expression that represents the patterns to allow for String types.
allowedPattern
- A regular expression that represents the patterns to allow for String types.public String getAllowedPattern()
A regular expression that represents the patterns to allow for String types.
public ParameterDefinition withAllowedPattern(String allowedPattern)
A regular expression that represents the patterns to allow for String types.
allowedPattern
- A regular expression that represents the patterns to allow for String types.public List<String> getAllowedValues()
Array containing the list of values allowed for the parameter.
public void setAllowedValues(Collection<String> allowedValues)
Array containing the list of values allowed for the parameter.
allowedValues
- Array containing the list of values allowed for the parameter.public ParameterDefinition withAllowedValues(String... allowedValues)
Array containing the list of values allowed for the parameter.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedValues(java.util.Collection)
or withAllowedValues(java.util.Collection)
if you want
to override the existing values.
allowedValues
- Array containing the list of values allowed for the parameter.public ParameterDefinition withAllowedValues(Collection<String> allowedValues)
Array containing the list of values allowed for the parameter.
allowedValues
- Array containing the list of values allowed for the parameter.public void setConstraintDescription(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.
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.
public String getConstraintDescription()
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.
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.
public ParameterDefinition withConstraintDescription(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.
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.
public void setDefaultValue(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.
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.public String getDefaultValue()
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.
public ParameterDefinition withDefaultValue(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.
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.public void setDescription(String description)
A string of up to 4,000 characters that describes the parameter.
description
- A string of up to 4,000 characters that describes the parameter.public String getDescription()
A string of up to 4,000 characters that describes the parameter.
public ParameterDefinition withDescription(String description)
A string of up to 4,000 characters that describes the parameter.
description
- A string of up to 4,000 characters that describes the parameter.public void setMaxLength(Integer maxLength)
An integer value that determines the largest number of characters you want to allow for String types.
maxLength
- An integer value that determines the largest number of characters you want to allow for String types.public Integer getMaxLength()
An integer value that determines the largest number of characters you want to allow for String types.
public ParameterDefinition withMaxLength(Integer maxLength)
An integer value that determines the largest number of characters you want to allow for String types.
maxLength
- An integer value that determines the largest number of characters you want to allow for String types.public void setMaxValue(Integer maxValue)
A numeric value that determines the largest numeric value you want to allow for Number types.
maxValue
- A numeric value that determines the largest numeric value you want to allow for Number types.public Integer getMaxValue()
A numeric value that determines the largest numeric value you want to allow for Number types.
public ParameterDefinition withMaxValue(Integer maxValue)
A numeric value that determines the largest numeric value you want to allow for Number types.
maxValue
- A numeric value that determines the largest numeric value you want to allow for Number types.public void setMinLength(Integer minLength)
An integer value that determines the smallest number of characters you want to allow for String types.
minLength
- An integer value that determines the smallest number of characters you want to allow for String types.public Integer getMinLength()
An integer value that determines the smallest number of characters you want to allow for String types.
public ParameterDefinition withMinLength(Integer minLength)
An integer value that determines the smallest number of characters you want to allow for String types.
minLength
- An integer value that determines the smallest number of characters you want to allow for String types.public void setMinValue(Integer minValue)
A numeric value that determines the smallest numeric value you want to allow for Number types.
minValue
- A numeric value that determines the smallest numeric value you want to allow for Number types.public Integer getMinValue()
A numeric value that determines the smallest numeric value you want to allow for Number types.
public ParameterDefinition withMinValue(Integer minValue)
A numeric value that determines the smallest numeric value you want to allow for Number types.
minValue
- A numeric value that determines the smallest numeric value you want to allow for Number types.public void setName(String name)
The name of the parameter.
name
- The name of the parameter.public String getName()
The name of the parameter.
public ParameterDefinition withName(String name)
The name of the parameter.
name
- The name of the parameter.public void setNoEcho(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 (*****).
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 (*****).public Boolean getNoEcho()
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 (*****).
public ParameterDefinition withNoEcho(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 (*****).
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 (*****).public Boolean isNoEcho()
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 (*****).
public List<String> getReferencedByResources()
A list of AWS SAM resources that use this parameter.
public void setReferencedByResources(Collection<String> referencedByResources)
A list of AWS SAM resources that use this parameter.
referencedByResources
- A list of AWS SAM resources that use this parameter.public ParameterDefinition withReferencedByResources(String... referencedByResources)
A list of AWS SAM resources that use this parameter.
NOTE: This method appends the values to the existing list (if any). Use
setReferencedByResources(java.util.Collection)
or
withReferencedByResources(java.util.Collection)
if you want to override the existing values.
referencedByResources
- A list of AWS SAM resources that use this parameter.public ParameterDefinition withReferencedByResources(Collection<String> referencedByResources)
A list of AWS SAM resources that use this parameter.
referencedByResources
- A list of AWS SAM resources that use this parameter.public void setType(String type)
The type of the parameter.
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users could 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 could 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
type
- The type of the parameter.
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users could 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 could 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
public String getType()
The type of the parameter.
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users could 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 could 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users could 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 could 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
public ParameterDefinition withType(String type)
The type of the parameter.
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users could 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 could 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
type
- The type of the parameter.
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users could 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 could 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
public String toString()
toString
in class Object
Object.toString()
public ParameterDefinition clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.