Interface OrganizationEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OrganizationEvent.Builder,OrganizationEvent>, SdkBuilder<OrganizationEvent.Builder,OrganizationEvent>, SdkPojo
Enclosing class:
OrganizationEvent
@Mutable @NotThreadSafe public static interface OrganizationEvent.Builder extends SdkPojo, CopyableBuilder<OrganizationEvent.Builder,OrganizationEvent>

  • Method Details

    • arn

      OrganizationEvent.Builder arn(String arn)

      The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

      For example, an event ARN might look like the following:

      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

      Parameters:
      arn - The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

      For example, an event ARN might look like the following:

      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

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

    • service

      OrganizationEvent.Builder service(String service)

      The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

      Parameters:
      service - The Amazon Web Services service that is affected by the event, such as EC2 and RDS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTypeCode

      OrganizationEvent.Builder eventTypeCode(String eventTypeCode)

      The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

      Parameters:
      eventTypeCode - The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTypeCategory

      OrganizationEvent.Builder eventTypeCategory(String eventTypeCategory)

      A list of event type category codes. Possible values are issue, accountNotification , or scheduledChange. Currently, the investigation value isn't supported at this time.

      Parameters:
      eventTypeCategory - A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventTypeCategory

      OrganizationEvent.Builder eventTypeCategory(EventTypeCategory eventTypeCategory)

      A list of event type category codes. Possible values are issue, accountNotification , or scheduledChange. Currently, the investigation value isn't supported at this time.

      Parameters:
      eventTypeCategory - A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventScopeCode

      OrganizationEvent.Builder eventScopeCode(String eventScopeCode)

      This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

      • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

      • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

      • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

      Parameters:
      eventScopeCode - This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

      • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

      • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

      • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

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

    • eventScopeCode

      OrganizationEvent.Builder eventScopeCode(EventScopeCode eventScopeCode)

      This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

      • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

      • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

      • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

      Parameters:
      eventScopeCode - This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

      • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

      • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

      • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

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

    • region

      OrganizationEvent.Builder region(String region)

      The Amazon Web Services Region name of the event.

      Parameters:
      region - The Amazon Web Services Region name of the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      OrganizationEvent.Builder startTime(Instant startTime)

      The date and time that the event began.

      Parameters:
      startTime - The date and time that the event began.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      OrganizationEvent.Builder endTime(Instant endTime)

      The date and time that the event ended.

      Parameters:
      endTime - The date and time that the event ended.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedTime

      OrganizationEvent.Builder lastUpdatedTime(Instant lastUpdatedTime)

      The most recent date and time that the event was updated.

      Parameters:
      lastUpdatedTime - The most recent date and time that the event was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusCode

      OrganizationEvent.Builder statusCode(String statusCodeValue)

      The most recent status of the event. Possible values are open, closed, and upcoming.

      Parameters:
      statusCodeValue - The most recent status of the event. Possible values are open, closed, and upcoming.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusCode

      OrganizationEvent.Builder statusCode(EventStatusCode statusCodeValue)

      The most recent status of the event. Possible values are open, closed, and upcoming.

      Parameters:
      statusCodeValue - The most recent status of the event. Possible values are open, closed, and upcoming.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionability

      OrganizationEvent.Builder actionability(String actionability)

      The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

      Parameters:
      actionability - The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionability

      OrganizationEvent.Builder actionability(EventActionability actionability)

      The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

      Parameters:
      actionability - The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • personasWithStrings

      OrganizationEvent.Builder personasWithStrings(Collection<String> personas)

      A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

      Parameters:
      personas - A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • personasWithStrings

      OrganizationEvent.Builder personasWithStrings(String... personas)

      A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

      Parameters:
      personas - A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • personas

      OrganizationEvent.Builder personas(Collection<EventPersona> personas)

      A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

      Parameters:
      personas - A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • personas

      OrganizationEvent.Builder personas(EventPersona... personas)

      A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

      Parameters:
      personas - A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.