Package software.amazon.awssdk.services.accessanalyzer.model

Class AccessPreviewFinding

    • Method Detail

      • id

        public final String id()

        The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.

        Returns:
        The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.

      • existingFindingId

        public final String existingFindingId()

        The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.

        Returns:
        The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.

      • hasPrincipal

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

      • principal

        public final Map<String,​String> principal()

        The external principal that has access to a resource within the zone of trust.

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

        Returns:
        The external principal that has access to a resource within the zone of trust.

      • hasAction

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

      • action

        public final List<String> action()

        The action in the analyzed policy statement that an external principal has permission to perform.

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

        Returns:
        The action in the analyzed policy statement that an external principal has permission to perform.

      • hasCondition

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

      • condition

        public final Map<String,​String> condition()

        The condition in the analyzed policy statement that resulted in a finding.

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

        Returns:
        The condition in the analyzed policy statement that resulted in a finding.

      • resource

        public final String resource()

        The resource that an external principal has access to. This is the resource associated with the access preview.

        Returns:
        The resource that an external principal has access to. This is the resource associated with the access preview.

      • isPublic

        public final Boolean isPublic()

        Indicates whether the policy that generated the finding allows public access to the resource.

        Returns:
        Indicates whether the policy that generated the finding allows public access to the resource.

      • resourceTypeAsString

        public final String resourceTypeAsString()

        The type of the resource that can be accessed in the finding.

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

        Returns:
        The type of the resource that can be accessed in the finding.
        See Also:
        ResourceType

      • createdAt

        public final Instant createdAt()

        The time at which the access preview finding was created.

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

      • changeType

        public final FindingChangeType changeType()

        Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.

        • New - The finding is for newly-introduced access.

        • Unchanged - The preview finding is an existing finding that would remain unchanged.

        • Changed - The preview finding is an existing finding with a change in status.

        For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

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

        Returns:
        Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.

        • New - The finding is for newly-introduced access.

        • Unchanged - The preview finding is an existing finding that would remain unchanged.

        • Changed - The preview finding is an existing finding with a change in status.

        For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

        See Also:
        FindingChangeType

      • changeTypeAsString

        public final String changeTypeAsString()

        Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.

        • New - The finding is for newly-introduced access.

        • Unchanged - The preview finding is an existing finding that would remain unchanged.

        • Changed - The preview finding is an existing finding with a change in status.

        For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

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

        Returns:
        Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.

        • New - The finding is for newly-introduced access.

        • Unchanged - The preview finding is an existing finding that would remain unchanged.

        • Changed - The preview finding is an existing finding with a change in status.

        For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

        See Also:
        FindingChangeType

      • status

        public final FindingStatus status()

        The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

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

        Returns:
        The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.
        See Also:
        FindingStatus

      • statusAsString

        public final String statusAsString()

        The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

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

        Returns:
        The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.
        See Also:
        FindingStatus

      • resourceOwnerAccount

        public final String resourceOwnerAccount()

        The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.

        Returns:
        The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.

      • error

        public final String error()

        An error.

        Returns:
        An error.

      • hasSources

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

      • sources

        public final List<FindingSource> sources()

        The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

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

        Returns:
        The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)