com.amazonaws.services.securitytoken.model

Class Tag

java.lang.Object

com.amazonaws.services.securitytoken.model.Tag

All Implemented Interfaces:

Serializable

public class Tag
extends Object
implements Serializable

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 AWS STS Sessions in the IAM User Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Tag()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getKey() The key for a session tag.
String	getValue() The value for a session tag.
int	hashCode()
void	setKey(String key) The key for a session tag.
void	setValue(String value) The value for a session tag.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Tag	withKey(String key) The key for a session tag.
Tag	withValue(String value) The value for a session tag.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tag

public Tag()

Method Detail

getKey

public String getKey()

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 in the IAM User Guide.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

Returns:

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 in the IAM User Guide.

setKey

public void setKey(String key)

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 in the IAM User Guide.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

Parameters:

key -

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 in the IAM User Guide.

withKey

public Tag withKey(String key)

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 in the IAM User Guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

Parameters:

key -

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 in the IAM User Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getValue

public String getValue()

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.

Constraints:
Length: 0 - 256
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Returns:

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.

setValue

public void setValue(String value)

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.

Constraints:
Length: 0 - 256
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Parameters:

value -

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.

withValue

public Tag withValue(String value)

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 256
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Parameters:

value -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object