Interface ChangeEvent.Builder

  • Method Details

    • timestamp

      ChangeEvent.Builder timestamp(Instant timestamp)

      The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

      Parameters:
      timestamp - The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • accountId

      ChangeEvent.Builder accountId(String accountId)

      The Amazon Web Services account ID where this change event occurred.

      Parameters:
      accountId - The Amazon Web Services account ID where this change event occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • region

      ChangeEvent.Builder region(String region)

      The Amazon Web Services region where this change event occurred.

      Parameters:
      region - The Amazon Web Services region where this change event occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • entity

      The entity (service or resource) that was affected by this change event, including its key attributes.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

      • AwsAccountId specifies the account where this object is in.

      Below is an example of a service.

      { "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

      Below is an example of a resource.

      { "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

      Parameters:
      entity - The entity (service or resource) that was affected by this change event, including its key attributes.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

      • AwsAccountId specifies the account where this object is in.

      Below is an example of a service.

      { "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

      Below is an example of a resource.

      { "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

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

      ChangeEvent.Builder changeEventType(String changeEventType)

      The type of change event that occurred, such as DEPLOYMENT.

      Parameters:
      changeEventType - The type of change event that occurred, such as DEPLOYMENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • changeEventType

      ChangeEvent.Builder changeEventType(ChangeEventType changeEventType)

      The type of change event that occurred, such as DEPLOYMENT.

      Parameters:
      changeEventType - The type of change event that occurred, such as DEPLOYMENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • eventId

      ChangeEvent.Builder eventId(String eventId)

      A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be Unknown.

      Parameters:
      eventId - A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be Unknown.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • userName

      ChangeEvent.Builder userName(String userName)

      The name of the user who initiated this change event, if available.

      Parameters:
      userName - The name of the user who initiated this change event, if available.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • eventName

      ChangeEvent.Builder eventName(String eventName)

      The name or description of this change event.

      Parameters:
      eventName - The name or description of this change event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.