CfnConnectionProps

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

Bases: object

Properties for defining a CfnConnection.

Parameters
  • authorization_type (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]) – A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

  • description (Optional[str]) – A description for the connection to create.

  • name (Optional[str]) – The name for the connection to create.

Link

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.
import aws_cdk.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"
        ),
        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
                )]
            )
        )
    ),

    # the properties below are optional
    description="description",
    name="name"
)

Attributes

auth_parameters

A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

Link

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

Return type

Union[IResolvable, AuthParametersProperty]

authorization_type

The type of authorization to use for the connection.

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

Link

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

Return type

str

description

A description for the connection to create.

Link

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

Return type

Optional[str]

name

The name for the connection to create.

Link

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

Return type

Optional[str]