CfnConnectionProps

class aws_cdk.aws_events.CfnConnectionProps(*, authorization_type=None, auth_parameters=None, description=None, invocation_connectivity_parameters=None, kms_key_identifier=None, name=None)

Bases: object

Properties for defining a CfnConnection.

Parameters:

authorization_type (Optional[str]) – The type of authorization to use for the connection. .. epigraph:: OAUTH tokens are refreshed when a 401 or 407 response is returned.
auth_parameters (Union[IResolvable, AuthParametersProperty, Dict[str, Any], None]) – The authorization parameters to use to authorize with the endpoint. You must include only authorization parameters for the AuthorizationType you specify.
description (Optional[str]) – A description for the connection to create.
invocation_connectivity_parameters (Union[IResolvable, InvocationConnectivityParametersProperty, Dict[str, Any], None]) – 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 (Optional[str]) – The identifier of the AWS 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 AWS owned key to encrypt the connection. For more information, see Identify and view keys in the AWS Key Management Service Developer Guide .
name (Optional[str]) – The name for the connection to create.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_events as events

cfn_connection_props = events.CfnConnectionProps(
    authorization_type="authorizationType",
    auth_parameters=events.CfnConnection.AuthParametersProperty(
        api_key_auth_parameters=events.CfnConnection.ApiKeyAuthParametersProperty(
            api_key_name="apiKeyName",
            api_key_value="apiKeyValue"
        ),
        basic_auth_parameters=events.CfnConnection.BasicAuthParametersProperty(
            password="password",
            username="username"
        ),
        connectivity_parameters=events.CfnConnection.ConnectivityParametersProperty(
            resource_parameters=events.CfnConnection.ResourceParametersProperty(
                resource_configuration_arn="resourceConfigurationArn",

                # the properties below are optional
                resource_association_arn="resourceAssociationArn"
            )
        ),
        invocation_http_parameters=events.CfnConnection.ConnectionHttpParametersProperty(
            body_parameters=[events.CfnConnection.ParameterProperty(
                key="key",
                value="value",

                # the properties below are optional
                is_value_secret=False
            )],
            header_parameters=[events.CfnConnection.ParameterProperty(
                key="key",
                value="value",

                # the properties below are optional
                is_value_secret=False
            )],
            query_string_parameters=[events.CfnConnection.ParameterProperty(
                key="key",
                value="value",

                # the properties below are optional
                is_value_secret=False
            )]
        ),
        o_auth_parameters=events.CfnConnection.OAuthParametersProperty(
            authorization_endpoint="authorizationEndpoint",
            client_parameters=events.CfnConnection.ClientParametersProperty(
                client_id="clientId",
                client_secret="clientSecret"
            ),
            http_method="httpMethod",

            # the properties below are optional
            o_auth_http_parameters=events.CfnConnection.ConnectionHttpParametersProperty(
                body_parameters=[events.CfnConnection.ParameterProperty(
                    key="key",
                    value="value",

                    # the properties below are optional
                    is_value_secret=False
                )],
                header_parameters=[events.CfnConnection.ParameterProperty(
                    key="key",
                    value="value",

                    # the properties below are optional
                    is_value_secret=False
                )],
                query_string_parameters=[events.CfnConnection.ParameterProperty(
                    key="key",
                    value="value",

                    # the properties below are optional
                    is_value_secret=False
                )]
            )
        )
    ),
    description="description",
    invocation_connectivity_parameters=events.CfnConnection.InvocationConnectivityParametersProperty(
        resource_parameters=events.CfnConnection.ResourceParametersProperty(
            resource_configuration_arn="resourceConfigurationArn",

            # the properties below are optional
            resource_association_arn="resourceAssociationArn"
        )
    ),
    kms_key_identifier="kmsKeyIdentifier",
    name="name"
)

Attributes

auth_parameters

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters

authorization_type

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype

description

A description for the connection to create.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description

invocation_connectivity_parameters

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-invocationconnectivityparameters

kms_key_identifier

The identifier of the AWS 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 AWS owned key to encrypt the connection.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-kmskeyidentifier

name

The name for the connection to create.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name