interface IApiDestination

Language	Type name
.NET	Amazon.CDK.AWS.Events.IApiDestination
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsevents#IApiDestination
Java	software.amazon.awscdk.services.events.IApiDestination
Python	aws_cdk.aws_events.IApiDestination
TypeScript (source)	aws-cdk-lib » aws_events » IApiDestination

Implemented by ApiDestination

Interface for API Destinations.

Properties

Name	Type	Description
apiDestinationArn	string	The ARN of the Api Destination created.
apiDestinationName	string	The Name of the Api Destination created.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
apiDestinationArnForPolicy?	string	The Amazon Resource Name (ARN) of an API destination in resource format, so it can be used in the Resource element of IAM permission policy statements.

---

apiDestinationArn

Type: string

The ARN of the Api Destination created.

---

apiDestinationName

Type: string

The Name of the Api Destination created.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

apiDestinationArnForPolicy?

Type: string (optional)

The Amazon Resource Name (ARN) of an API destination in resource format, so it can be used in the Resource element of IAM permission policy statements.

See also: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoneventbridge.html#amazoneventbridge-resources-for-iam-policies

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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).