Class: Aws::SecurityHub::Types::AwsEventsEndpointDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsEventsEndpointDetails

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the endpoint.

• #description ⇒ String

  A description of the endpoint.

• #endpoint_id ⇒ String

  The URL subdomain of the endpoint.

• #endpoint_url ⇒ String

  The URL of the endpoint.

• #event_buses ⇒ Array<Types::AwsEventsEndpointEventBusesDetails>

  The event buses being used by the endpoint.

• #name ⇒ String

  The name of the endpoint.

• #replication_config ⇒ Types::AwsEventsEndpointReplicationConfigDetails

  Whether event replication was enabled or disabled for this endpoint.

• #role_arn ⇒ String

  The ARN of the role used by event replication for the endpoint.

• #routing_config ⇒ Types::AwsEventsEndpointRoutingConfigDetails

  The routing configuration of the endpoint.

• #state ⇒ String

  The current state of the endpoint.

• #state_reason ⇒ String

  The reason the endpoint is in its current state.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_id ⇒ String

The URL subdomain of the endpoint. For example, if ‘EndpointUrl` is `abcde.veo.endpoints.event.amazonaws.com`, then the `EndpointId` is `abcde.veo`.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_url ⇒ String

The URL of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#event_buses ⇒ Array<Types::AwsEventsEndpointEventBusesDetails>

The event buses being used by the endpoint.

Returns:

• (Array<Types::AwsEventsEndpointEventBusesDetails>)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#replication_config ⇒ Types::AwsEventsEndpointReplicationConfigDetails

Whether event replication was enabled or disabled for this endpoint. The default state is ‘ENABLED`, which means you must supply a `RoleArn`. If you don’t have a ‘RoleArn` or you don’t want event replication enabled, set the state to ‘DISABLED`.

Returns:

• (Types::AwsEventsEndpointReplicationConfigDetails)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the role used by event replication for the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#routing_config ⇒ Types::AwsEventsEndpointRoutingConfigDetails

The routing configuration of the endpoint.

Returns:

• (Types::AwsEventsEndpointRoutingConfigDetails)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason the endpoint is in its current state.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 13156

class AwsEventsEndpointDetails < Struct.new(
  :arn,
  :description,
  :endpoint_id,
  :endpoint_url,
  :event_buses,
  :name,
  :replication_config,
  :role_arn,
  :routing_config,
  :state,
  :state_reason)
  SENSITIVE = []
  include Aws::Structure
end