CfnConnection

class aws_cdk.aws_events.CfnConnection(scope, id, *, authorization_type, auth_parameters, description=None, name=None)

Bases: CfnResource

A CloudFormation AWS::Events::Connection.

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

CloudformationResource:

AWS::Events::Connection

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 = events.CfnConnection(self, "MyCfnConnection",
    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"
)

Create a new AWS::Events::Connection.

Parameters:

  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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, Dict[str, Any]]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Events::Connection'
attr_arn

The ARN of the connection that was created by the request.

CloudformationAttribute:

Arn

attr_secret_arn

The ARN for the secret created for the connection.

CloudformationAttribute:

SecretArn

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

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

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

node

The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any)

Return type:

bool

ApiKeyAuthParametersProperty

class CfnConnection.ApiKeyAuthParametersProperty(*, api_key_name, api_key_value)

Bases: object

Contains the API key authorization parameters for the connection.

Parameters:

  • api_key_name (str) – The name of the API key to use for authorization.

  • api_key_value (str) – The value for the API key to use for authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.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

api_key_auth_parameters_property = events.CfnConnection.ApiKeyAuthParametersProperty(
    api_key_name="apiKeyName",
    api_key_value="apiKeyValue"
)

Attributes

api_key_name

The name of the API key to use for authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname

api_key_value

The value for the API key to use for authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue

AuthParametersProperty

class CfnConnection.AuthParametersProperty(*, api_key_auth_parameters=None, basic_auth_parameters=None, invocation_http_parameters=None, o_auth_parameters=None)

Bases: object

Contains the authorization parameters to use for the connection.

Parameters:
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.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

auth_parameters_property = 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
            )]
        )
    )
)

Attributes

api_key_auth_parameters

The API Key parameters to use for authorization.

Link:

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

basic_auth_parameters

The authorization parameters for Basic authorization.

Link:

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

invocation_http_parameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

Link:

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

o_auth_parameters

The OAuth parameters to use for authorization.

Link:

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

BasicAuthParametersProperty

class CfnConnection.BasicAuthParametersProperty(*, password, username)

Bases: object

Contains the Basic authorization parameters for the connection.

Parameters:

  • password (str) – The password associated with the user name to use for Basic authorization.

  • username (str) – The user name to use for Basic authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.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

basic_auth_parameters_property = events.CfnConnection.BasicAuthParametersProperty(
    password="password",
    username="username"
)

Attributes

password

The password associated with the user name to use for Basic authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-password

username

The user name to use for Basic authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-username

ClientParametersProperty

class CfnConnection.ClientParametersProperty(*, client_id, client_secret)

Bases: object

Contains the OAuth authorization parameters to use for the connection.

Parameters:

  • client_id (str) – The client ID to use for OAuth authorization.

  • client_secret (str) – The client secret assciated with the client ID to use for OAuth authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.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

client_parameters_property = events.CfnConnection.ClientParametersProperty(
    client_id="clientId",
    client_secret="clientSecret"
)

Attributes

client_id

The client ID to use for OAuth authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientid

client_secret

The client secret assciated with the client ID to use for OAuth authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientsecret

ConnectionHttpParametersProperty

class CfnConnection.ConnectionHttpParametersProperty(*, body_parameters=None, header_parameters=None, query_string_parameters=None)

Bases: object

Contains additional parameters for the connection.

Parameters:
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.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

connection_http_parameters_property = 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
    )]
)

Attributes

body_parameters

Contains additional body string parameters for the connection.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters

header_parameters

Contains additional header parameters for the connection.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters

query_string_parameters

Contains additional query string parameters for the connection.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters

OAuthParametersProperty

class CfnConnection.OAuthParametersProperty(*, authorization_endpoint, client_parameters, http_method, o_auth_http_parameters=None)

Bases: object

Contains the OAuth authorization parameters to use for the connection.

Parameters:

  • authorization_endpoint (str) – The URL to the authorization endpoint when OAuth is specified as the authorization type.

  • client_parameters (Union[IResolvable, ClientParametersProperty, Dict[str, Any]]) – A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

  • http_method (str) – The method to use for the authorization request.

  • o_auth_http_parameters (Union[IResolvable, ConnectionHttpParametersProperty, Dict[str, Any], None]) – A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.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

o_auth_parameters_property = 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
        )]
    )
)

Attributes

authorization_endpoint

The URL to the authorization endpoint when OAuth is specified as the authorization type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-authorizationendpoint

client_parameters

A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters

http_method

The method to use for the authorization request.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-httpmethod

o_auth_http_parameters

A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters

ParameterProperty

class CfnConnection.ParameterProperty(*, key, value, is_value_secret=None)

Bases: object

Additional query string parameter for the connection.

You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

Parameters:

  • key (str) – The key for a query string parameter.

  • value (str) – The value associated with the key for the query string parameter.

  • is_value_secret (Union[bool, IResolvable, None]) – Specifies whether the value is secret.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.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

parameter_property = events.CfnConnection.ParameterProperty(
    key="key",
    value="value",

    # the properties below are optional
    is_value_secret=False
)

Attributes

is_value_secret

Specifies whether the value is secret.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-isvaluesecret

key

The key for a query string parameter.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-key

value

The value associated with the key for the query string parameter.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-value