AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::PutParameterRequest Class Reference

#include <PutParameterRequest.h>

+ Inheritance diagram for Aws::SSM::Model::PutParameterRequest:

Public Member Functions

 PutParameterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PutParameterRequestWithName (const Aws::String &value)
 
PutParameterRequestWithName (Aws::String &&value)
 
PutParameterRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PutParameterRequestWithDescription (const Aws::String &value)
 
PutParameterRequestWithDescription (Aws::String &&value)
 
PutParameterRequestWithDescription (const char *value)
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
PutParameterRequestWithValue (const Aws::String &value)
 
PutParameterRequestWithValue (Aws::String &&value)
 
PutParameterRequestWithValue (const char *value)
 
const ParameterTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ParameterType &value)
 
void SetType (ParameterType &&value)
 
PutParameterRequestWithType (const ParameterType &value)
 
PutParameterRequestWithType (ParameterType &&value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
PutParameterRequestWithKeyId (const Aws::String &value)
 
PutParameterRequestWithKeyId (Aws::String &&value)
 
PutParameterRequestWithKeyId (const char *value)
 
bool GetOverwrite () const
 
bool OverwriteHasBeenSet () const
 
void SetOverwrite (bool value)
 
PutParameterRequestWithOverwrite (bool value)
 
const Aws::StringGetAllowedPattern () const
 
bool AllowedPatternHasBeenSet () const
 
void SetAllowedPattern (const Aws::String &value)
 
void SetAllowedPattern (Aws::String &&value)
 
void SetAllowedPattern (const char *value)
 
PutParameterRequestWithAllowedPattern (const Aws::String &value)
 
PutParameterRequestWithAllowedPattern (Aws::String &&value)
 
PutParameterRequestWithAllowedPattern (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
PutParameterRequestWithTags (const Aws::Vector< Tag > &value)
 
PutParameterRequestWithTags (Aws::Vector< Tag > &&value)
 
PutParameterRequestAddTags (const Tag &value)
 
PutParameterRequestAddTags (Tag &&value)
 
const ParameterTierGetTier () const
 
bool TierHasBeenSet () const
 
void SetTier (const ParameterTier &value)
 
void SetTier (ParameterTier &&value)
 
PutParameterRequestWithTier (const ParameterTier &value)
 
PutParameterRequestWithTier (ParameterTier &&value)
 
const Aws::StringGetPolicies () const
 
bool PoliciesHasBeenSet () const
 
void SetPolicies (const Aws::String &value)
 
void SetPolicies (Aws::String &&value)
 
void SetPolicies (const char *value)
 
PutParameterRequestWithPolicies (const Aws::String &value)
 
PutParameterRequestWithPolicies (Aws::String &&value)
 
PutParameterRequestWithPolicies (const char *value)
 
const Aws::StringGetDataType () const
 
bool DataTypeHasBeenSet () const
 
void SetDataType (const Aws::String &value)
 
void SetDataType (Aws::String &&value)
 
void SetDataType (const char *value)
 
PutParameterRequestWithDataType (const Aws::String &value)
 
PutParameterRequestWithDataType (Aws::String &&value)
 
PutParameterRequestWithDataType (const char *value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file PutParameterRequest.h.

Constructor & Destructor Documentation

◆ PutParameterRequest()

Aws::SSM::Model::PutParameterRequest::PutParameterRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::AddTags ( const Tag value)
inline

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.

Definition at line 765 of file PutParameterRequest.h.

◆ AddTags() [2/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::AddTags ( Tag &&  value)
inline

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.

Definition at line 780 of file PutParameterRequest.h.

◆ AllowedPatternHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::AllowedPatternHasBeenSet ( ) const
inline

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=^+$

Definition at line 617 of file PutParameterRequest.h.

◆ DataTypeHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::DataTypeHasBeenSet ( ) const
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1269 of file PutParameterRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::DescriptionHasBeenSet ( ) const
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 262 of file PutParameterRequest.h.

◆ GetAllowedPattern()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetAllowedPattern ( ) const
inline

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=^+$

Definition at line 610 of file PutParameterRequest.h.

◆ GetDataType()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetDataType ( ) const
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1254 of file PutParameterRequest.h.

◆ GetDescription()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetDescription ( ) const
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 255 of file PutParameterRequest.h.

◆ GetKeyId()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetKeyId ( ) const
inline

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.

Definition at line 472 of file PutParameterRequest.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetName ( ) const
inline

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

Definition at line 65 of file PutParameterRequest.h.

◆ GetOverwrite()

bool Aws::SSM::Model::PutParameterRequest::GetOverwrite ( ) const
inline

Overwrite an existing parameter. If not specified, will default to "false".

Definition at line 584 of file PutParameterRequest.h.

◆ GetPolicies()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetPolicies ( ) const
inline

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.

Definition at line 1091 of file PutParameterRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::PutParameterRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::PutParameterRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file PutParameterRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SSM::Model::PutParameterRequest::GetTags ( ) const
inline

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.

Definition at line 675 of file PutParameterRequest.h.

◆ GetTier()

const ParameterTier& Aws::SSM::Model::PutParameterRequest::GetTier ( ) const
inline

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.

Definition at line 829 of file PutParameterRequest.h.

◆ GetType()

const ParameterType& Aws::SSM::Model::PutParameterRequest::GetType ( ) const
inline

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Definition at line 391 of file PutParameterRequest.h.

◆ GetValue()

const Aws::String& Aws::SSM::Model::PutParameterRequest::GetValue ( ) const
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 314 of file PutParameterRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::KeyIdHasBeenSet ( ) const
inline

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.

Definition at line 487 of file PutParameterRequest.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::NameHasBeenSet ( ) const
inline

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

Definition at line 91 of file PutParameterRequest.h.

◆ OverwriteHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::OverwriteHasBeenSet ( ) const
inline

Overwrite an existing parameter. If not specified, will default to "false".

Definition at line 590 of file PutParameterRequest.h.

◆ PoliciesHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::PoliciesHasBeenSet ( ) const
inline

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.

Definition at line 1112 of file PutParameterRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::PutParameterRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllowedPattern() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetAllowedPattern ( const Aws::String value)
inline

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=^+$

Definition at line 624 of file PutParameterRequest.h.

◆ SetAllowedPattern() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetAllowedPattern ( Aws::String &&  value)
inline

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=^+$

Definition at line 631 of file PutParameterRequest.h.

◆ SetAllowedPattern() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetAllowedPattern ( const char *  value)
inline

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=^+$

Definition at line 638 of file PutParameterRequest.h.

◆ SetDataType() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetDataType ( const Aws::String value)
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1284 of file PutParameterRequest.h.

◆ SetDataType() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetDataType ( Aws::String &&  value)
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1299 of file PutParameterRequest.h.

◆ SetDataType() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetDataType ( const char *  value)
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1314 of file PutParameterRequest.h.

◆ SetDescription() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetDescription ( const Aws::String value)
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 269 of file PutParameterRequest.h.

◆ SetDescription() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetDescription ( Aws::String &&  value)
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 276 of file PutParameterRequest.h.

◆ SetDescription() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetDescription ( const char *  value)
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 283 of file PutParameterRequest.h.

◆ SetKeyId() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetKeyId ( const Aws::String value)
inline

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.

Definition at line 502 of file PutParameterRequest.h.

◆ SetKeyId() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetKeyId ( Aws::String &&  value)
inline

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.

Definition at line 517 of file PutParameterRequest.h.

◆ SetKeyId() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetKeyId ( const char *  value)
inline

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.

Definition at line 532 of file PutParameterRequest.h.

◆ SetName() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetName ( const Aws::String value)
inline

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

Definition at line 117 of file PutParameterRequest.h.

◆ SetName() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetName ( Aws::String &&  value)
inline

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

Definition at line 143 of file PutParameterRequest.h.

◆ SetName() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetName ( const char *  value)
inline

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

Definition at line 169 of file PutParameterRequest.h.

◆ SetOverwrite()

void Aws::SSM::Model::PutParameterRequest::SetOverwrite ( bool  value)
inline

Overwrite an existing parameter. If not specified, will default to "false".

Definition at line 596 of file PutParameterRequest.h.

◆ SetPolicies() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetPolicies ( const Aws::String value)
inline

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.

Definition at line 1133 of file PutParameterRequest.h.

◆ SetPolicies() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetPolicies ( Aws::String &&  value)
inline

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.

Definition at line 1154 of file PutParameterRequest.h.

◆ SetPolicies() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetPolicies ( const char *  value)
inline

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.

Definition at line 1175 of file PutParameterRequest.h.

◆ SetTags() [1/2]

void Aws::SSM::Model::PutParameterRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 705 of file PutParameterRequest.h.

◆ SetTags() [2/2]

void Aws::SSM::Model::PutParameterRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 720 of file PutParameterRequest.h.

◆ SetTier() [1/2]

void Aws::SSM::Model::PutParameterRequest::SetTier ( const ParameterTier value)
inline

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.

Definition at line 925 of file PutParameterRequest.h.

◆ SetTier() [2/2]

void Aws::SSM::Model::PutParameterRequest::SetTier ( ParameterTier &&  value)
inline

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.

Definition at line 973 of file PutParameterRequest.h.

◆ SetType() [1/2]

void Aws::SSM::Model::PutParameterRequest::SetType ( const ParameterType value)
inline

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Definition at line 417 of file PutParameterRequest.h.

◆ SetType() [2/2]

void Aws::SSM::Model::PutParameterRequest::SetType ( ParameterType &&  value)
inline

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Definition at line 430 of file PutParameterRequest.h.

◆ SetValue() [1/3]

void Aws::SSM::Model::PutParameterRequest::SetValue ( const Aws::String value)
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 332 of file PutParameterRequest.h.

◆ SetValue() [2/3]

void Aws::SSM::Model::PutParameterRequest::SetValue ( Aws::String &&  value)
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 341 of file PutParameterRequest.h.

◆ SetValue() [3/3]

void Aws::SSM::Model::PutParameterRequest::SetValue ( const char *  value)
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 350 of file PutParameterRequest.h.

◆ TagsHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 690 of file PutParameterRequest.h.

◆ TierHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::TierHasBeenSet ( ) const
inline

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.

Definition at line 877 of file PutParameterRequest.h.

◆ TypeHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::TypeHasBeenSet ( ) const
inline

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Definition at line 404 of file PutParameterRequest.h.

◆ ValueHasBeenSet()

bool Aws::SSM::Model::PutParameterRequest::ValueHasBeenSet ( ) const
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 323 of file PutParameterRequest.h.

◆ WithAllowedPattern() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithAllowedPattern ( const Aws::String value)
inline

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=^+$

Definition at line 645 of file PutParameterRequest.h.

◆ WithAllowedPattern() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithAllowedPattern ( Aws::String &&  value)
inline

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=^+$

Definition at line 652 of file PutParameterRequest.h.

◆ WithAllowedPattern() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithAllowedPattern ( const char *  value)
inline

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=^+$

Definition at line 659 of file PutParameterRequest.h.

◆ WithDataType() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithDataType ( const Aws::String value)
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1329 of file PutParameterRequest.h.

◆ WithDataType() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithDataType ( Aws::String &&  value)
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1344 of file PutParameterRequest.h.

◆ WithDataType() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithDataType ( const char *  value)
inline

The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs.

The following data type values are supported.

  • text

  • aws:ec2:image

When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.

Definition at line 1359 of file PutParameterRequest.h.

◆ WithDescription() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithDescription ( const Aws::String value)
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 290 of file PutParameterRequest.h.

◆ WithDescription() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithDescription ( Aws::String &&  value)
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 297 of file PutParameterRequest.h.

◆ WithDescription() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithDescription ( const char *  value)
inline

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Definition at line 304 of file PutParameterRequest.h.

◆ WithKeyId() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithKeyId ( const Aws::String value)
inline

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.

Definition at line 547 of file PutParameterRequest.h.

◆ WithKeyId() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithKeyId ( Aws::String &&  value)
inline

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.

Definition at line 562 of file PutParameterRequest.h.

◆ WithKeyId() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithKeyId ( const char *  value)
inline

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.

Definition at line 577 of file PutParameterRequest.h.

◆ WithName() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithName ( const Aws::String value)
inline

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

Definition at line 195 of file PutParameterRequest.h.

◆ WithName() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithName ( Aws::String &&  value)
inline

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

Definition at line 221 of file PutParameterRequest.h.

◆ WithName() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithName ( const char *  value)
inline

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

Definition at line 247 of file PutParameterRequest.h.

◆ WithOverwrite()

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithOverwrite ( bool  value)
inline

Overwrite an existing parameter. If not specified, will default to "false".

Definition at line 602 of file PutParameterRequest.h.

◆ WithPolicies() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithPolicies ( const Aws::String value)
inline

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.

Definition at line 1196 of file PutParameterRequest.h.

◆ WithPolicies() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithPolicies ( Aws::String &&  value)
inline

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.

Definition at line 1217 of file PutParameterRequest.h.

◆ WithPolicies() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithPolicies ( const char *  value)
inline

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.

Definition at line 1238 of file PutParameterRequest.h.

◆ WithTags() [1/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 735 of file PutParameterRequest.h.

◆ WithTags() [2/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 750 of file PutParameterRequest.h.

◆ WithTier() [1/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithTier ( const ParameterTier value)
inline

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.

Definition at line 1021 of file PutParameterRequest.h.

◆ WithTier() [2/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithTier ( ParameterTier &&  value)
inline

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.

Definition at line 1069 of file PutParameterRequest.h.

◆ WithType() [1/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithType ( const ParameterType value)
inline

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Definition at line 443 of file PutParameterRequest.h.

◆ WithType() [2/2]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithType ( ParameterType &&  value)
inline

The type of parameter that you want to add to the system.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

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.

Specifying a parameter type is not required when updating a parameter. You must specify a parameter type when creating a parameter.

Definition at line 456 of file PutParameterRequest.h.

◆ WithValue() [1/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithValue ( const Aws::String value)
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 359 of file PutParameterRequest.h.

◆ WithValue() [2/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithValue ( Aws::String &&  value)
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 368 of file PutParameterRequest.h.

◆ WithValue() [3/3]

PutParameterRequest& Aws::SSM::Model::PutParameterRequest::WithValue ( const char *  value)
inline

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 can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Definition at line 377 of file PutParameterRequest.h.


The documentation for this class was generated from the following file: