PutParameterRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.13.7 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.PutParameterRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutParameterRequest
extends SsmRequest
implements ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutParameterRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutParameterRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`allowedPattern()` A regular expression used to validate the parameter value.
`static PutParameterRequest.Builder`	`builder()`
`String`	`description()` Information about the parameter that you want to add to the system.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`keyId()` The KMS Key ID that you want to use to encrypt a parameter.
`String`	`name()` The fully qualified name of the parameter that you want to add to the system.
`Boolean`	`overwrite()` Overwrite an existing parameter.
`String`	`policies()` One or more policies to apply to a parameter.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutParameterRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Optional metadata that you assign to a resource.
`ParameterTier`	`tier()` The parameter tier to assign to a parameter.
`String`	`tierAsString()` The parameter tier to assign to a parameter.
`PutParameterRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ParameterType`	`type()` The type of parameter that you want to add to the system.
`String`	`typeAsString()` The type of parameter that you want to add to the system.
`String`	`value()` The parameter value that you want to add to the system.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public 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 parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. 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 About 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 a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:
    
    arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
    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 parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. 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 About 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 a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:
    
    arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
  - description
```
public 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.
    
    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.
  - value
```
public 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.
    
    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.
  - type
```
public 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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    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
  - typeAsString
```
public String typeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    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
  - keyId
```
public 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.
    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.
  - overwrite
```
public Boolean overwrite()
```
    Overwrite an existing parameter. If not specified, will default to "false".
    
    Returns:
    
    Overwrite an existing parameter. If not specified, will default to "false".
  - allowedPattern
```
public 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+$
    
    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+$
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    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.
  - tier
```
public ParameterTier tier()
```
    The parameter tier to assign to a parameter.
    
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.
    
    You can change a standard parameter to an advanced parameter 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.
    
    Using the Default Tier Configuration
    
    In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.
    
    The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
    - Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
    - Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
      
      If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
      
      This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
    Options that require an advanced parameter include the following:
    - The content size of the parameter is more than 4 KB.
    - The parameter uses a parameter policy.
    - More than 10,000 parameters already exist in your AWS account in the current Region.
    For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, tier will return ParameterTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().
    Returns:
    The parameter tier to assign to a parameter.
    
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.
    
    You can change a standard parameter to an advanced parameter 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.
    
    Using the Default Tier Configuration
    
    In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.
    
    The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
    
    Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
    
    Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
    
    If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
    
    This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
    
    Options that require an advanced parameter include the following:
    
    The content size of the parameter is more than 4 KB.
    
    The parameter uses a parameter policy.
    
    More than 10,000 parameters already exist in your AWS account in the current Region.
    
    For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.
    See Also:
    
    ParameterTier
  - tierAsString
```
public String tierAsString()
```
    The parameter tier to assign to a parameter.
    
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.
    
    You can change a standard parameter to an advanced parameter 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.
    
    Using the Default Tier Configuration
    
    In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.
    
    The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
    - Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
    - Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
      
      If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
      
      This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
    Options that require an advanced parameter include the following:
    - The content size of the parameter is more than 4 KB.
    - The parameter uses a parameter policy.
    - More than 10,000 parameters already exist in your AWS account in the current Region.
    For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, tier will return ParameterTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().
    Returns:
    The parameter tier to assign to a parameter.
    
    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.
    
    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS Systems Manager User Guide.
    
    You can change a standard parameter to an advanced parameter 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.
    
    Using the Default Tier Configuration
    
    In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.
    
    The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
    
    Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
    
    Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
    
    If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
    
    This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
    
    Options that require an advanced parameter include the following:
    
    The content size of the parameter is more than 4 KB.
    
    The parameter uses a parameter policy.
    
    More than 10,000 parameters already exist in your AWS account in the current Region.
    
    For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.
    See Also:
    
    ParameterTier
  - policies
```
public 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 Assigning 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 Assigning parameter policies.
  - toBuilder
```
public PutParameterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutParameterRequest.Builder,PutParameterRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static PutParameterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutParameterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PutParameterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

value

type

typeAsString

keyId

overwrite

allowedPattern

hasTags

tags

tier

tierAsString

policies

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields