Class CfnApiDestination
A CloudFormation AWS::Events::ApiDestination
.
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class CfnApiDestination : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApiDestination
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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:
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 .
CloudformationResource: AWS::Events::ApiDestination
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var cfnApiDestination = new CfnApiDestination(this, "MyCfnApiDestination", new CfnApiDestinationProps {
ConnectionArn = "connectionArn",
HttpMethod = "httpMethod",
InvocationEndpoint = "invocationEndpoint",
// the properties below are optional
Description = "description",
InvocationRateLimitPerSecond = 123,
Name = "name"
});
Synopsis
Constructors
CfnApiDestination(Construct, String, ICfnApiDestinationProps) | Create a new |
CfnApiDestination(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApiDestination(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The ARN of the API destination that was created by the request. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConnectionArn | The ARN of the connection to use for the API destination. |
Description | A description for the API destination to create. |
HttpMethod | The method to use for the request to the HTTP invocation endpoint. |
InvocationEndpoint | The URL to the HTTP invocation endpoint for the API destination. |
InvocationRateLimitPerSecond | The maximum number of requests per second to send to the HTTP invocation endpoint. |
Name | The name for the API destination to create. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApiDestination(Construct, String, ICfnApiDestinationProps)
Create a new AWS::Events::ApiDestination
.
public CfnApiDestination(Construct scope, string id, ICfnApiDestinationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApiDestinationProps
- resource properties.
CfnApiDestination(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApiDestination(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApiDestination(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApiDestination(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN of the API destination that was created by the request.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConnectionArn
The ARN of the connection to use for the API destination.
public virtual string ConnectionArn { get; set; }
Property Value
System.String
Remarks
The destination endpoint must support the authorization type specified for the connection.
Description
A description for the API destination to create.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
HttpMethod
The method to use for the request to the HTTP invocation endpoint.
public virtual string HttpMethod { get; set; }
Property Value
System.String
Remarks
InvocationEndpoint
The URL to the HTTP invocation endpoint for the API destination.
public virtual string InvocationEndpoint { get; set; }
Property Value
System.String
Remarks
InvocationRateLimitPerSecond
The maximum number of requests per second to send to the HTTP invocation endpoint.
public virtual Nullable<double> InvocationRateLimitPerSecond { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Name
The name for the API destination to create.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>