Class ResourceResult

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

Provides comprehensive details about an Amazon Web Services resource and its associated security findings.

See Also:

  • Method Details

    • resourceGuid

      public final String resourceGuid()

      The global identifier used to identify a resource.

      Returns:
      The global identifier used to identify a resource.

    • resourceId

      public final String resourceId()

      The unique identifier for a resource.

      Returns:
      The unique identifier for a resource.

    • accountId

      public final String accountId()

      The Amazon Web Services account that recorded the resource data in Security Hub.

      Returns:
      The Amazon Web Services account that recorded the resource data in Security Hub.

    • accountName

      public final String accountName()

      The name of the Amazon Web Services account that's associated with the resource.

      Returns:
      The name of the Amazon Web Services account that's associated with the resource.

    • region

      public final String region()

      The Amazon Web Services Region that recorded the resource data in Security Hub.

      Returns:
      The Amazon Web Services Region that recorded the resource data in Security Hub.

    • resourceProvider

      public final String resourceProvider()

      The cloud provider where the resource exists. Valid values are AWS and Azure. This field is always included.

      Returns:
      The cloud provider where the resource exists. Valid values are AWS and Azure. This field is always included.

    • resourceOwnerAccountId

      public final String resourceOwnerAccountId()

      The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.

      Returns:
      The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.

    • resourceOwnerOrgId

      public final String resourceOwnerOrgId()

      The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.

      Returns:
      The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.

    • resourceCloudPartition

      public final String resourceCloudPartition()

      The cloud partition where the resource exists. For Amazon Web Services, valid values include aws, aws-cn, and aws-us-gov. This field isn't returned for cloud providers that don't use partitions.

      Returns:
      The cloud partition where the resource exists. For Amazon Web Services, valid values include aws, aws-cn, and aws-us-gov. This field isn't returned for cloud providers that don't use partitions.

    • resourceRegion

      public final String resourceRegion()

      The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included.

      Returns:
      The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included.

    • resourceCategory

      public final ResourceCategory resourceCategory()

      The grouping where the resource belongs.

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

      Returns:
      The grouping where the resource belongs.
      See Also:

    • resourceCategoryAsString

      public final String resourceCategoryAsString()

      The grouping where the resource belongs.

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

      Returns:
      The grouping where the resource belongs.
      See Also:

    • resourceType

      public final String resourceType()

      The type of resource.

      Returns:
      The type of resource.

    • resourceName

      public final String resourceName()

      The name of the resource.

      Returns:
      The name of the resource.

    • resourceCreationTimeDt

      public final String resourceCreationTimeDt()

      The time when the resource was created.

      Returns:
      The time when the resource was created.

    • resourceDetailCaptureTimeDt

      public final String resourceDetailCaptureTimeDt()

      The timestamp when information about the resource was captured.

      Returns:
      The timestamp when information about the resource was captured.

    • hasFindingsSummary

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

    • findingsSummary

      public final List<ResourceFindingsSummary> findingsSummary()

      An aggregated view of security findings associated with a resource.

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

      Returns:
      An aggregated view of security findings associated with a resource.

    • hasResourceTags

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

    • resourceTags

      public final List<ResourceTag> resourceTags()

      The key-value pairs associated with a resource.

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

      Returns:
      The key-value pairs associated with a resource.

    • resourceConfig

      public final Document resourceConfig()

      The configuration details of a resource.

      Returns:
      The configuration details of a resource.

    • resourceSubCategory

      public final ResourceSubCategory resourceSubCategory()

      The AI/ML sub-grouping of the resource. Present only when ResourceCategory is AI/ML.

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

      Returns:
      The AI/ML sub-grouping of the resource. Present only when ResourceCategory is AI/ML.
      See Also:

    • resourceSubCategoryAsString

      public final String resourceSubCategoryAsString()

      The AI/ML sub-grouping of the resource. Present only when ResourceCategory is AI/ML.

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

      Returns:
      The AI/ML sub-grouping of the resource. Present only when ResourceCategory is AI/ML.
      See Also:

    • discoveryType

      public final DiscoveryType discoveryType()

      Specifies how the resource was discovered. If the value is Managed, the resource is natively provided by a cloud service provider. If the value is SelfHosted, the resource is hosted on customer-managed infrastructure, such as a compute instance or container image.

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

      Returns:
      Specifies how the resource was discovered. If the value is Managed, the resource is natively provided by a cloud service provider. If the value is SelfHosted, the resource is hosted on customer-managed infrastructure, such as a compute instance or container image.
      See Also:

    • discoveryTypeAsString

      public final String discoveryTypeAsString()

      Specifies how the resource was discovered. If the value is Managed, the resource is natively provided by a cloud service provider. If the value is SelfHosted, the resource is hosted on customer-managed infrastructure, such as a compute instance or container image.

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

      Returns:
      Specifies how the resource was discovered. If the value is Managed, the resource is natively provided by a cloud service provider. If the value is SelfHosted, the resource is hosted on customer-managed infrastructure, such as a compute instance or container image.
      See Also:

    • resourceInfo

      public final ResourceInfo resourceInfo()

      Additional resource-type-specific details. For self-hosted AI resources and their host resources, contains an AIDetails structure.

      Returns:
      Additional resource-type-specific details. For self-hosted AI resources and their host resources, contains an AIDetails structure.

    • toBuilder

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

    • builder

      public static ResourceResult.Builder builder()

    • serializableBuilderClass

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