Package software.amazon.awssdk.services.fms.model

Class ResourceSet

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

A set of resources to include in a policy.

See Also:

  • Method Details

    • id

      public final String id()

      A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      Returns:
      A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • name

      public final String name()

      The descriptive name of the resource set. You can't change the name of a resource set after you create it.

      Returns:
      The descriptive name of the resource set. You can't change the name of a resource set after you create it.

    • description

      public final String description()

      A description of the resource set.

      Returns:
      A description of the resource set.

    • updateToken

      public final String updateToken()

      An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

      To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

      To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

      Returns:
      An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

      To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

      To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

    • hasResourceTypeList

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

    • resourceTypeList

      public final List<String> resourceTypeList()

      Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

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

      Returns:
      Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The last time that the resource set was changed.

      Returns:
      The last time that the resource set was changed.

    • resourceSetStatus

      public final ResourceSetStatus resourceSetStatus()

      Indicates whether the resource set is in or out of an admin's Region scope.

      • ACTIVE - The administrator can manage and delete the resource set.

      • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

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

      Returns:
      Indicates whether the resource set is in or out of an admin's Region scope.

      • ACTIVE - The administrator can manage and delete the resource set.

      • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

      See Also:

    • resourceSetStatusAsString

      public final String resourceSetStatusAsString()

      Indicates whether the resource set is in or out of an admin's Region scope.

      • ACTIVE - The administrator can manage and delete the resource set.

      • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

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

      Returns:
      Indicates whether the resource set is in or out of an admin's Region scope.

      • ACTIVE - The administrator can manage and delete the resource set.

      • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

      See Also:

    • toBuilder

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

    • builder

      public static ResourceSet.Builder builder()

    • serializableBuilderClass

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