Class UpdateRetrievalConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UpdateRetrievalConfiguration.Builder,
UpdateRetrievalConfiguration>
Specifies the access method and settings to use when retrieving occurrences of sensitive data reported by findings. If your request specifies an Identity and Access Management (IAM) role to assume, Amazon Macie verifies that the role exists and the attached policies are configured correctly. If there's an issue, Macie returns an error. For information about addressing the issue, see Configuration options and requirements for retrieving sensitive data samples in the Amazon Macie User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final RetrievalMode
The access method to use when retrieving sensitive data from affected S3 objects.final String
The access method to use when retrieving sensitive data from affected S3 objects.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.static Class
<? extends UpdateRetrievalConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
retrievalMode
The access method to use when retrieving 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; and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data. If you specify ASSUME_ROLE, also specify the name of an existing IAM role for Macie to assume (roleName).
If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie permanently deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.
If the service returns an enum value that is not available in the current SDK version,
retrievalMode
will returnRetrievalMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromretrievalModeAsString()
.- Returns:
- The access method to use when retrieving 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; and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive
data. If you specify ASSUME_ROLE, also specify the name of an existing IAM role for Macie to assume
(roleName).
If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie permanently deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.
- See Also:
-
retrievalModeAsString
The access method to use when retrieving 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; and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data. If you specify ASSUME_ROLE, also specify the name of an existing IAM role for Macie to assume (roleName).
If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie permanently deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.
If the service returns an enum value that is not available in the current SDK version,
retrievalMode
will returnRetrievalMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromretrievalModeAsString()
.- Returns:
- The access method to use when retrieving 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; and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive
data. If you specify ASSUME_ROLE, also specify the name of an existing IAM role for Macie to assume
(roleName).
If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie permanently deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.
- See Also:
-
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. The trust and permissions policies for the role must meet all requirements for Macie to assume the role.
- 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. The trust and permissions policies for the role must meet all requirements for Macie to assume the role.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateRetrievalConfiguration.Builder,
UpdateRetrievalConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-