Class PolicyPreviewConfiguration

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

Contains the configuration details for policy preview, including the scope, status, and timestamps.

See Also:

  • Method Details

    • scope

      public final PolicyPreviewScope scope()

      The scope of the policy preview configuration. Currently only GLOBAL is supported.

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

      Returns:
      The scope of the policy preview configuration. Currently only GLOBAL is supported.
      See Also:

    • scopeAsString

      public final String scopeAsString()

      The scope of the policy preview configuration. Currently only GLOBAL is supported.

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

      Returns:
      The scope of the policy preview configuration. Currently only GLOBAL is supported.
      See Also:

    • status

      public final PolicyPreviewStatus status()

      The status of the policy preview configuration. A value of ACTIVE indicates the configuration is enabled and CloudTrail authorization events are being collected.

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

      Returns:
      The status of the policy preview configuration. A value of ACTIVE indicates the configuration is enabled and CloudTrail authorization events are being collected.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the policy preview configuration. A value of ACTIVE indicates the configuration is enabled and CloudTrail authorization events are being collected.

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

      Returns:
      The status of the policy preview configuration. A value of ACTIVE indicates the configuration is enabled and CloudTrail authorization events are being collected.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time at which the policy preview configuration was created.

      Returns:
      The time at which the policy preview configuration was created.

    • updatedAt

      public final Instant updatedAt()

      The time at which the policy preview configuration was last updated.

      Returns:
      The time at which the policy preview configuration was last updated.

    • toBuilder

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

    • builder

      public static PolicyPreviewConfiguration.Builder builder()

    • serializableBuilderClass

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