PutParameterRequest (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.11.384 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.simplesystemsmanagement.model.PutParameterRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutParameterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutParameterRequest()

Constructors
Constructor and Description
`PutParameterRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutParameterRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAllowedPattern()` A regular expression used to validate the parameter value.
`String`	`getDescription()` Information about the parameter that you want to add to the system.
`String`	`getKeyId()` The KMS Key ID that you want to use to encrypt a parameter.
`String`	`getName()` The fully qualified name of the parameter that you want to add to the system.
`Boolean`	`getOverwrite()` Overwrite an existing parameter.
`String`	`getType()` The type of parameter that you want to add to the system.
`String`	`getValue()` The parameter value that you want to add to the system.
`int`	`hashCode()`
`Boolean`	`isOverwrite()` Overwrite an existing parameter.
`void`	`setAllowedPattern(String allowedPattern)` A regular expression used to validate the parameter value.
`void`	`setDescription(String description)` Information about the parameter that you want to add to the system.
`void`	`setKeyId(String keyId)` The KMS Key ID that you want to use to encrypt a parameter.
`void`	`setName(String name)` The fully qualified name of the parameter that you want to add to the system.
`void`	`setOverwrite(Boolean overwrite)` Overwrite an existing parameter.
`void`	`setType(ParameterType type)` The type of parameter that you want to add to the system.
`void`	`setType(String type)` The type of parameter that you want to add to the system.
`void`	`setValue(String value)` The parameter value that you want to add to the system.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutParameterRequest`	`withAllowedPattern(String allowedPattern)` A regular expression used to validate the parameter value.
`PutParameterRequest`	`withDescription(String description)` Information about the parameter that you want to add to the system.
`PutParameterRequest`	`withKeyId(String keyId)` The KMS Key ID that you want to use to encrypt a parameter.
`PutParameterRequest`	`withName(String name)` The fully qualified name of the parameter that you want to add to the system.
`PutParameterRequest`	`withOverwrite(Boolean overwrite)` Overwrite an existing parameter.
`PutParameterRequest`	`withType(ParameterType type)` The type of parameter that you want to add to the system.
`PutParameterRequest`	`withType(String type)` The type of parameter that you want to add to the system.
`PutParameterRequest`	`withValue(String value)` The parameter value that you want to add to the system.

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

- Constructor Detail
  - PutParameterRequest
```
public PutParameterRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13
    
    Naming Constraints:
    - Parameter names are case sensitive.
    - A parameter name must be unique within an AWS Region
    - A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
    - Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
    - A parameter name can't include spaces.
    - Parameter hierarchies are limited to a maximum depth of fifteen levels.
    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
    
    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
    Parameters:
    name - The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13
    
    Naming Constraints:
    
    Parameter names are case sensitive.
    
    A parameter name must be unique within an AWS Region
    
    A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
    
    Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
    
    A parameter name can't include spaces.
    
    Parameter hierarchies are limited to a maximum depth of fifteen levels.
    
    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
    
    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
  - getName
```
public String getName()
```
    The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13
    
    Naming Constraints:
    - Parameter names are case sensitive.
    - A parameter name must be unique within an AWS Region
    - A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
    - Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
    - A parameter name can't include spaces.
    - Parameter hierarchies are limited to a maximum depth of fifteen levels.
    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
    
    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
    Returns:
    The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13
    
    Naming Constraints:
    
    Parameter names are case sensitive.
    
    A parameter name must be unique within an AWS Region
    
    A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
    
    Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
    
    A parameter name can't include spaces.
    
    Parameter hierarchies are limited to a maximum depth of fifteen levels.
    
    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
    
    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
  - withName
```
public PutParameterRequest withName(String name)
```
    The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13
    
    Naming Constraints:
    - Parameter names are case sensitive.
    - A parameter name must be unique within an AWS Region
    - A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
    - Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
    - A parameter name can't include spaces.
    - Parameter hierarchies are limited to a maximum depth of fifteen levels.
    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
    
    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
    Parameters:
    name - The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13
    
    Naming Constraints:
    
    Parameter names are case sensitive.
    
    A parameter name must be unique within an AWS Region
    
    A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
    
    Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
    
    A parameter name can't include spaces.
    
    Parameter hierarchies are limited to a maximum depth of fifteen levels.
    
    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
    
    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Information about the parameter that you want to add to the system. Optional but recommended.
    
    Do not enter personally identifiable information in this field.
    
    Parameters:
    
    description - Information about the parameter that you want to add to the system. Optional but recommended.
    
    Do not enter personally identifiable information in this field.
  - getDescription
```
public String getDescription()
```
    Information about the parameter that you want to add to the system. Optional but recommended.
    
    Do not enter personally identifiable information in this field.
    
    Returns:
    
    Information about the parameter that you want to add to the system. Optional but recommended.
    
    Do not enter personally identifiable information in this field.
  - withDescription
```
public PutParameterRequest withDescription(String description)
```
    Information about the parameter that you want to add to the system. Optional but recommended.
    
    Do not enter personally identifiable information in this field.
    
    Parameters:
    
    description - Information about the parameter that you want to add to the system. Optional but recommended.
    
    Do not enter personally identifiable information in this field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(String value)
```
    The parameter value that you want to add to the system.
    
    Parameters:
    
    value - The parameter value that you want to add to the system.
  - getValue
```
public String getValue()
```
    The parameter value that you want to add to the system.
    
    Returns:
    
    The parameter value that you want to add to the system.
  - withValue
```
public PutParameterRequest withValue(String value)
```
    The parameter value that you want to add to the system.
    
    Parameters:
    
    value - The parameter value that you want to add to the system.
    
    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 that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    Parameters:
    
    type - The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    See Also:
    
    ParameterType
  - getType
```
public String getType()
```
    The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    Returns:
    
    The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    See Also:
    
    ParameterType
  - withType
```
public PutParameterRequest withType(String type)
```
    The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    Parameters:
    
    type - The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    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 that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    Parameters:
    
    type - The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    See Also:
    
    ParameterType
  - withType
```
public PutParameterRequest withType(ParameterType type)
```
    The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    Parameters:
    
    type - The type of parameter that you want to add to the system.
    
    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
    
    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - setKeyId
```
public void setKeyId(String keyId)
```
    The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
    
    If you don't specify a key ID, the system uses the default key associated with your AWS account.
    - To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
    - To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
    Parameters:
    keyId - The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
    
    If you don't specify a key ID, the system uses the default key associated with your AWS account.
    
    To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
    
    To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
  - getKeyId
```
public String getKeyId()
```
    The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
    
    If you don't specify a key ID, the system uses the default key associated with your AWS account.
    - To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
    - To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
    Returns:
    The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
    
    If you don't specify a key ID, the system uses the default key associated with your AWS account.
    
    To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
    
    To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
  - withKeyId
```
public PutParameterRequest withKeyId(String keyId)
```
    The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
    
    If you don't specify a key ID, the system uses the default key associated with your AWS account.
    - To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
    - To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
    Parameters:
    keyId - The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.
    
    If you don't specify a key ID, the system uses the default key associated with your AWS account.
    
    To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.
    
    To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverwrite
```
public void setOverwrite(Boolean overwrite)
```
    Overwrite an existing parameter. If not specified, will default to "false".
    
    Parameters:
    
    overwrite - Overwrite an existing parameter. If not specified, will default to "false".
  - getOverwrite
```
public Boolean getOverwrite()
```
    Overwrite an existing parameter. If not specified, will default to "false".
    
    Returns:
    
    Overwrite an existing parameter. If not specified, will default to "false".
  - withOverwrite
```
public PutParameterRequest withOverwrite(Boolean overwrite)
```
    Overwrite an existing parameter. If not specified, will default to "false".
    
    Parameters:
    
    overwrite - Overwrite an existing parameter. If not specified, will default to "false".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isOverwrite
```
public Boolean isOverwrite()
```
    Overwrite an existing parameter. If not specified, will default to "false".
    
    Returns:
    
    Overwrite an existing parameter. If not specified, will default to "false".
  - setAllowedPattern
```
public void setAllowedPattern(String allowedPattern)
```
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    
    Parameters:
    
    allowedPattern - A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
  - getAllowedPattern
```
public String getAllowedPattern()
```
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    
    Returns:
    
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
  - withAllowedPattern
```
public PutParameterRequest withAllowedPattern(String allowedPattern)
```
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    
    Parameters:
    
    allowedPattern - A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    
    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; useful for testing and debugging.
    
    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 PutParameterRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class PutParameterRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutParameterRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setValue

getValue

withValue

setType

getType

withType

setType

withType

setKeyId

getKeyId

withKeyId

setOverwrite

getOverwrite

withOverwrite

isOverwrite

setAllowedPattern

getAllowedPattern

withAllowedPattern

toString

equals

hashCode

clone