ApiDestination

class aws_cdk.aws_events.ApiDestination(scope, id, *, connection, endpoint, api_destination_name=None, description=None, http_method=None, rate_limit_per_second=None)

Bases: Resource

Define an EventBridge Api Destination.

Resource:: AWS::Events::ApiDestination
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(Duration.minutes(1)),
    targets=[targets.ApiDestination(destination)]
)

Parameters:

scope (Construct) –
id (str) –
connection (IConnection) – The ARN of the connection to use for the API destination.
endpoint (str) – The URL to the HTTP invocation endpoint for the API destination..
api_destination_name (Optional[str]) – The name for the API destination. Default: - A unique name will be generated
description (Optional[str]) – A description for the API destination. Default: - none
http_method (Optional[HttpMethod]) – The method to use for the request to the HTTP invocation endpoint. Default: HttpMethod.POST
rate_limit_per_second (Union[int, float, None]) – The maximum number of requests per second to send to the HTTP invocation endpoint. Default: - Not rate limited

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

api_destination_arn

The ARN of the Api Destination created.

Attribute:: true

api_destination_name

The Name of the Api Destination created.

Attribute:: true

connection: The Connection to associate with Api Destination.

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 tree node.

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

Static Methods

classmethod from_api_destination_attributes(scope, id, *, api_destination_arn, connection)

Create an Api Destination construct from an existing Api Destination ARN.

Parameters:

scope (Construct) – The scope creating construct (usually this).
id (str) – The construct’s id.
api_destination_arn (str) – The ARN of the Api Destination.
connection (IConnection) – The Connection to associate with the Api Destination.

Return type:

ApiDestination

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool