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("software.amazon.awssdk:codegen") public final class AddTagsToResourceRequest extends SsmRequest implements ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AddTagsToResourceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AddTagsToResourceRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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 final ResourceTypeForTagging resourceType()
Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node 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 returnResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
. - See Also:
ResourceTypeForTagging
-
resourceTypeAsString
public final String resourceTypeAsString()
Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node 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 returnResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
. - See Also:
ResourceTypeForTagging
-
resourceId
public final String resourceId()
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow
:mw-012345abcde
PatchBaseline
:pb-012345abcde
Automation
:example-c160-4567-8519-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 wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/ssm/MyGroup/appmanager
or/aws/ssm/MyGroup/appmanager
.For the
Document
andParameter
values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.ManagedInstance
:mi-012345abcde
The
ManagedInstance
type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node 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:
MaintenanceWindow
:mw-012345abcde
PatchBaseline
:pb-012345abcde
Automation
:example-c160-4567-8519-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 wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/ssm/MyGroup/appmanager
or/aws/ssm/MyGroup/appmanager
.For the
Document
andParameter
values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.ManagedInstance
:mi-012345abcde
The
ManagedInstance
type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
-
toBuilder
public AddTagsToResourceRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static AddTagsToResourceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends AddTagsToResourceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-