Interface AwsIamAccessKeyDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsIamAccessKeyDetails

@Mutable
@NotThreadSafe
public static interface AwsIamAccessKeyDetails.Builder
extends SdkPojo, CopyableBuilder<AwsIamAccessKeyDetails.Builder,AwsIamAccessKeyDetails>

Method Summary

Modifier and Type	Method	Description
AwsIamAccessKeyDetails.Builder	accessKeyId(String accessKeyId)	The identifier of the access key.
AwsIamAccessKeyDetails.Builder	accountId(String accountId)	The Amazon Web Services account ID of the account for the key.
AwsIamAccessKeyDetails.Builder	createdAt(String createdAt)	Indicates when the IAM access key was created.
AwsIamAccessKeyDetails.Builder	principalId(String principalId)	The ID of the principal associated with an access key.
AwsIamAccessKeyDetails.Builder	principalName(String principalName)	The name of the principal.
AwsIamAccessKeyDetails.Builder	principalType(String principalType)	The type of principal associated with an access key.
default AwsIamAccessKeyDetails.Builder	sessionContext(Consumer<AwsIamAccessKeySessionContext.Builder> sessionContext)	Information about the session that the key was used for.
AwsIamAccessKeyDetails.Builder	sessionContext(AwsIamAccessKeySessionContext sessionContext)	Information about the session that the key was used for.
AwsIamAccessKeyDetails.Builder	status(String status)	The status of the IAM access key related to a finding.
AwsIamAccessKeyDetails.Builder	status(AwsIamAccessKeyStatus status)	The status of the IAM access key related to a finding.
AwsIamAccessKeyDetails.Builder	userName(String userName)	Deprecated. This filter is deprecated.

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, sdkFieldNameToField, sdkFields

Method Details

userName

@Deprecated
AwsIamAccessKeyDetails.Builder userName(String userName)

Deprecated.

This filter is deprecated. Instead, use PrincipalName.

The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

Parameters:

userName - The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

Returns:

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

status

AwsIamAccessKeyDetails.Builder status(String status)

The status of the IAM access key related to a finding.

Parameters:

status - The status of the IAM access key related to a finding.

Returns:

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

See Also:

• AwsIamAccessKeyStatus
• AwsIamAccessKeyStatus

status

AwsIamAccessKeyDetails.Builder status(AwsIamAccessKeyStatus status)

The status of the IAM access key related to a finding.

Parameters:

status - The status of the IAM access key related to a finding.

Returns:

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

See Also:

• AwsIamAccessKeyStatus
• AwsIamAccessKeyStatus

createdAt

AwsIamAccessKeyDetails.Builder createdAt(String createdAt)

Indicates when the IAM access key was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

Parameters:

createdAt - Indicates when the IAM access key was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestampsinvalid input: '<'/ a>.

Returns:

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

principalId

AwsIamAccessKeyDetails.Builder principalId(String principalId)

The ID of the principal associated with an access key.

Parameters:

principalId - The ID of the principal associated with an access key.

Returns:

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

principalType

AwsIamAccessKeyDetails.Builder principalType(String principalType)

The type of principal associated with an access key.

Parameters:

principalType - The type of principal associated with an access key.

Returns:

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

principalName

AwsIamAccessKeyDetails.Builder principalName(String principalName)

The name of the principal.

Parameters:

principalName - The name of the principal.

Returns:

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

accountId

AwsIamAccessKeyDetails.Builder accountId(String accountId)

The Amazon Web Services account ID of the account for the key.

Parameters:

accountId - The Amazon Web Services account ID of the account for the key.

Returns:

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

accessKeyId

AwsIamAccessKeyDetails.Builder accessKeyId(String accessKeyId)

The identifier of the access key.

Parameters:

accessKeyId - The identifier of the access key.

Returns:

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

sessionContext

AwsIamAccessKeyDetails.Builder sessionContext(AwsIamAccessKeySessionContext sessionContext)

Information about the session that the key was used for.

Parameters:

sessionContext - Information about the session that the key was used for.

Returns:

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

sessionContext

default AwsIamAccessKeyDetails.Builder sessionContext(Consumer<AwsIamAccessKeySessionContext.Builder> sessionContext)

Information about the session that the key was used for.

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

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

Parameters:

sessionContext - a consumer that will call methods on AwsIamAccessKeySessionContext.Builder

Returns:

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

See Also:

• sessionContext(AwsIamAccessKeySessionContext)