You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::PutParameterRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass PutParameterRequest data as a hash:

{
  name: "PSParameterName", # required
  description: "ParameterDescription",
  value: "PSParameterValue", # required
  type: "String", # required, accepts String, StringList, SecureString
  key_id: "ParameterKeyId",
  overwrite: false,
  allowed_pattern: "AllowedPattern",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  tier: "Standard", # accepts Standard, Advanced
  policies: "ParameterPolicies",
}

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_patternString

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:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#descriptionString

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:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#key_idString

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:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#nameString

The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13

Naming Constraints:

  • Parameter names are case sensitive.

  • A parameter name must be unique within an AWS Region

  • A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).

  • Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/

  • A parameter name can't include spaces.

  • Parameter hierarchies are limited to a maximum depth of fifteen levels.

For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.

Returns:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#overwriteBoolean

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

Returns:

  • (Boolean)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#policiesString

One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.

Returns:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:

  • Key=Resource,Value=S3bucket

  • Key=OS,Value=Windows

  • Key=ParameterType,Value=LicenseKey

To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.

Returns:



12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#tierString

Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.

Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.

If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.

If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.

Returns:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#typeString

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

Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

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

Returns:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end

#valueString

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:

  • (String)


12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12944

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern,
  :tags,
  :tier,
  :policies)
  include Aws::Structure
end