Package 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 Details

    • accountId

      MemberDetail.Builder accountId(String accountId)

      The Amazon Web Services account identifier for the member account.

      Parameters:
      accountId - The Amazon Web Services 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 Amazon Web Services account root user email address for the member account.

      Parameters:
      emailAddress - The Amazon Web Services 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.

      Parameters:
      graphArn - The ARN of the behavior graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterId

      @Deprecated MemberDetail.Builder masterId(String masterId)
      Deprecated.
      This property is deprecated. Use AdministratorId instead.

      The Amazon Web Services account identifier of the administrator account for the behavior graph.

      Parameters:
      masterId - The Amazon Web Services 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 Amazon Web Services account identifier of the administrator account for the behavior graph.

      Parameters:
      administratorId - The Amazon Web Services 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 - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.

      • VERIFICATION_IN_PROGRESS - For invited accounts only, 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.

        For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.

      • VERIFICATION_FAILED - For invited accounts only. 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 currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.

      • ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

      Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.

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

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

      • VERIFICATION_IN_PROGRESS - For invited accounts only, 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.

        For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.

      • VERIFICATION_FAILED - For invited accounts only. 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 currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.

      • ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

      Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.

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

    • status

      MemberDetail.Builder status(MemberStatus status)

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

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

      • VERIFICATION_IN_PROGRESS - For invited accounts only, 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.

        For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.

      • VERIFICATION_FAILED - For invited accounts only. 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 currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.

      • ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

      Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.

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

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

      • VERIFICATION_IN_PROGRESS - For invited accounts only, 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.

        For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.

      • VERIFICATION_FAILED - For invited accounts only. 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 currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.

      • ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

      Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.

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

    • 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:

    • 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:

    • invitedTime

      MemberDetail.Builder invitedTime(Instant invitedTime)

      For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      Parameters:
      invitedTime - For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
      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 an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      Parameters:
      updatedTime - The date and time that the member account was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeUsageInBytes

      @Deprecated MemberDetail.Builder volumeUsageInBytes(Long volumeUsageInBytes)
      Deprecated.
      This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

      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

      @Deprecated MemberDetail.Builder volumeUsageUpdatedTime(Instant volumeUsageUpdatedTime)
      Deprecated.
      This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

      The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      Parameters:
      volumeUsageUpdatedTime - The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • percentOfGraphUtilization

      @Deprecated MemberDetail.Builder percentOfGraphUtilization(Double percentOfGraphUtilization)
      Deprecated.
      This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

      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

      @Deprecated MemberDetail.Builder percentOfGraphUtilizationUpdatedTime(Instant percentOfGraphUtilizationUpdatedTime)
      Deprecated.
      This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

      The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      Parameters:
      percentOfGraphUtilizationUpdatedTime - The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invitationType

      MemberDetail.Builder invitationType(String invitationType)

      The type of behavior graph membership.

      For an organization account in the organization behavior graph, the type is ORGANIZATION.

      For an account that was invited to a behavior graph, the type is INVITATION.

      Parameters:
      invitationType - The type of behavior graph membership.

      For an organization account in the organization behavior graph, the type is ORGANIZATION.

      For an account that was invited to a behavior graph, the type is INVITATION.

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

    • invitationType

      MemberDetail.Builder invitationType(InvitationType invitationType)

      The type of behavior graph membership.

      For an organization account in the organization behavior graph, the type is ORGANIZATION.

      For an account that was invited to a behavior graph, the type is INVITATION.

      Parameters:
      invitationType - The type of behavior graph membership.

      For an organization account in the organization behavior graph, the type is ORGANIZATION.

      For an account that was invited to a behavior graph, the type is INVITATION.

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

    • volumeUsageByDatasourcePackageWithStrings

      MemberDetail.Builder volumeUsageByDatasourcePackageWithStrings(Map<String,DatasourcePackageUsageInfo> volumeUsageByDatasourcePackage)

      Details on the volume of usage for each data source package in a behavior graph.

      Parameters:
      volumeUsageByDatasourcePackage - Details on the volume of usage for each data source package in a behavior graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeUsageByDatasourcePackage

      MemberDetail.Builder volumeUsageByDatasourcePackage(Map<DatasourcePackage,DatasourcePackageUsageInfo> volumeUsageByDatasourcePackage)

      Details on the volume of usage for each data source package in a behavior graph.

      Parameters:
      volumeUsageByDatasourcePackage - Details on the volume of usage for each data source package in a behavior graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasourcePackageIngestStatesWithStrings

      MemberDetail.Builder datasourcePackageIngestStatesWithStrings(Map<String,String> datasourcePackageIngestStates)

      The state of a data source package for the behavior graph.

      Parameters:
      datasourcePackageIngestStates - The state of a data source package for the behavior graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasourcePackageIngestStates

      MemberDetail.Builder datasourcePackageIngestStates(Map<DatasourcePackage,DatasourcePackageIngestState> datasourcePackageIngestStates)

      The state of a data source package for the behavior graph.

      Parameters:
      datasourcePackageIngestStates - The state of a data source package for the behavior graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.