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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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, OpsItem, OpsMetadata
  resource_id: "ResourceId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

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:

`MaintenanceWindow`: `mw-012345abcde`

`PatchBaseline`: `pb-012345abcde`

`OpsMetadata` object: `ResourceID` for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is created from the strings that come after the word `opsmetadata` in the ARN. For example, an OpsMetadata object with an ARN of `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or `/aws/ssm/MyGroup/appmanager`.

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

`ManagedInstance`: `mi-012345abcde`

<note markdown=“1”> The `ManagedInstance` type for this API operation is only for on-premises managed instances. You must specify the name of the managed instance in the following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.

</note>

Returns:

  • (String)

165
166
167
168
169
170
171
# File 'lib/aws-sdk-ssm/types.rb', line 165

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

#resource_typeString

Specifies the type of resource you are tagging.

<note markdown=“1”> The `ManagedInstance` type for this API operation is for on-premises managed instances. You must specify the name of the managed instance in the following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.

</note>

Returns:

  • (String)

165
166
167
168
169
170
171
# File 'lib/aws-sdk-ssm/types.rb', line 165

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

#tagsArray<Types::Tag>

One or more tags. The value parameter is required.

Don't enter personally identifiable information in this field.

Returns:


165
166
167
168
169
170
171
# File 'lib/aws-sdk-ssm/types.rb', line 165

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