software.amazon.awssdk.services.detective.model

Interface MemberDetail.Builder

All Superinterfaces:

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

Enclosing class:

MemberDetail

public static interface MemberDetail.Builder
extends SdkPojo, CopyableBuilder<MemberDetail.Builder,MemberDetail>

Method Summary

Modifier and Type	Method and Description
MemberDetail.Builder	accountId(String accountId) The AWS account identifier for the member account.
MemberDetail.Builder	administratorId(String administratorId) The AWS account identifier of the administrator account for the behavior graph.
MemberDetail.Builder	disabledReason(MemberDisabledReason disabledReason) For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
MemberDetail.Builder	disabledReason(String disabledReason) For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
MemberDetail.Builder	emailAddress(String emailAddress) The AWS account root user email address for the member account.
MemberDetail.Builder	graphArn(String graphArn) The ARN of the behavior graph that the member account was invited to.
MemberDetail.Builder	invitedTime(Instant invitedTime) The date and time that Detective sent the invitation to the member account.
MemberDetail.Builder	masterId(String masterId) The AWS account identifier of the administrator account for the behavior graph.
MemberDetail.Builder	percentOfGraphUtilization(Double percentOfGraphUtilization) The member account data volume as a percentage of the maximum allowed data volume.
MemberDetail.Builder	percentOfGraphUtilizationUpdatedTime(Instant percentOfGraphUtilizationUpdatedTime) The date and time when the graph utilization percentage was last updated.
MemberDetail.Builder	status(MemberStatus status) The current membership status of the member account.
MemberDetail.Builder	status(String status) The current membership status of the member account.
MemberDetail.Builder	updatedTime(Instant updatedTime) The date and time that the member account was last updated.
MemberDetail.Builder	volumeUsageInBytes(Long volumeUsageInBytes) The data volume in bytes per day for the member account.
MemberDetail.Builder	volumeUsageUpdatedTime(Instant volumeUsageUpdatedTime) The data and time when the member account data volume was last updated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

accountId

MemberDetail.Builder accountId(String accountId)

The AWS account identifier for the member account.

Parameters:

accountId - The AWS account identifier for the member account.

Returns:

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

emailAddress

MemberDetail.Builder emailAddress(String emailAddress)

The AWS account root user email address for the member account.

Parameters:

emailAddress - The AWS account root user email address for the member account.

Returns:

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

graphArn

MemberDetail.Builder graphArn(String graphArn)

The ARN of the behavior graph that the member account was invited to.

Parameters:

graphArn - The ARN of the behavior graph that the member account was invited to.

Returns:

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

masterId

MemberDetail.Builder masterId(String masterId)

The AWS account identifier of the administrator account for the behavior graph.

Parameters:

masterId - The AWS account identifier of the administrator account for the behavior graph.

Returns:

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

administratorId

MemberDetail.Builder administratorId(String administratorId)

The AWS account identifier of the administrator account for the behavior graph.

Parameters:

administratorId - The AWS account identifier of the administrator account for the behavior graph.

Returns:

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

status

MemberDetail.Builder status(String status)

The current membership status of the member account. The status can have one of the following values:

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.

• VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.

• ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

Parameters:

status - The current membership status of the member account. The status can have one of the following values:

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.

• VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.

• ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

Returns:

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

See Also:

MemberStatus, MemberStatus

status

MemberDetail.Builder status(MemberStatus status)

The current membership status of the member account. The status can have one of the following values:

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.

• VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.

• ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

Parameters:

status - The current membership status of the member account. The status can have one of the following values:

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.

• VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.

• ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

Returns:

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

See Also:

MemberStatus, MemberStatus

disabledReason

MemberDetail.Builder disabledReason(String disabledReason)

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

• VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.

• VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

Parameters:

disabledReason - For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

• VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.

• VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

Returns:

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

See Also:

MemberDisabledReason, MemberDisabledReason

disabledReason

MemberDetail.Builder disabledReason(MemberDisabledReason disabledReason)

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

• VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.

• VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

Parameters:

disabledReason - For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

• VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.

• VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

Returns:

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

See Also:

MemberDisabledReason, MemberDisabledReason

invitedTime

MemberDetail.Builder invitedTime(Instant invitedTime)

The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.

Parameters:

invitedTime - The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.

Returns:

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

updatedTime

MemberDetail.Builder updatedTime(Instant updatedTime)

The date and time that the member account was last updated. The value is in milliseconds since the epoch.

Parameters:

updatedTime - The date and time that the member account was last updated. The value is in milliseconds since the epoch.

Returns:

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

volumeUsageInBytes

MemberDetail.Builder volumeUsageInBytes(Long volumeUsageInBytes)

The data volume in bytes per day for the member account.

Parameters:

volumeUsageInBytes - The data volume in bytes per day for the member account.

Returns:

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

volumeUsageUpdatedTime

MemberDetail.Builder volumeUsageUpdatedTime(Instant volumeUsageUpdatedTime)

The data and time when the member account data volume was last updated.

Parameters:

volumeUsageUpdatedTime - The data and time when the member account data volume was last updated.

Returns:

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

percentOfGraphUtilization

MemberDetail.Builder percentOfGraphUtilization(Double percentOfGraphUtilization)

The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.

Note that this is not the percentage of the behavior graph data volume.

For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.

Parameters:

percentOfGraphUtilization - The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.

Note that this is not the percentage of the behavior graph data volume.

For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.

Returns:

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

percentOfGraphUtilizationUpdatedTime

MemberDetail.Builder percentOfGraphUtilizationUpdatedTime(Instant percentOfGraphUtilizationUpdatedTime)

The date and time when the graph utilization percentage was last updated.

Parameters:

percentOfGraphUtilizationUpdatedTime - The date and time when the graph utilization percentage was last updated.

Returns:

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