@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ParameterDefinition extends Object implements Serializable, Cloneable, StructuredPojo
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.\n If
you define constraints for the parameter, you must specify a value that adheres to those constraints.
|
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 SAM resources that use this parameter.
|
String |
getType()
The type of the parameter.\nValid values: String | Number | List
|
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.\n If
you define constraints for the parameter, you must specify a value that adheres to those constraints.
|
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 SAM resources that use this parameter.
|
void |
setType(String type)
The type of the parameter.\nValid values: String | Number | List
|
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.\n If
you define constraints for the parameter, you must specify a value that adheres to those constraints.
|
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 SAM resources that use this parameter.
|
ParameterDefinition |
withReferencedByResources(String... referencedByResources)
A list of SAM resources that use this parameter.
|
ParameterDefinition |
withType(String type)
The type of the parameter.\nValid values: String | Number | List
|
public void setAllowedPattern(String allowedPattern)
allowedPattern
- A regular expression that represents the patterns to allow for String types.public String getAllowedPattern()
public ParameterDefinition withAllowedPattern(String allowedPattern)
allowedPattern
- A regular expression that represents the patterns to allow for String types.public List<String> getAllowedValues()
public void setAllowedValues(Collection<String> allowedValues)
allowedValues
- Array containing the list of values allowed for the parameter.public ParameterDefinition withAllowedValues(String... allowedValues)
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)
allowedValues
- Array containing the list of values allowed for the parameter.public void setConstraintDescription(String constraintDescription)
constraintDescription
- A string that explains a constraint when the constraint is violated. For example, without a constraint
description,\n a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error
message when the user\n specifies an invalid value:\n\n Malformed input-Parameter MyParameter must match
pattern [A-Za-z0-9]+ \n \nBy adding a constraint description, such as
"must contain only uppercase and lowercase letters, and numbers," you can display\n the following
customized error message:\n\n Malformed input-Parameter MyParameter must contain only uppercase and
lowercase letters and numbers.public String getConstraintDescription()
public ParameterDefinition withConstraintDescription(String constraintDescription)
constraintDescription
- A string that explains a constraint when the constraint is violated. For example, without a constraint
description,\n a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error
message when the user\n specifies an invalid value:\n\n Malformed input-Parameter MyParameter must match
pattern [A-Za-z0-9]+ \n \nBy adding a constraint description, such as
"must contain only uppercase and lowercase letters, and numbers," you can display\n the following
customized error message:\n\n Malformed input-Parameter MyParameter must contain only uppercase and
lowercase letters and numbers.public void setDefaultValue(String defaultValue)
defaultValue
- A value of the appropriate type for the template to use if no value is specified when a stack is
created.\n If you define constraints for the parameter, you must specify a value that adheres to those
constraints.public String getDefaultValue()
public ParameterDefinition withDefaultValue(String defaultValue)
defaultValue
- A value of the appropriate type for the template to use if no value is specified when a stack is
created.\n If you define constraints for the parameter, you must specify a value that adheres to those
constraints.public void setDescription(String description)
description
- A string of up to 4,000 characters that describes the parameter.public String getDescription()
public ParameterDefinition withDescription(String description)
description
- A string of up to 4,000 characters that describes the parameter.public void setMaxLength(Integer maxLength)
maxLength
- An integer value that determines the largest number of characters you want to allow for String types.public Integer getMaxLength()
public ParameterDefinition withMaxLength(Integer maxLength)
maxLength
- An integer value that determines the largest number of characters you want to allow for String types.public void setMaxValue(Integer maxValue)
maxValue
- A numeric value that determines the largest numeric value you want to allow for Number types.public Integer getMaxValue()
public ParameterDefinition withMaxValue(Integer maxValue)
maxValue
- A numeric value that determines the largest numeric value you want to allow for Number types.public void setMinLength(Integer minLength)
minLength
- An integer value that determines the smallest number of characters you want to allow for String types.public Integer getMinLength()
public ParameterDefinition withMinLength(Integer minLength)
minLength
- An integer value that determines the smallest number of characters you want to allow for String types.public void setMinValue(Integer minValue)
minValue
- A numeric value that determines the smallest numeric value you want to allow for Number types.public Integer getMinValue()
public ParameterDefinition withMinValue(Integer minValue)
minValue
- A numeric value that determines the smallest numeric value you want to allow for Number types.public void setName(String name)
name
- The name of the parameter.public String getName()
public ParameterDefinition withName(String name)
name
- The name of the parameter.public void setNoEcho(Boolean noEcho)
noEcho
- Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set
the\n value to true, the parameter value is masked with asterisks (*****).public Boolean getNoEcho()
public ParameterDefinition withNoEcho(Boolean noEcho)
noEcho
- Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set
the\n value to true, the parameter value is masked with asterisks (*****).public Boolean isNoEcho()
public List<String> getReferencedByResources()
public void setReferencedByResources(Collection<String> referencedByResources)
referencedByResources
- A list of SAM resources that use this parameter.public ParameterDefinition withReferencedByResources(String... referencedByResources)
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 SAM resources that use this parameter.public ParameterDefinition withReferencedByResources(Collection<String> referencedByResources)
referencedByResources
- A list of SAM resources that use this parameter.public void setType(String type)
type
- The type of the parameter.\nValid values: String | Number | Listpublic String getType()
public ParameterDefinition withType(String type)
type
- The type of the parameter.\nValid values: String | Number | Listpublic 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.