Class Resource

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

Describes a resource associated with a resource share in RAM.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the resource.

      Returns:
      The Amazon Resource Name (ARN) of the resource.

    • type

      public final String type()

      The resource type. This takes the form of: service-code:resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.

      Returns:
      The resource type. This takes the form of: service-code:resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.

    • resourceShareArn

      public final String resourceShareArn()

      The Amazon Resource Name (ARN) of the resource share this resource is associated with.

      Returns:
      The Amazon Resource Name (ARN) of the resource share this resource is associated with.

    • resourceGroupArn

      public final String resourceGroupArn()

      The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

      Returns:
      The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

    • status

      public final ResourceStatus status()

      The current status of the resource.

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

      Returns:
      The current status of the resource.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the resource.

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

      Returns:
      The current status of the resource.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message about the status of the resource.

      Returns:
      A message about the status of the resource.

    • creationTime

      public final Instant creationTime()

      The date and time when the resource was associated with the resource share.

      Returns:
      The date and time when the resource was associated with the resource share.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date an time when the association between the resource and the resource share was last updated.

      Returns:
      The date an time when the association between the resource and the resource share was last updated.

    • resourceRegionScope

      public final ResourceRegionScope resourceRegionScope()

      Specifies the scope of visibility of this resource:

      • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

      • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

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

      Returns:
      Specifies the scope of visibility of this resource:

      • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

      • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

      See Also:

    • resourceRegionScopeAsString

      public final String resourceRegionScopeAsString()

      Specifies the scope of visibility of this resource:

      • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

      • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

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

      Returns:
      Specifies the scope of visibility of this resource:

      • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

      • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

      See Also:

    • toBuilder

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

    • builder

      public static Resource.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.