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

Class: Aws::IAM::Types::Tag

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

Overview

Note:

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

{
  key: "tagKeyType", # required
  value: "tagValueType", # required
}

A structure that represents user-provided metadata that can be associated with a resource such as an IAM user or role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

Returns:

  • (String)


9811
9812
9813
9814
9815
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9811

class Tag < Struct.new(
  :key,
  :value)
  include Aws::Structure
end

#valueString

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

Returns:

  • (String)


9811
9812
9813
9814
9815
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9811

class Tag < Struct.new(
  :key,
  :value)
  include Aws::Structure
end