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

Interface AccessPreview.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AccessPreview.Builder,AccessPreview>, SdkBuilder<AccessPreview.Builder,AccessPreview>, SdkPojo

Enclosing class:

AccessPreview

public static interface AccessPreview.Builder
extends SdkPojo, CopyableBuilder<AccessPreview.Builder,AccessPreview>

Method Summary

Modifier and Type	Method	Description
AccessPreview.Builder	analyzerArn(String analyzerArn)	The ARN of the analyzer used to generate the access preview.
AccessPreview.Builder	configurations(Map<String,Configuration> configurations)	A map of resource ARNs for the proposed resource configuration.
AccessPreview.Builder	createdAt(Instant createdAt)	The time at which the access preview was created.
AccessPreview.Builder	id(String id)	The unique ID for the access preview.
AccessPreview.Builder	status(String status)	The status of the access preview.
AccessPreview.Builder	status(AccessPreviewStatus status)	The status of the access preview.
default AccessPreview.Builder	statusReason(Consumer<AccessPreviewStatusReason.Builder> statusReason)	Provides more details about the current status of the access preview.
AccessPreview.Builder	statusReason(AccessPreviewStatusReason statusReason)	Provides more details about the current status of the access preview.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

id

AccessPreview.Builder id(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.

analyzerArn

AccessPreview.Builder analyzerArn(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.

configurations

AccessPreview.Builder configurations(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.

createdAt

AccessPreview.Builder createdAt(Instant 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.

status

AccessPreview.Builder status(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, AccessPreviewStatus

status

AccessPreview.Builder status(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, AccessPreviewStatus

statusReason

AccessPreview.Builder statusReason(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.

statusReason

default AccessPreview.Builder statusReason(Consumer<AccessPreviewStatusReason.Builder> 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.

This is a convenience method that creates an instance of the AccessPreviewStatusReason.Builder avoiding the need to create one manually via AccessPreviewStatusReason.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusReason(AccessPreviewStatusReason).

Parameters:

statusReason - a consumer that will call methods on AccessPreviewStatusReason.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

statusReason(AccessPreviewStatusReason)