Class AccessPreview

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

Contains information about an access preview.

See Also:

  • Method Details

    • id

      public final String id()

      The unique ID for the access preview.

      Returns:
      The unique ID for the access preview.

    • analyzerArn

      public final String analyzerArn()

      The ARN of the analyzer used to generate the access preview.

      Returns:
      The ARN of the analyzer used to generate the access preview.

    • hasConfigurations

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

    • configurations

      public final Map<String,Configuration> configurations()

      A map of resource ARNs for the proposed resource configuration.

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

      Returns:
      A map of resource ARNs for the proposed resource configuration.

    • createdAt

      public final Instant createdAt()

      The time at which the access preview was created.

      Returns:
      The time at which the access preview was created.

    • status

      public final AccessPreviewStatus status()

      The status of the access preview.

      • Creating - The access preview creation is in progress.

      • Completed - The access preview is complete. You can preview findings for external access to the resource.

      • Failed - The access preview creation has failed.

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

      Returns:
      The status of the access preview.

      • Creating - The access preview creation is in progress.

      • Completed - The access preview is complete. You can preview findings for external access to the resource.

      • Failed - The access preview creation has failed.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the access preview.

      • Creating - The access preview creation is in progress.

      • Completed - The access preview is complete. You can preview findings for external access to the resource.

      • Failed - The access preview creation has failed.

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

      Returns:
      The status of the access preview.

      • Creating - The access preview creation is in progress.

      • Completed - The access preview is complete. You can preview findings for external access to the resource.

      • Failed - The access preview creation has failed.

      See Also:

    • statusReason

      public final AccessPreviewStatusReason statusReason()

      Provides more details about the current status of the access preview.

      For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

      Returns:
      Provides more details about the current status of the access preview.

      For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

    • toBuilder

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

    • builder

      public static AccessPreview.Builder builder()

    • serializableBuilderClass

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