software.amazon.awscdk.services.events

Class CfnApiDestination

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.events.CfnApiDestination

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-21T22:31:01.495Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

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

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

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnApiDestination(Construct scope,
                         java.lang.String id,
                         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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionArn

public java.lang.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

public void setConnectionArn(java.lang.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

public java.lang.String getHttpMethod()

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

setHttpMethod

public void setHttpMethod(java.lang.String value)

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

getInvocationEndpoint

public java.lang.String getInvocationEndpoint()

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

setInvocationEndpoint

public void setInvocationEndpoint(java.lang.String value)

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

getDescription

public java.lang.String getDescription()

A description for the API destination to create.

setDescription

public void setDescription(java.lang.String value)

A description for the API destination to create.

getInvocationRateLimitPerSecond

public java.lang.Number getInvocationRateLimitPerSecond()

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

setInvocationRateLimitPerSecond

public void setInvocationRateLimitPerSecond(java.lang.Number value)

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

getName

public java.lang.String getName()

The name for the API destination to create.

setName

public void setName(java.lang.String value)

The name for the API destination to create.