software.amazon.awscdk.services.events

Class ApiDestination

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.events.ApiDestination

All Implemented Interfaces:

IConstruct, IDependable, IResource, IApiDestination

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:07.799Z")
public class ApiDestination
extends Resource
implements IApiDestination

Define an EventBridge Api Destination.

Example:

 Connection connection = Connection.Builder.create(this, "Connection")
         .authorization(Authorization.apiKey("x-api-key", SecretValue.secretsManager("ApiSecretName")))
         .description("Connection with API Key x-api-key")
         .build();
 ApiDestination destination = ApiDestination.Builder.create(this, "Destination")
         .connection(connection)
         .endpoint("https://example.com")
         .description("Calling example.com with API key x-api-key")
         .build();
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.minutes(1)))
         .targets(List.of(new ApiDestination(destination)))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiDestination.Builder A fluent builder for ApiDestination.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IApiDestination

IApiDestination.Jsii$Default, IApiDestination.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiDestination(software.amazon.jsii.JsiiObjectRef objRef)
	ApiDestination(software.constructs.Construct scope, java.lang.String id, ApiDestinationProps props)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiDestinationArn() The ARN of the Api Destination created.
java.lang.String	getApiDestinationName() The Name of the Api Destination created.
IConnection	getConnection() The Connection to associate with Api Destination.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

ApiDestination

protected ApiDestination(software.amazon.jsii.JsiiObjectRef objRef)

ApiDestination

protected ApiDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApiDestination

public ApiDestination(software.constructs.Construct scope,
                      java.lang.String id,
                      ApiDestinationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getApiDestinationArn

public java.lang.String getApiDestinationArn()

The ARN of the Api Destination created.

Specified by:

getApiDestinationArn in interface IApiDestination

getApiDestinationName

public java.lang.String getApiDestinationName()

The Name of the Api Destination created.

Specified by:

getApiDestinationName in interface IApiDestination

getConnection

public IConnection getConnection()

The Connection to associate with Api Destination.