Skip to content

CreateConnectionAuthRequestParameters

Source code in docs_src/capo_eventbridge/types/create_connection_auth_request_parameters.py
class CreateConnectionAuthRequestParameters(TypedDict, closed=True):
    basic_auth_parameters: NotRequired[
        "capo_eventbridge.types.create_connection_basic_auth_request_parameters.CreateConnectionBasicAuthRequestParameters"
    ]
    """<p>The Basic authorization parameters to use for the connection.</p>"""
    o_auth_parameters: NotRequired[
        "capo_eventbridge.types.create_connection_o_auth_request_parameters.CreateConnectionOAuthRequestParameters"
    ]
    """<p>The OAuth authorization parameters to use for the connection.</p>"""
    api_key_auth_parameters: NotRequired[
        "capo_eventbridge.types.create_connection_api_key_auth_request_parameters.CreateConnectionApiKeyAuthRequestParameters"
    ]
    """<p>The API key authorization parameters to use for the connection.</p>"""
    invocation_http_parameters: NotRequired[
        "capo_eventbridge.types.connection_http_parameters.ConnectionHttpParameters"
    ]
    """<p>The API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via <code>HttpParameters</code>, including query strings, the parameters added for the connection take precedence.</p>"""
    connectivity_parameters: NotRequired[
        "capo_eventbridge.types.connectivity_resource_parameters.ConnectivityResourceParameters"
    ]
    """<p>If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html">Authorization methods for connections</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>"""

api_key_auth_parameters instance-attribute

api_key_auth_parameters: NotRequired[CreateConnectionApiKeyAuthRequestParameters]

The API key authorization parameters to use for the connection.

basic_auth_parameters instance-attribute

basic_auth_parameters: NotRequired[CreateConnectionBasicAuthRequestParameters]

The Basic authorization parameters to use for the connection.

connectivity_parameters instance-attribute

connectivity_parameters: NotRequired[ConnectivityResourceParameters]

If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

invocation_http_parameters instance-attribute

invocation_http_parameters: NotRequired[ConnectionHttpParameters]

The API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters, including query strings, the parameters added for the connection take precedence.

o_auth_parameters instance-attribute

o_auth_parameters: NotRequired[CreateConnectionOAuthRequestParameters]

The OAuth authorization parameters to use for the connection.