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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutParameterRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "PSParameterName", # required
  description: "ParameterDescription",
  value: "PSParameterValue", # required
  type: "String", # required, accepts String, StringList, SecureString
  key_id: "ParameterKeyId",
  overwrite: false,
  allowed_pattern: "AllowedPattern",
}

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)

    A regular expression used to validate the parameter value.

#descriptionString

Information about the parameter that you want to add to the system

Returns:

  • (String)

    Information about the parameter that you want to add to the system.

#key_idString

The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don\'t specify a key ID, the system uses the default key associated with your AWS account.

Returns:

  • (String)

    The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type.

#nameString

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

Returns:

  • (String)

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

#overwriteBoolean

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

Returns:

  • (Boolean)

    Overwrite an existing parameter.

#typeString

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

Possible values:

  • String
  • StringList
  • SecureString

Returns:

  • (String)

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

#valueString

The parameter value that you want to add to the system.

Returns:

  • (String)

    The parameter value that you want to add to the system.