Class: Aws::ApplicationSignals::Types::ChangeEvent

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb

Overview

A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

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

Returns:

  • (String)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#change_event_typeString

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

Returns:

  • (String)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#entityHash<String,String>

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:

  • (Hash<String,String>)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#event_idString

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:

  • (String)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#event_nameString

The name or description of this change event.

Returns:

  • (String)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

The Amazon Web Services region where this change event occurred.

Returns:

  • (String)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#timestampTime

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

Returns:

  • (Time)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

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

Returns:

  • (String)


462
463
464
465
466
467
468
469
470
471
472
473
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 462

class ChangeEvent < Struct.new(
  :timestamp,
  :account_id,
  :region,
  :entity,
  :change_event_type,
  :event_id,
  :user_name,
  :event_name)
  SENSITIVE = []
  include Aws::Structure
end