Skip to content
v2.273.0

ApiDestinationAttributes Struct ​

The properties to import an existing Api Destination.

Example ​

ts
const connection = events.Connection.fromEventBusArn(
  this,
  'Connection',
  'arn:aws:events:us-east-1:123456789012:event-bus/EventBusName',
  'arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-f3gDy9',
);

const apiDestinationArn = 'arn:aws:events:us-east-1:123456789012:api-destination/DestinationName/11111111-1111-1111-1111-111111111111';
const apiDestinationArnForPolicy = 'arn:aws:events:us-east-1:123456789012:api-destination/DestinationName';
const destination = events.ApiDestination.fromApiDestinationAttributes(
  this,
  'Destination',
  {
    apiDestinationArn,
    connection,
    apiDestinationArnForPolicy // optional
  },
);

const rule = new events.Rule(this, 'OtherRule', {
  schedule: events.Schedule.rate(Duration.minutes(10)),
  targets: [new targets.ApiDestination(destination)],
});

Properties ​

apiDestinationArnstringapi_destination_arnstrapiDestinationArnStringApiDestinationArnstringApiDestinationArn*stringrequired#
The ARN of the Api Destination.
apiDestinationArnForPolicystringapi_destination_arn_for_policystrapiDestinationArnForPolicyStringApiDestinationArnForPolicystringApiDestinationArnForPolicy*string= undefined - Imported API destina…#
The Amazon Resource Name (ARN) of an API destination in resource format.
default

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

connectionIConnectionRefconnectionIConnectionRefconnectionIConnectionRefConnectionIConnectionRefConnectionIConnectionRefrequired#
The Connection to associate with the Api Destination.