Interface AwsApiCallAction.Builder

All Superinterfaces:

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

Enclosing class:

AwsApiCallAction

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

Method Summary

Modifier and Type	Method	Description
AwsApiCallAction.Builder	affectedResources(Map<String,String> affectedResources)	Identifies the resources that were affected by the API call.
AwsApiCallAction.Builder	api(String api)	The name of the API method that was issued.
AwsApiCallAction.Builder	callerType(String callerType)	Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).
default AwsApiCallAction.Builder	domainDetails(Consumer<AwsApiCallActionDomainDetails.Builder> domainDetails)	Provided if CallerType is domain.
AwsApiCallAction.Builder	domainDetails(AwsApiCallActionDomainDetails domainDetails)	Provided if CallerType is domain.
AwsApiCallAction.Builder	firstSeen(String firstSeen)	A timestamp that indicates when the API call was first observed.
AwsApiCallAction.Builder	lastSeen(String lastSeen)	A timestamp that indicates when the API call was most recently observed.
default AwsApiCallAction.Builder	remoteIpDetails(Consumer<ActionRemoteIpDetails.Builder> remoteIpDetails)	Provided if CallerType is remoteip.
AwsApiCallAction.Builder	remoteIpDetails(ActionRemoteIpDetails remoteIpDetails)	Provided if CallerType is remoteip.
AwsApiCallAction.Builder	serviceName(String serviceName)	The name of the Amazon Web Services service that the API method belongs to.

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

api

AwsApiCallAction.Builder api(String api)

The name of the API method that was issued.

Length Constraints: 128.

Parameters:

api - The name of the API method that was issued.

Length Constraints: 128.

Returns:

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

serviceName

AwsApiCallAction.Builder serviceName(String serviceName)

The name of the Amazon Web Services service that the API method belongs to.

Length Constraints: 128.

Parameters:

serviceName - The name of the Amazon Web Services service that the API method belongs to.

Length Constraints: 128.

Returns:

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

callerType

AwsApiCallAction.Builder callerType(String callerType)

Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).

Parameters:

callerType - Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).

Returns:

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

remoteIpDetails

AwsApiCallAction.Builder remoteIpDetails(ActionRemoteIpDetails remoteIpDetails)

Provided if CallerType is remoteip. Provides information about the remote IP address that the API call originated from.

Parameters:

remoteIpDetails - Provided if CallerType is remoteip. Provides information about the remote IP address that the API call originated from.

Returns:

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

remoteIpDetails

default AwsApiCallAction.Builder remoteIpDetails(Consumer<ActionRemoteIpDetails.Builder> remoteIpDetails)

Provided if CallerType is remoteip. Provides information about the remote IP address that the API call originated from.

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

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

Parameters:

remoteIpDetails - a consumer that will call methods on ActionRemoteIpDetails.Builder

Returns:

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

See Also:

• remoteIpDetails(ActionRemoteIpDetails)

domainDetails

AwsApiCallAction.Builder domainDetails(AwsApiCallActionDomainDetails domainDetails)

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

Parameters:

domainDetails - Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

Returns:

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

domainDetails

default AwsApiCallAction.Builder domainDetails(Consumer<AwsApiCallActionDomainDetails.Builder> domainDetails)

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

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

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

Parameters:

domainDetails - a consumer that will call methods on AwsApiCallActionDomainDetails.Builder

Returns:

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

See Also:

• domainDetails(AwsApiCallActionDomainDetails)

affectedResources

AwsApiCallAction.Builder affectedResources(Map<String,String> affectedResources)

Identifies the resources that were affected by the API call.

Parameters:

affectedResources - Identifies the resources that were affected by the API call.

Returns:

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

firstSeen

AwsApiCallAction.Builder firstSeen(String firstSeen)

A timestamp that indicates when the API call was first observed.

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

Parameters:

firstSeen - A timestamp that indicates when the API call was first observed.

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.

lastSeen

AwsApiCallAction.Builder lastSeen(String lastSeen)

A timestamp that indicates when the API call was most recently observed.

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

Parameters:

lastSeen - A timestamp that indicates when the API call was most recently observed.

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.