Package software.amazon.awssdk.services.iam.model

Class Tag

java.lang.Object

software.amazon.awssdk.services.iam.model.Tag

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Tag.Builder,Tag>

@Generated("software.amazon.awssdk:codegen")
public final class Tag
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Tag.Builder,Tag>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Tag.Builder

Method Summary

Modifier and Type	Method	Description
static Tag.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The key name that can be used to look up or retrieve the associated value.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Tag.Builder>	serializableBuilderClass()
Tag.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The value associated with this tag.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final String key()

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:

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

value

public final String value()

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.

Amazon Web Services 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:

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.

Amazon Web Services 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.

toBuilder

public Tag.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Tag.Builder,Tag>

builder

public static Tag.Builder builder()

serializableBuilderClass

public static Class<? extends Tag.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo