Class ApiDestination

Define an EventBridge Api Destination.

Inheritance
System.Object
Resource
ApiDestination
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApiDestination : Resource, IApiDestination, IResource
Syntax (vb)
Public Class ApiDestination
    Inherits Resource
    Implements IApiDestination, IResource
Remarks

Resource: AWS::Events::ApiDestination

ExampleMetadata: infused

Examples
var connection = new Connection(this, "Connection", new ConnectionProps {
    Authorization = Authorization.ApiKey("x-api-key", SecretValue.SecretsManager("ApiSecretName")),
    Description = "Connection with API Key x-api-key"
});

var destination = new ApiDestination(this, "Destination", new ApiDestinationProps {
    Connection = connection,
    Endpoint = "https://example.com",
    Description = "Calling example.com with API key x-api-key"
});

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

Synopsis

Constructors

ApiDestination(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
ApiDestination(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
ApiDestination(Construct, String, IApiDestinationProps)

Properties

ApiDestinationArn

The ARN of the Api Destination created.
ApiDestinationName

The Name of the Api Destination created.
Connection

The Connection to associate with Api Destination.

Methods

FromApiDestinationAttributes(Construct, String, IApiDestinationAttributes)

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

Constructors

ApiDestination(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ApiDestination(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

ApiDestination(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ApiDestination(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

ApiDestination(Construct, String, IApiDestinationProps)

public ApiDestination(Construct scope, string id, IApiDestinationProps props)
Parameters
scope Constructs.Construct
id System.String
props IApiDestinationProps

Properties

ApiDestinationArn

The ARN of the Api Destination created.

public virtual string ApiDestinationArn { get; }
Property Value

System.String

Remarks

Attribute: true

ApiDestinationName

The Name of the Api Destination created.

public virtual string ApiDestinationName { get; }
Property Value

System.String

Remarks

Attribute: true

Connection

The Connection to associate with Api Destination.

public virtual IConnection Connection { get; }
Property Value

IConnection

Methods

FromApiDestinationAttributes(Construct, String, IApiDestinationAttributes)

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

public static ApiDestination FromApiDestinationAttributes(Construct scope, string id, IApiDestinationAttributes attrs)
Parameters
scope Constructs.Construct

The scope creating construct (usually this).

id System.String

The construct's id.

attrs IApiDestinationAttributes

The Api Destination import attributes.

Returns

ApiDestination

Implements

Constructs.IConstruct
Constructs.IDependable