Skip to content

AwsEventsEndpointDetails

Source code in docs_src/capo_securityhub/types/aws_events_endpoint_details.py
class AwsEventsEndpointDetails(TypedDict, closed=True):
    arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The Amazon Resource Name (ARN) of the endpoint. </p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> A description of the endpoint. </p>"""
    endpoint_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The URL subdomain of the endpoint. For example, if <code>EndpointUrl</code> is <code>https://abcde.veo.endpoints.event.amazonaws.com</code>, then the <code>EndpointId</code> is <code>abcde.veo</code>.</p>"""
    endpoint_url: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The URL of the endpoint.</p>"""
    event_buses: NotRequired[
        "capo_securityhub.types.aws_events_endpoint_event_buses_list.AwsEventsEndpointEventBusesList"
    ]
    """<p> The event buses being used by the endpoint.</p>"""
    name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The name of the endpoint.</p>"""
    replication_config: NotRequired[
        "capo_securityhub.types.aws_events_endpoint_replication_config_details.AwsEventsEndpointReplicationConfigDetails"
    ]
    """<p> Whether event replication was enabled or disabled for this endpoint. The default state is <code>ENABLED</code>, which means you must supply a <code>RoleArn</code>. If you don't have a <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>"""
    role_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The ARN of the role used by event replication for the endpoint.</p>"""
    routing_config: NotRequired[
        "capo_securityhub.types.aws_events_endpoint_routing_config_details.AwsEventsEndpointRoutingConfigDetails"
    ]
    """<p> The routing configuration of the endpoint.</p>"""
    state: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The current state of the endpoint.</p>"""
    state_reason: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The reason the endpoint is in its current state.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the endpoint.

description instance-attribute

description: NotRequired[NonEmptyString]

A description of the endpoint.

endpoint_id instance-attribute

endpoint_id: NotRequired[NonEmptyString]

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

endpoint_url instance-attribute

endpoint_url: NotRequired[NonEmptyString]

The URL of the endpoint.

event_buses instance-attribute

event_buses: NotRequired[AwsEventsEndpointEventBusesList]

The event buses being used by the endpoint.

name instance-attribute

name: NotRequired[NonEmptyString]

The name of the endpoint.

replication_config instance-attribute

replication_config: NotRequired[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.

role_arn instance-attribute

role_arn: NotRequired[NonEmptyString]

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

routing_config instance-attribute

routing_config: NotRequired[AwsEventsEndpointRoutingConfigDetails]

The routing configuration of the endpoint.

state instance-attribute

state: NotRequired[NonEmptyString]

The current state of the endpoint.

state_reason instance-attribute

state_reason: NotRequired[NonEmptyString]

The reason the endpoint is in its current state.