Connection

class aws_cdk.aws_events.Connection(scope, id, *, authorization, body_parameters=None, connection_name=None, description=None, header_parameters=None, query_string_parameters=None)

Bases: Resource

Define an EventBridge Connection.

Resource:: AWS::Events::Connection
ExampleMetadata:: infused

Example:

connection = events.Connection(self, "Connection",
    authorization=events.Authorization.api_key("x-api-key", SecretValue.secrets_manager("ApiSecretName")),
    description="Connection with API Key x-api-key"
)

destination = events.ApiDestination(self, "Destination",
    connection=connection,
    endpoint="https://example.com",
    description="Calling example.com with API key x-api-key"
)

rule = events.Rule(self, "Rule",
    schedule=events.Schedule.rate(cdk.Duration.minutes(1)),
    targets=[targets.ApiDestination(destination)]
)

Parameters:

scope (Construct) –
id (str) –
authorization (Authorization) – The authorization type for the connection.
body_parameters (Optional[Mapping[str, HttpParameter]]) – Additional string parameters to add to the invocation bodies. Default: - No additional parameters
connection_name (Optional[str]) – The name of the connection. Default: - A name is automatically generated
description (Optional[str]) – The name of the connection. Default: - none
header_parameters (Optional[Mapping[str, HttpParameter]]) – Additional string parameters to add to the invocation headers. Default: - No additional parameters
query_string_parameters (Optional[Mapping[str, HttpParameter]]) – Additional string parameters to add to the invocation query strings. Default: - No additional parameters

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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 (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

connection_arn

The ARN of the connection created.

Attribute:: true

connection_name

The Name for the connection.

Attribute:: true

connection_secret_arn

The ARN for the secret created for the connection.

Attribute:: true

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_connection_attributes(scope, id, *, connection_arn, connection_name, connection_secret_arn)

Import an existing connection resource.

Parameters:

scope (Construct) – Parent construct.
id (str) – Construct ID.
connection_arn (str) – The ARN of the connection created.
connection_name (str) – The Name for the connection.
connection_secret_arn (str) – The ARN for the secret created for the connection.

Return type:

IConnection

classmethod from_event_bus_arn(scope, id, connection_arn, connection_secret_arn)

Import an existing connection resource.

Parameters:

scope (Construct) – Parent construct.
id (str) – Construct ID.
connection_arn (str) – ARN of imported connection.
connection_secret_arn (str) –

Return type:

IConnection

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool