Class 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>
  • Method Details

    • 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 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 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:
    • 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 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 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:
    • 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 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. 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 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. 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 the isEmpty() 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

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T
    • builder

      public static AddTagsToResourceRequest.Builder builder()
    • serializableBuilderClass

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

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.