Skip to content

Endpoint

Source code in docs_src/capo_eventbridge/types/endpoint.py
class Endpoint(TypedDict, closed=True):
    name: NotRequired["capo_eventbridge.types.endpoint_name.EndpointName"]
    """<p>The name of the endpoint.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.endpoint_description.EndpointDescription"
    ]
    """<p>A description for the endpoint.</p>"""
    arn: NotRequired["capo_eventbridge.types.endpoint_arn.EndpointArn"]
    """<p>The ARN of the endpoint.</p>"""
    routing_config: NotRequired["capo_eventbridge.types.routing_config.RoutingConfig"]
    """<p>The routing configuration of the endpoint.</p>"""
    replication_config: NotRequired[
        "capo_eventbridge.types.replication_config.ReplicationConfig"
    ]
    """<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>"""
    event_buses: NotRequired[
        "capo_eventbridge.types.endpoint_event_bus_list.EndpointEventBusList"
    ]
    """<p>The event buses being used by the endpoint.</p>"""
    role_arn: NotRequired["capo_eventbridge.types.iam_role_arn.IamRoleArn"]
    """<p>The ARN of the role used by event replication for the endpoint.</p>"""
    endpoint_id: NotRequired["capo_eventbridge.types.endpoint_id.EndpointId"]
    """<p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>"""
    endpoint_url: NotRequired["capo_eventbridge.types.endpoint_url.EndpointUrl"]
    """<p>The URL of the endpoint.</p>"""
    state: NotRequired["capo_eventbridge.types.endpoint_state.EndpointState"]
    """<p>The current state of the endpoint.</p>"""
    state_reason: NotRequired[
        "capo_eventbridge.types.endpoint_state_reason.EndpointStateReason"
    ]
    """<p>The reason the endpoint is in its current state.</p>"""
    creation_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>The time the endpoint was created.</p>"""
    last_modified_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>The last time the endpoint was modified.</p>"""

arn instance-attribute

arn: NotRequired[EndpointArn]

The ARN of the endpoint.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time the endpoint was created.

description instance-attribute

description: NotRequired[EndpointDescription]

A description for the endpoint.

endpoint_id instance-attribute

endpoint_id: NotRequired[EndpointId]

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

endpoint_url instance-attribute

endpoint_url: NotRequired[EndpointUrl]

The URL of the endpoint.

event_buses instance-attribute

event_buses: NotRequired[EndpointEventBusList]

The event buses being used by the endpoint.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The last time the endpoint was modified.

name instance-attribute

name: NotRequired[EndpointName]

The name of the endpoint.

replication_config instance-attribute

replication_config: NotRequired[ReplicationConfig]

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[IamRoleArn]

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

routing_config instance-attribute

routing_config: NotRequired[RoutingConfig]

The routing configuration of the endpoint.

state instance-attribute

state: NotRequired[EndpointState]

The current state of the endpoint.

state_reason instance-attribute

state_reason: NotRequired[EndpointStateReason]

The reason the endpoint is in its current state.