Class: Aws::Health::Types::AffectedEntity

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

Overview

Information about an entity that is affected by a Health event.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The 12-digit Amazon Web Services account number that contains the affected entity.

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#entity_arn ⇒ String

The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id. Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#entity_metadata ⇒ Hash<String,String>

Additional metadata about the affected entity.

Returns:

  • (Hash<String,String>) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#entity_url ⇒ String

The URL of the affected entity.

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#entity_value ⇒ String

The ID of the affected entity.

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#event_arn ⇒ String

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:

  • (String) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The most recent time that the entity was updated.

Returns:

  • (Time) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#status_code ⇒ String

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of entity tags attached to the affected entity.

Currently, the tags property isn't supported.

Returns:

  • (Hash<String,String>) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 96

class AffectedEntity < Struct.new(
  :entity_arn,
  :event_arn,
  :entity_value,
  :entity_url,
  :aws_account_id,
  :last_updated_time,
  :status_code,
  :tags,
  :entity_metadata)
  SENSITIVE = []
  include Aws::Structure
end