AccessPreview (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.accessanalyzer.model.AccessPreview

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccessPreview
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information about an access preview.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AccessPreview()

Constructors
Constructor and Description
`AccessPreview()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessPreview`	`addConfigurationsEntry(String key, Configuration value)` Add a single Configurations entry
`AccessPreview`	`clearConfigurationsEntries()` Removes all the entries added into Configurations.
`AccessPreview`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAnalyzerArn()` The ARN of the analyzer used to generate the access preview.
`Map<String,Configuration>`	`getConfigurations()` A map of resource ARNs for the proposed resource configuration.
`Date`	`getCreatedAt()` The time at which the access preview was created.
`String`	`getId()` The unique ID for the access preview.
`String`	`getStatus()` The status of the access preview.
`AccessPreviewStatusReason`	`getStatusReason()` Provides more details about the current status of the access preview.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAnalyzerArn(String analyzerArn)` The ARN of the analyzer used to generate the access preview.
`void`	`setConfigurations(Map<String,Configuration> configurations)` A map of resource ARNs for the proposed resource configuration.
`void`	`setCreatedAt(Date createdAt)` The time at which the access preview was created.
`void`	`setId(String id)` The unique ID for the access preview.
`void`	`setStatus(String status)` The status of the access preview.
`void`	`setStatusReason(AccessPreviewStatusReason statusReason)` Provides more details about the current status of the access preview.
`String`	`toString()` Returns a string representation of this object.
`AccessPreview`	`withAnalyzerArn(String analyzerArn)` The ARN of the analyzer used to generate the access preview.
`AccessPreview`	`withConfigurations(Map<String,Configuration> configurations)` A map of resource ARNs for the proposed resource configuration.
`AccessPreview`	`withCreatedAt(Date createdAt)` The time at which the access preview was created.
`AccessPreview`	`withId(String id)` The unique ID for the access preview.
`AccessPreview`	`withStatus(AccessPreviewStatus status)` The status of the access preview.
`AccessPreview`	`withStatus(String status)` The status of the access preview.
`AccessPreview`	`withStatusReason(AccessPreviewStatusReason statusReason)` Provides more details about the current status of the access preview.

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

- Constructor Detail
  - AccessPreview
```
public AccessPreview()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The unique ID for the access preview.
    
    Parameters:
    
    id - The unique ID for the access preview.
  - getId
```
public String getId()
```
    The unique ID for the access preview.
    
    Returns:
    
    The unique ID for the access preview.
  - withId
```
public AccessPreview withId(String id)
```
    The unique ID for the access preview.
    
    Parameters:
    
    id - The unique ID for the access preview.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnalyzerArn
```
public void setAnalyzerArn(String analyzerArn)
```
    The ARN of the analyzer used to generate the access preview.
    
    Parameters:
    
    analyzerArn - The ARN of the analyzer used to generate the access preview.
  - getAnalyzerArn
```
public String getAnalyzerArn()
```
    The ARN of the analyzer used to generate the access preview.
    
    Returns:
    
    The ARN of the analyzer used to generate the access preview.
  - withAnalyzerArn
```
public AccessPreview withAnalyzerArn(String analyzerArn)
```
    The ARN of the analyzer used to generate the access preview.
    
    Parameters:
    
    analyzerArn - The ARN of the analyzer used to generate the access preview.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getConfigurations
```
public Map<String,Configuration> getConfigurations()
```
    A map of resource ARNs for the proposed resource configuration.
    
    Returns:
    
    A map of resource ARNs for the proposed resource configuration.
  - setConfigurations
```
public void setConfigurations(Map<String,Configuration> configurations)
```
    A map of resource ARNs for the proposed resource configuration.
    
    Parameters:
    
    configurations - A map of resource ARNs for the proposed resource configuration.
  - withConfigurations
```
public AccessPreview withConfigurations(Map<String,Configuration> configurations)
```
    A map of resource ARNs for the proposed resource configuration.
    
    Parameters:
    
    configurations - A map of resource ARNs for the proposed resource configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addConfigurationsEntry
```
public AccessPreview addConfigurationsEntry(String key,
                                            Configuration value)
```
    Add a single Configurations entry
    
    See Also:
    
    withConfigurations(java.util.Map<java.lang.String, com.amazonaws.services.accessanalyzer.model.Configuration>)
  - clearConfigurationsEntries
```
public AccessPreview clearConfigurationsEntries()
```
    Removes all the entries added into Configurations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time at which the access preview was created.
    
    Parameters:
    
    createdAt - The time at which the access preview was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time at which the access preview was created.
    
    Returns:
    
    The time at which the access preview was created.
  - withCreatedAt
```
public AccessPreview withCreatedAt(Date createdAt)
```
    The time at which the access preview was created.
    
    Parameters:
    
    createdAt - The time at which the access preview was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    AccessPreviewStatus
  - getStatus
```
public String getStatus()
```
    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.
    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:
    
    AccessPreviewStatus
  - withStatus
```
public AccessPreview withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessPreviewStatus
  - withStatus
```
public AccessPreview withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessPreviewStatus
  - setStatusReason
```
public void setStatusReason(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.
    
    Parameters:
    
    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.
  - getStatusReason
```
public AccessPreviewStatusReason getStatusReason()
```
    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.
  - withStatusReason
```
public AccessPreview withStatusReason(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AccessPreview clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class AccessPreview

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessPreview

Method Detail

setId

getId

withId

setAnalyzerArn

getAnalyzerArn

withAnalyzerArn

getConfigurations

setConfigurations

withConfigurations

addConfigurationsEntry

clearConfigurationsEntries

setCreatedAt

getCreatedAt

withCreatedAt

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

toString

equals

hashCode

clone

marshall