PutParameterRequest (AWS SDK for Java

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()` Creates a shallow clone of this object for all fields except the handler context.
`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`	`getPolicies()` One or more policies to apply to a parameter.
`List<Tag>`	`getTags()` Optional metadata that you assign to a resource.
`String`	`getTier()` Parameter Store offers a standard tier and an advanced tier for parameters.
`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`	`setPolicies(String policies)` One or more policies to apply to a parameter.
`void`	`setTags(Collection<Tag> tags)` Optional metadata that you assign to a resource.
`void`	`setTier(ParameterTier tier)` Parameter Store offers a standard tier and an advanced tier for parameters.
`void`	`setTier(String tier)` Parameter Store offers a standard tier and an advanced tier for parameters.
`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.
`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`	`withPolicies(String policies)` One or more policies to apply to a parameter.
`PutParameterRequest`	`withTags(Collection<Tag> tags)` Optional metadata that you assign to a resource.
`PutParameterRequest`	`withTags(Tag... tags)` Optional metadata that you assign to a resource.
`PutParameterRequest`	`withTier(ParameterTier tier)` Parameter Store offers a standard tier and an advanced tier for parameters.
`PutParameterRequest`	`withTier(String tier)` Parameter Store offers a standard tier and an advanced tier for parameters.
`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
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. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
    
    Parameters:
    
    value - The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
  - getValue
```
public String getValue()
```
    The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
    
    Returns:
    
    The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
  - withValue
```
public PutParameterRequest withValue(String value)
```
    The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
    
    Parameters:
    
    value - The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
    
    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.
  - getTags
```
public List<Tag> getTags()
```
    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    - Key=Resource,Value=S3bucket
    - Key=OS,Value=Windows
    - Key=ParameterType,Value=LicenseKey
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
    Returns:
    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    
    Key=Resource,Value=S3bucket
    
    Key=OS,Value=Windows
    
    Key=ParameterType,Value=LicenseKey
    
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    - Key=Resource,Value=S3bucket
    - Key=OS,Value=Windows
    - Key=ParameterType,Value=LicenseKey
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
    Parameters:
    tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    
    Key=Resource,Value=S3bucket
    
    Key=OS,Value=Windows
    
    Key=ParameterType,Value=LicenseKey
    
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
  - withTags
```
public PutParameterRequest withTags(Tag... tags)
```
    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    - Key=Resource,Value=S3bucket
    - Key=OS,Value=Windows
    - Key=ParameterType,Value=LicenseKey
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    Parameters:
    tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    
    Key=Resource,Value=S3bucket
    
    Key=OS,Value=Windows
    
    Key=ParameterType,Value=LicenseKey
    
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public PutParameterRequest withTags(Collection<Tag> tags)
```
    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    - Key=Resource,Value=S3bucket
    - Key=OS,Value=Windows
    - Key=ParameterType,Value=LicenseKey
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
    Parameters:
    tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:
    
    Key=Resource,Value=S3bucket
    
    Key=OS,Value=Windows
    
    Key=ParameterType,Value=LicenseKey
    
    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTier
```
public void setTier(String tier)
```
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Parameters:
    
    tier - Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    See Also:
    
    ParameterTier
  - getTier
```
public String getTier()
```
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Returns:
    
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    See Also:
    
    ParameterTier
  - withTier
```
public PutParameterRequest withTier(String tier)
```
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Parameters:
    
    tier - Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterTier
  - setTier
```
public void setTier(ParameterTier tier)
```
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Parameters:
    
    tier - Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    See Also:
    
    ParameterTier
  - withTier
```
public PutParameterRequest withTier(ParameterTier tier)
```
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Parameters:
    
    tier - Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
    
    If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
    
    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterTier
  - setPolicies
```
public void setPolicies(String policies)
```
    One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
    
    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
    
    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
    
    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
    
    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
    
    Parameters:
    
    policies - One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
    
    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
    
    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
    
    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
    
    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
  - getPolicies
```
public String getPolicies()
```
    One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
    
    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
    
    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
    
    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
    
    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
    
    Returns:
    
    One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
    
    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
    
    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
    
    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
    
    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
  - withPolicies
```
public PutParameterRequest withPolicies(String policies)
```
    One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
    
    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
    
    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
    
    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
    
    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
    
    Parameters:
    
    policies - One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:
    
    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
    
    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
    
    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.
    
    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
    
    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 PutParameterRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

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

getTags

setTags

withTags

withTags

setTier

getTier

withTier

setTier

withTier

setPolicies

getPolicies

withPolicies

toString

equals

hashCode

clone