software.amazon.awscdk.services.events

Class CfnApiDestination

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.events.CfnApiDestination

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.251Z")
 @Stability(value=Stable)
public class CfnApiDestination
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Events::ApiDestination`.

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

When using ApiDesinations with OAuth authentication we recommend these best practices:

• Create a secret in Secrets Manager with your OAuth credentials.
• Reference that secret in your CloudFormation template for AWS::Events::Connection using CloudFormation dynamic reference syntax. For more information, see Secrets Manager secrets .

When the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using “Service Linked Secrets,” effectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated, not every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the ApiDestination and AWS is responsible for the fees.

The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated.

For examples of CloudFormation templates that use secrets, see Examples .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 CfnApiDestination cfnApiDestination = CfnApiDestination.Builder.create(this, "MyCfnApiDestination")
         .connectionArn("connectionArn")
         .httpMethod("httpMethod")
         .invocationEndpoint("invocationEndpoint")
         // the properties below are optional
         .description("description")
         .invocationRateLimitPerSecond(123)
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApiDestination(software.constructs.Construct scope, String id, CfnApiDestinationProps props) Create a new `AWS::Events::ApiDestination`.
protected	CfnApiDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApiDestination(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the API destination that was created by the request.
protected Map<String,Object>	getCfnProperties()
String	getConnectionArn() The ARN of the connection to use for the API destination.
String	getDescription() A description for the API destination to create.
String	getHttpMethod() The method to use for the request to the HTTP invocation endpoint.
String	getInvocationEndpoint() The URL to the HTTP invocation endpoint for the API destination.
Number	getInvocationRateLimitPerSecond() The maximum number of requests per second to send to the HTTP invocation endpoint.
String	getName() The name for the API destination to create.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionArn(String value) The ARN of the connection to use for the API destination.
void	setDescription(String value) A description for the API destination to create.
void	setHttpMethod(String value) The method to use for the request to the HTTP invocation endpoint.
void	setInvocationEndpoint(String value) The URL to the HTTP invocation endpoint for the API destination.
void	setInvocationRateLimitPerSecond(Number value) The maximum number of requests per second to send to the HTTP invocation endpoint.
void	setName(String value) The name for the API destination to create.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApiDestination

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

CfnApiDestination

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

CfnApiDestination

@Stability(value=Stable)
public CfnApiDestination(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnApiDestinationProps props)

Create a new `AWS::Events::ApiDestination`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the API destination that was created by the request.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionArn

@Stability(value=Stable)
 @NotNull
public String getConnectionArn()

The ARN of the connection to use for the API destination.

The destination endpoint must support the authorization type specified for the connection.

setConnectionArn

@Stability(value=Stable)
public void setConnectionArn(@NotNull
                                                      String value)

The ARN of the connection to use for the API destination.

The destination endpoint must support the authorization type specified for the connection.

getHttpMethod

@Stability(value=Stable)
 @NotNull
public String getHttpMethod()

The method to use for the request to the HTTP invocation endpoint.

setHttpMethod

@Stability(value=Stable)
public void setHttpMethod(@NotNull
                                                   String value)

The method to use for the request to the HTTP invocation endpoint.

getInvocationEndpoint

@Stability(value=Stable)
 @NotNull
public String getInvocationEndpoint()

The URL to the HTTP invocation endpoint for the API destination.

setInvocationEndpoint

@Stability(value=Stable)
public void setInvocationEndpoint(@NotNull
                                                           String value)

The URL to the HTTP invocation endpoint for the API destination.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the API destination to create.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the API destination to create.

getInvocationRateLimitPerSecond

@Stability(value=Stable)
 @Nullable
public Number getInvocationRateLimitPerSecond()

The maximum number of requests per second to send to the HTTP invocation endpoint.

setInvocationRateLimitPerSecond

@Stability(value=Stable)
public void setInvocationRateLimitPerSecond(@Nullable
                                                                     Number value)

The maximum number of requests per second to send to the HTTP invocation endpoint.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name for the API destination to create.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name for the API destination to create.