Class ApiDestination
java.lang.Object
software.amazon.jsii.JsiiObject
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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:36.928Z")
@Stability(Stable)
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 ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IApiDestination
IApiDestination.Jsii$Default, IApiDestination.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ApiDestination
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
ApiDestination
(software.amazon.jsii.JsiiObjectRef objRef) ApiDestination
(software.constructs.Construct scope, String id, ApiDestinationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the Api Destination created.The Name of the Api Destination created.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 software.constructs.Construct
toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
ApiDestination
protected ApiDestination(software.amazon.jsii.JsiiObjectRef objRef) -
ApiDestination
protected ApiDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
ApiDestination
@Stability(Stable) public ApiDestination(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApiDestinationProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
getApiDestinationArn
The ARN of the Api Destination created.- Specified by:
getApiDestinationArn
in interfaceIApiDestination
-
getApiDestinationName
The Name of the Api Destination created.- Specified by:
getApiDestinationName
in interfaceIApiDestination
-
getConnection
The Connection to associate with Api Destination.
-