Parameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.Parameter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Parameter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An Systems Manager parameter in Parameter Store.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Parameter()

Constructors
Constructor and Description
`Parameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Parameter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the parameter.
`String`	`getDataType()` The data type of the parameter, such as `text` or `aws:ec2:image`.
`Date`	`getLastModifiedDate()` Date the parameter was last changed or updated and the parameter version was created.
`String`	`getName()` The name of the parameter.
`String`	`getSelector()` Either the version number or the label used to retrieve the parameter value.
`String`	`getSourceResult()` Applies to parameters that reference information in other AWS services.
`String`	`getType()` The type of parameter.
`String`	`getValue()` The parameter value.
`Long`	`getVersion()` The parameter version.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the parameter.
`void`	`setDataType(String dataType)` The data type of the parameter, such as `text` or `aws:ec2:image`.
`void`	`setLastModifiedDate(Date lastModifiedDate)` Date the parameter was last changed or updated and the parameter version was created.
`void`	`setName(String name)` The name of the parameter.
`void`	`setSelector(String selector)` Either the version number or the label used to retrieve the parameter value.
`void`	`setSourceResult(String sourceResult)` Applies to parameters that reference information in other AWS services.
`void`	`setType(ParameterType type)` The type of parameter.
`void`	`setType(String type)` The type of parameter.
`void`	`setValue(String value)` The parameter value.
`void`	`setVersion(Long version)` The parameter version.
`String`	`toString()` Returns a string representation of this object.
`Parameter`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the parameter.
`Parameter`	`withDataType(String dataType)` The data type of the parameter, such as `text` or `aws:ec2:image`.
`Parameter`	`withLastModifiedDate(Date lastModifiedDate)` Date the parameter was last changed or updated and the parameter version was created.
`Parameter`	`withName(String name)` The name of the parameter.
`Parameter`	`withSelector(String selector)` Either the version number or the label used to retrieve the parameter value.
`Parameter`	`withSourceResult(String sourceResult)` Applies to parameters that reference information in other AWS services.
`Parameter`	`withType(ParameterType type)` The type of parameter.
`Parameter`	`withType(String type)` The type of parameter.
`Parameter`	`withValue(String value)` The parameter value.
`Parameter`	`withVersion(Long version)` The parameter version.

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

- Constructor Detail
  - Parameter
```
public Parameter()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the parameter.
    
    Parameters:
    
    name - The name of the parameter.
  - getName
```
public String getName()
```
    The name of the parameter.
    
    Returns:
    
    The name of the parameter.
  - withName
```
public Parameter withName(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.
  - setType
```
public void setType(String type)
```
    The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Parameters:
    
    type - The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    See Also:
    
    ParameterType
  - getType
```
public String getType()
```
    The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Returns:
    
    The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    See Also:
    
    ParameterType
  - withType
```
public Parameter withType(String type)
```
    The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Parameters:
    
    type - The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - setType
```
public void setType(ParameterType type)
```
    The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Parameters:
    
    type - The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    See Also:
    
    ParameterType
  - withType
```
public Parameter withType(ParameterType type)
```
    The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Parameters:
    
    type - The type of parameter. Valid values include the following: String, StringList, and SecureString.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - setValue
```
public void setValue(String value)
```
    The parameter value.
    
    Parameters:
    
    value - The parameter value.
  - getValue
```
public String getValue()
```
    The parameter value.
    
    Returns:
    
    The parameter value.
  - withValue
```
public Parameter withValue(String value)
```
    The parameter value.
    
    Parameters:
    
    value - The parameter value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(Long version)
```
    The parameter version.
    
    Parameters:
    
    version - The parameter version.
  - getVersion
```
public Long getVersion()
```
    The parameter version.
    
    Returns:
    
    The parameter version.
  - withVersion
```
public Parameter withVersion(Long version)
```
    The parameter version.
    
    Parameters:
    
    version - The parameter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSelector
```
public void setSelector(String selector)
```
    Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
    
    parameter_name:version
    
    parameter_name:label
    
    Parameters:
    
    selector - Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
    
    parameter_name:version
    
    parameter_name:label
  - getSelector
```
public String getSelector()
```
    Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
    
    parameter_name:version
    
    parameter_name:label
    
    Returns:
    
    Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
    
    parameter_name:version
    
    parameter_name:label
  - withSelector
```
public Parameter withSelector(String selector)
```
    Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
    
    parameter_name:version
    
    parameter_name:label
    
    Parameters:
    
    selector - Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
    
    parameter_name:version
    
    parameter_name:label
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceResult
```
public void setSourceResult(String sourceResult)
```
    Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
    
    Parameters:
    
    sourceResult - Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
  - getSourceResult
```
public String getSourceResult()
```
    Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
    
    Returns:
    
    Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
  - withSourceResult
```
public Parameter withSourceResult(String sourceResult)
```
    Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
    
    Parameters:
    
    sourceResult - Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    Date the parameter was last changed or updated and the parameter version was created.
    
    Parameters:
    
    lastModifiedDate - Date the parameter was last changed or updated and the parameter version was created.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    Date the parameter was last changed or updated and the parameter version was created.
    
    Returns:
    
    Date the parameter was last changed or updated and the parameter version was created.
  - withLastModifiedDate
```
public Parameter withLastModifiedDate(Date lastModifiedDate)
```
    Date the parameter was last changed or updated and the parameter version was created.
    
    Parameters:
    
    lastModifiedDate - Date the parameter was last changed or updated and the parameter version was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the parameter.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the parameter.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the parameter.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the parameter.
  - withARN
```
public Parameter withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the parameter.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(String dataType)
```
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    
    Parameters:
    
    dataType - The data type of the parameter, such as text or aws:ec2:image. The default is text.
  - getDataType
```
public String getDataType()
```
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    
    Returns:
    
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
  - withDataType
```
public Parameter withDataType(String dataType)
```
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    
    Parameters:
    
    dataType - The data type of the parameter, such as text or aws:ec2:image. The default is text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Parameter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Parameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Parameter

Method Detail

setName

getName

withName

setType

getType

withType

setType

withType

setValue

getValue

withValue

setVersion

getVersion

withVersion

setSelector

getSelector

withSelector

setSourceResult

getSourceResult

withSourceResult

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setARN

getARN

withARN

setDataType

getDataType

withDataType

toString

equals

hashCode

clone

marshall