Class Group

java.lang.Object
software.amazon.awssdk.services.resourcegroups.model.Group
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Group.Builder,Group>
@Generated("software.amazon.awssdk:codegen") public final class Group extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Group.Builder,Group>

A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group:

  • ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation.

  • GroupConfiguration - Use a service configuration to associate the group with an Amazon Web Services service. The configuration specifies which resource types can be included in the group.

See Also:

  • Method Details

    • groupArn

      public final String groupArn()

      The Amazon resource name (ARN) of the resource group.

      Returns:
      The Amazon resource name (ARN) of the resource group.

    • name

      public final String name()

      The name of the resource group.

      Returns:
      The name of the resource group.

    • description

      public final String description()

      The description of the resource group.

      Returns:
      The description of the resource group.

    • criticality

      public final Integer criticality()

      The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.

      Returns:
      The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.

    • owner

      public final String owner()

      A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.

      Returns:
      A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.

    • displayName

      public final String displayName()

      The name of the application group, which you can change at any time.

      Returns:
      The name of the application group, which you can change at any time.

    • hasApplicationTag

      public final boolean hasApplicationTag()
      For responses, this returns true if the service returned a value for the ApplicationTag 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.

    • applicationTag

      public final Map<String,String> applicationTag()

      A tag that defines the application group membership. This tag is only supported for application groups.

      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 hasApplicationTag() method.

      Returns:
      A tag that defines the application group membership. This tag is only supported for application groups.

    • toBuilder

      public Group.Builder 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<Group.Builder,Group>
      Returns:
      a builder for type T

    • builder

      public static Group.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Group.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)
      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)

    • 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.