Skip to content

CreateEndpointRequest

Source code in docs_src/capo_eventbridge/types/create_endpoint_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class CreateEndpointRequest(TypedDict, closed=True):
    name: "capo_eventbridge.types.endpoint_name.EndpointName"
    """<p>The name of the global endpoint. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.endpoint_description.EndpointDescription"
    ]
    """<p>A description of the global endpoint.</p>"""
    routing_config: "capo_eventbridge.types.routing_config.RoutingConfig"
    """<p>Configure the routing policy, including the health check and secondary Region..</p>"""
    replication_config: NotRequired[
        "capo_eventbridge.types.replication_config.ReplicationConfig"
    ]
    """<p>Enable or disable event replication. 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: "capo_eventbridge.types.endpoint_event_bus_list.EndpointEventBusList"
    """<p>Define the event buses used. </p> <important> <p>The names of the event buses must be identical in each Region.</p> </important>"""
    role_arn: NotRequired["capo_eventbridge.types.iam_role_arn.IamRoleArn"]
    """<p>The ARN of the role used for replication.</p>"""

description instance-attribute 

description: NotRequired[EndpointDescription]

A description of the global endpoint.

event_buses instance-attribute 

event_buses: EndpointEventBusList

Define the event buses used.

The names of the event buses must be identical in each Region.

name instance-attribute 

name: EndpointName

The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

replication_config instance-attribute 

replication_config: NotRequired[ReplicationConfig]

Enable or disable event replication. 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 for replication.

routing_config instance-attribute 

routing_config: RoutingConfig

Configure the routing policy, including the health check and secondary Region..