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

Class CreateAccessPreviewRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.accessanalyzer.model.AccessAnalyzerRequest

software.amazon.awssdk.services.accessanalyzer.model.CreateAccessPreviewRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessPreviewRequest.Builder,CreateAccessPreviewRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAccessPreviewRequest
extends AccessAnalyzerRequest
implements ToCopyableBuilder<CreateAccessPreviewRequest.Builder,CreateAccessPreviewRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAccessPreviewRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	analyzerArn()	The ARN of the account analyzer used to generate the access preview.
static CreateAccessPreviewRequest.Builder	builder()
String	clientToken()	A client token.
Map<String,Configuration>	configurations()	Access control configuration for your resource that is used to generate the access preview.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConfigurations()	For responses, this returns true if the service returned a value for the Configurations property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessPreviewRequest.Builder>	serializableBuilderClass()
CreateAccessPreviewRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

analyzerArn

public final String analyzerArn()

The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

Returns:

The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

hasConfigurations

public final boolean hasConfigurations()

For responses, this returns true if the service returned a value for the Configurations 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.

configurations

public final Map<String,Configuration> configurations()

Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

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

Returns:

Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

clientToken

public final String clientToken()

A client token.

Returns:

A client token.

toBuilder

public CreateAccessPreviewRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessPreviewRequest.Builder,CreateAccessPreviewRequest>

Specified by:

toBuilder in class AccessAnalyzerRequest

builder

public static CreateAccessPreviewRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAccessPreviewRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo