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",
}

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)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

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

#descriptionString

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

Returns:

  • (String)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

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

#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)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

class PutParameterRequest < Struct.new(
  :name,
  :description,
  :value,
  :type,
  :key_id,
  :overwrite,
  :allowed_pattern)
  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

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)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

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

#overwriteBoolean

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

Returns:

  • (Boolean)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

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

#typeString

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

Returns:

  • (String)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

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

#valueString

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

Returns:

  • (String)


8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8733

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