Package software.amazon.awssdk.services.macie2.model

Class RetrievalConfiguration

java.lang.Object

software.amazon.awssdk.services.macie2.model.RetrievalConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RetrievalConfiguration.Builder,RetrievalConfiguration>

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

Provides information about the access method and settings that are used to retrieve occurrences of sensitive data reported by findings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RetrievalConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	The external ID to specify in the trust policy for the IAM role to assume when retrieving sensitive data from affected S3 objects (roleName).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RetrievalMode	retrievalMode()	The access method that's used to retrieve sensitive data from affected S3 objects.
String	retrievalModeAsString()	The access method that's used to retrieve sensitive data from affected S3 objects.
String	roleName()	The name of the IAM role that is in the affected Amazon Web Services account and Amazon Macie is allowed to assume when retrieving sensitive data from affected S3 objects for the account.
List<SdkField<?>>	sdkFields()
static Class<? extends RetrievalConfiguration.Builder>	serializableBuilderClass()
RetrievalConfiguration.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

externalId

public final String externalId()

The external ID to specify in the trust policy for the IAM role to assume when retrieving sensitive data from affected S3 objects (roleName). This value is null if the value for retrievalMode is CALLER_CREDENTIALS.

This ID is a unique alphanumeric string that Amazon Macie generates automatically after you configure it to assume an IAM role. For a Macie administrator to retrieve sensitive data from an affected S3 object for a member account, the trust policy for the role in the member account must include an sts:ExternalId condition that requires this ID.

Returns:

The external ID to specify in the trust policy for the IAM role to assume when retrieving sensitive data from affected S3 objects (roleName). This value is null if the value for retrievalMode is CALLER_CREDENTIALS.

This ID is a unique alphanumeric string that Amazon Macie generates automatically after you configure it to assume an IAM role. For a Macie administrator to retrieve sensitive data from an affected S3 object for a member account, the trust policy for the role in the member account must include an sts:ExternalId condition that requires this ID.

retrievalMode

public final RetrievalMode retrievalMode()

The access method that's used to retrieve sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie (roleName); and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data.

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

Returns:

The access method that's used to retrieve sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie (roleName); and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data.

See Also:

RetrievalMode

retrievalModeAsString

public final String retrievalModeAsString()

The access method that's used to retrieve sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie (roleName); and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data.

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

Returns:

The access method that's used to retrieve sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie (roleName); and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data.

See Also:

RetrievalMode

roleName

public final String roleName()

The name of the IAM role that is in the affected Amazon Web Services account and Amazon Macie is allowed to assume when retrieving sensitive data from affected S3 objects for the account. This value is null if the value for retrievalMode is CALLER_CREDENTIALS.

Returns:

The name of the IAM role that is in the affected Amazon Web Services account and Amazon Macie is allowed to assume when retrieving sensitive data from affected S3 objects for the account. This value is null if the value for retrievalMode is CALLER_CREDENTIALS.

toBuilder

public RetrievalConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrievalConfiguration.Builder,RetrievalConfiguration>

builder

public static RetrievalConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends RetrievalConfiguration.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