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

Class: Aws::SSM::Types::AddTagsToResourceRequest

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 AddTagsToResourceRequest data as a hash:

{
  resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline
  resource_id: "ResourceId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#resource_idString

The resource ID you want to tag.

Use the ID of the resource. Here are some examples:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

For the Document and Parameter values, use the name of the resource.

The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Returns:

  • (String)


127
128
129
130
131
132
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 127

class AddTagsToResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :tags)
  include Aws::Structure
end

#resource_typeString

Specifies the type of resource you are tagging.

The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Returns:

  • (String)


127
128
129
130
131
132
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 127

class AddTagsToResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Do not enter personally identifiable information in this field.

Returns:



127
128
129
130
131
132
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 127

class AddTagsToResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :tags)
  include Aws::Structure
end