Package software.amazon.awscdk.services.events

Interface ApiDestinationAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiDestinationAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:38.833Z")
@Stability(Stable)
public interface ApiDestinationAttributes
extends software.amazon.jsii.JsiiSerializable

The properties to import an existing Api Destination.

Example:

 IConnection connection = Connection.fromEventBusArn(this, "Connection", "arn:aws:events:us-east-1:123456789012:event-bus/EventBusName", "arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-f3gDy9");
 String apiDestinationArn = "arn:aws:events:us-east-1:123456789012:api-destination/DestinationName/11111111-1111-1111-1111-111111111111";
 String apiDestinationArnForPolicy = "arn:aws:events:us-east-1:123456789012:api-destination/DestinationName";
 ApiDestination destination = ApiDestination.fromApiDestinationAttributes(this, "Destination", ApiDestinationAttributes.builder()
         .apiDestinationArn(apiDestinationArn)
         .connection(connection)
         .apiDestinationArnForPolicy(apiDestinationArnForPolicy)
         .build());
 Rule rule = Rule.Builder.create(this, "OtherRule")
         .schedule(Schedule.rate(Duration.minutes(10)))
         .targets(List.of(new ApiDestination(destination)))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ApiDestinationAttributes.Builder	A builder for ApiDestinationAttributes
static final class	ApiDestinationAttributes.Jsii$Proxy	An implementation for ApiDestinationAttributes

Method Summary

Modifier and Type	Method	Description
static ApiDestinationAttributes.Builder	builder()
String	getApiDestinationArn()	The ARN of the Api Destination.
default String	getApiDestinationArnForPolicy()	The Amazon Resource Name (ARN) of an API destination in resource format.
IConnection	getConnection()	The Connection to associate with the Api Destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiDestinationArn

@Stability(Stable)
@NotNull
String getApiDestinationArn()

The ARN of the Api Destination.

getConnection

@Stability(Stable)
@NotNull
IConnection getConnection()

The Connection to associate with the Api Destination.

getApiDestinationArnForPolicy

@Stability(Stable)
@Nullable
default String getApiDestinationArnForPolicy()

The Amazon Resource Name (ARN) of an API destination in resource format.

Default: undefined - Imported API destination does not have ARN in resource format

builder

@Stability(Stable)
static ApiDestinationAttributes.Builder builder()

Returns:

a ApiDestinationAttributes.Builder of ApiDestinationAttributes