AccessPreviewFinding (AWS Java SDK :: Services :: AccessAnalyzer 2.17.67 API)

java.lang.Object
- software.amazon.awssdk.services.accessanalyzer.model.AccessPreviewFinding

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AccessPreviewFinding.Builder,AccessPreviewFinding>

@Generated(value="software.amazon.awssdk:codegen")
public final class AccessPreviewFinding
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AccessPreviewFinding.Builder,AccessPreviewFinding>

An access preview finding generated by the access preview.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AccessPreviewFinding.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AccessPreviewFinding.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`action()` The action in the analyzed policy statement that an external principal has permission to perform.
`static AccessPreviewFinding.Builder`	`builder()`
`FindingChangeType`	`changeType()` Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.
`String`	`changeTypeAsString()` Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.
`Map<String,String>`	`condition()` The condition in the analyzed policy statement that resulted in a finding.
`Instant`	`createdAt()` The time at which the access preview finding was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`error()` An error.
`String`	`existingFindingId()` The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.
`FindingStatus`	`existingFindingStatus()` The existing status of the finding, provided only for existing findings.
`String`	`existingFindingStatusAsString()` The existing status of the finding, provided only for existing findings.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAction()` For responses, this returns true if the service returned a value for the Action property.
`boolean`	`hasCondition()` For responses, this returns true if the service returned a value for the Condition property.
`int`	`hashCode()`
`boolean`	`hasPrincipal()` For responses, this returns true if the service returned a value for the Principal property.
`boolean`	`hasSources()` For responses, this returns true if the service returned a value for the Sources property.
`String`	`id()` The ID of the access preview finding.
`Boolean`	`isPublic()` Indicates whether the policy that generated the finding allows public access to the resource.
`Map<String,String>`	`principal()` The external principal that has access to a resource within the zone of trust.
`String`	`resource()` The resource that an external principal has access to.
`String`	`resourceOwnerAccount()` The Amazon Web Services account ID that owns the resource.
`ResourceType`	`resourceType()` The type of the resource that can be accessed in the finding.
`String`	`resourceTypeAsString()` The type of the resource that can be accessed in the finding.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AccessPreviewFinding.Builder>`	`serializableBuilderClass()`
`List<FindingSource>`	`sources()` The sources of the finding.
`FindingStatus`	`status()` The preview status of the finding.
`String`	`statusAsString()` The preview status of the finding.
`AccessPreviewFinding.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
  - 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
  - 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.
  - 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.
  - error
```
public final String error()
```
    An error.
    
    Returns:
    
    An error.
  - 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.
  - existingFindingStatus
```
public final FindingStatus existingFindingStatus()
```
    The existing status of the finding, provided only for existing findings.
    
    If the service returns an enum value that is not available in the current SDK version, existingFindingStatus will return FindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from existingFindingStatusAsString().
    
    Returns:
    
    The existing status of the finding, provided only for existing findings.
    
    See Also:
    
    FindingStatus
  - existingFindingStatusAsString
```
public final String existingFindingStatusAsString()
```
    The existing status of the finding, provided only for existing findings.
    
    If the service returns an enum value that is not available in the current SDK version, existingFindingStatus will return FindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from existingFindingStatusAsString().
    
    Returns:
    
    The existing status of the finding, provided only for existing findings.
    
    See Also:
    
    FindingStatus
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - resourceType
```
public final ResourceType resourceType()
```
    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
  - 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
  - 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.
  - 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
  - toBuilder
```
public AccessPreviewFinding.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AccessPreviewFinding.Builder,AccessPreviewFinding>
  - builder
```
public static AccessPreviewFinding.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AccessPreviewFinding.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AccessPreviewFinding

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAction

action

changeType

changeTypeAsString

hasCondition

condition

createdAt

error

existingFindingId

existingFindingStatus

existingFindingStatusAsString

id

isPublic

hasPrincipal

principal

resource

resourceOwnerAccount

resourceType

resourceTypeAsString

hasSources

sources

status

statusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields