Class: Aws::STS::Types::Tag

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sts/types.rb

Overview

Note:

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

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

You can pass custom key-value pair attributes when you assume a role or federate a user. These are called session tags. You can then use the session tags to control access to resources. For more information, see [Tagging Amazon Web Services STS Sessions] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

Instance Attribute Details

#keyString

The key for a session tag.

You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 characters. For these and additional limits, see

IAM and STS Character Limits][1

in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length

Returns:

  • (String)

1665
1666
1667
1668
1669
1670
# File 'lib/aws-sdk-sts/types.rb', line 1665

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

#valueString

The value for a session tag.

You can pass up to 50 session tags. The plain text session tag values can’t exceed 256 characters. For these and additional limits, see [IAM and STS Character Limits] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length

Returns:

  • (String)

1665
1666
1667
1668
1669
1670
# File 'lib/aws-sdk-sts/types.rb', line 1665

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