software.amazon.awssdk.services.ssm.model

Interface AddTagsToResourceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>, SdkBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

AddTagsToResourceRequest

public static interface AddTagsToResourceRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>

Method Summary

Modifier and Type	Method and Description
AddTagsToResourceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AddTagsToResourceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AddTagsToResourceRequest.Builder	resourceId(String resourceId) The resource ID you want to tag.
AddTagsToResourceRequest.Builder	resourceType(ResourceTypeForTagging resourceType) Specifies the type of resource you are tagging.
AddTagsToResourceRequest.Builder	resourceType(String resourceType) Specifies the type of resource you are tagging.
AddTagsToResourceRequest.Builder	tags(Collection<Tag> tags) One or more tags.
AddTagsToResourceRequest.Builder	tags(Consumer<Tag.Builder>... tags) One or more tags.
AddTagsToResourceRequest.Builder	tags(Tag... tags) One or more tags.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

resourceType

AddTagsToResourceRequest.Builder resourceType(String 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 name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Parameters:

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 name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Returns:

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

See Also:

ResourceTypeForTagging, ResourceTypeForTagging

resourceType

AddTagsToResourceRequest.Builder resourceType(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 name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Parameters:

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 name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Returns:

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

See Also:

ResourceTypeForTagging, ResourceTypeForTagging

resourceId

AddTagsToResourceRequest.Builder resourceId(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

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.

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 name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Parameters:

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

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.

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 name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

Returns:

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

tags

AddTagsToResourceRequest.Builder tags(Collection<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.

Parameters:

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.

Returns:

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

tags

AddTagsToResourceRequest.Builder tags(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.

Parameters:

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.

Returns:

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

tags

AddTagsToResourceRequest.Builder tags(Consumer<Tag.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

overrideConfiguration

AddTagsToResourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AddTagsToResourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder