Interface IApiDestinationAttributes

The properties to import an existing Api Destination.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApiDestinationAttributes

Syntax (vb)

Public Interface IApiDestinationAttributes

Remarks

ExampleMetadata: infused

Examples

var 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");

            var apiDestinationArn = "arn:aws:events:us-east-1:123456789012:api-destination/DestinationName/11111111-1111-1111-1111-111111111111";
            var apiDestinationArnForPolicy = "arn:aws:events:us-east-1:123456789012:api-destination/DestinationName";
            var destination = ApiDestination.FromApiDestinationAttributes(this, "Destination", new ApiDestinationAttributes {
                ApiDestinationArn = apiDestinationArn,
                Connection = connection,
                ApiDestinationArnForPolicy = apiDestinationArnForPolicy
            });

            var rule = new Rule(this, "OtherRule", new RuleProps {
                Schedule = Schedule.Rate(Duration.Minutes(10)),
                Targets = new [] { new ApiDestination(destination) }
            });

Synopsis

Properties

ApiDestinationArn	The ARN of the Api Destination.
ApiDestinationArnForPolicy	The Amazon Resource Name (ARN) of an API destination in resource format.
Connection	The Connection to associate with the Api Destination.

Properties

ApiDestinationArn

The ARN of the Api Destination.

string ApiDestinationArn { get; }

Property Value

string

Remarks

ExampleMetadata: infused

ApiDestinationArnForPolicy

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

string? ApiDestinationArnForPolicy { get; }

Property Value

string

Remarks

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

Connection

The Connection to associate with the Api Destination.

IConnectionRef Connection { get; }

Property Value

IConnectionRef

Remarks

ExampleMetadata: infused