Skip to content

UpdateConnectionRequest

Source code in docs_src/capo_eventbridge/types/update_connection_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class UpdateConnectionRequest(TypedDict, closed=True):
    name: "capo_eventbridge.types.connection_name.ConnectionName"
    """<p>The name of the connection to update.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.connection_description.ConnectionDescription"
    ]
    """<p>A description for the connection.</p>"""
    authorization_type: NotRequired[
        "capo_eventbridge.types.connection_authorization_type.ConnectionAuthorizationType"
    ]
    """<p>The type of authorization to use for the connection.</p>"""
    auth_parameters: NotRequired[
        "capo_eventbridge.types.update_connection_auth_request_parameters.UpdateConnectionAuthRequestParameters"
    ]
    """<p>The authorization parameters to use for the connection.</p>"""
    invocation_connectivity_parameters: NotRequired[
        "capo_eventbridge.types.connectivity_resource_parameters.ConnectivityResourceParameters"
    ]
    """<p>For connections to private APIs, the parameters to use for invoking the API.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html">Connecting to private APIs</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>"""
    kms_key_identifier: NotRequired[
        "capo_eventbridge.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p> <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html">Identify and view keys</a> in the <i>Key Management Service Developer Guide</i>. </p>"""

auth_parameters instance-attribute 

auth_parameters: NotRequired[UpdateConnectionAuthRequestParameters]

The authorization parameters to use for the connection.

authorization_type instance-attribute 

authorization_type: NotRequired[ConnectionAuthorizationType]

The type of authorization to use for the connection.

description instance-attribute 

description: NotRequired[ConnectionDescription]

A description for the connection.

invocation_connectivity_parameters instance-attribute 

invocation_connectivity_parameters: NotRequired[ConnectivityResourceParameters]

For connections to private APIs, the parameters to use for invoking the API.

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

kms_key_identifier instance-attribute 

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

name instance-attribute 

name: ConnectionName

The name of the connection to update.