software.amazon.awssdk.services.ssm.model

Class AddTagsToResourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.AddTagsToResourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AddTagsToResourceRequest
extends SsmRequest
implements ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AddTagsToResourceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AddTagsToResourceRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	resourceId() The resource ID you want to tag.
ResourceTypeForTagging	resourceType() Specifies the type of resource you are tagging.
String	resourceTypeAsString() Specifies the type of resource you are tagging.
List<SdkField<?>>	sdkFields()
static Class<? extends AddTagsToResourceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() One or more tags.
AddTagsToResourceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

resourceType

public ResourceTypeForTagging resourceType()

Specifies the type of resource you are tagging.

The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

Specifies the type of resource you are tagging.

The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

See Also:

ResourceTypeForTagging

resourceTypeAsString

public String resourceTypeAsString()

Specifies the type of resource you are tagging.

The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

Specifies the type of resource you are tagging.

The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

See Also:

ResourceTypeForTagging

resourceId

public String resourceId()

The resource ID you want to tag.

Use the ID of the resource. Here are some examples:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

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

The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Returns:

The resource ID you want to tag.

Use the ID of the resource. Here are some examples:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

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

The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

tags

public List<Tag> tags()

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Do not enter personally identifiable information in this field.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Do not enter personally identifiable information in this field.

toBuilder

public AddTagsToResourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static AddTagsToResourceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo