Interface Event.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Event.Builder,Event>, SdkBuilder<Event.Builder,Event>, SdkPojo
Enclosing class:
Event
public static interface Event.Builder extends SdkPojo, CopyableBuilder<Event.Builder,Event>

  • Method Details

    • arn

      Event.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

      Event.Builder service(String service)

      The Amazon Web Service that is affected by the event. For example, EC2, RDS.

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

    • eventTypeCode

      Event.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

      Event.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

      Event.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:

    • region

      Event.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.

    • availabilityZone

      Event.Builder availabilityZone(String availabilityZone)

      The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

      Parameters:
      availabilityZone - The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      Event.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

      Event.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

      Event.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

      Event.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

      Event.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:

    • eventScopeCode

      Event.Builder eventScopeCode(String eventScopeCode)

      This parameter specifies if the Health event is a public Amazon Web 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 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

      Event.Builder eventScopeCode(EventScopeCode eventScopeCode)

      This parameter specifies if the Health event is a public Amazon Web 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 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: