Interface IApiDestinationProps
Customize the EventBridge Api Destinations Target.
Inherited Members
Namespace: Amazon.CDK.AWS.Events.Targets
Assembly: Amazon.CDK.AWS.Events.Targets.dll
Syntax (csharp)
public interface IApiDestinationProps : ITargetBaseProps
Syntax (vb)
Public Interface IApiDestinationProps
Inherits ITargetBaseProps
Remarks
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;
using Amazon.CDK.AWS.Events.Targets;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.SQS;
using Amazon.CDK;
Queue queue;
Role role;
RuleTargetInput ruleTargetInput;
var apiDestinationProps = new ApiDestinationProps {
DeadLetterQueue = queue,
Event = ruleTargetInput,
EventRole = role,
HeaderParameters = new Dictionary<string, string> {
{ "headerParametersKey", "headerParameters" }
},
MaxEventAge = Duration.Minutes(30),
PathParameterValues = new [] { "pathParameterValues" },
QueryStringParameters = new Dictionary<string, string> {
{ "queryStringParametersKey", "queryStringParameters" }
},
RetryAttempts = 123
};
Synopsis
Properties
Event | The event to send. |
EventRole | The role to assume before invoking the target. |
HeaderParameters | Additional headers sent to the API Destination. |
PathParameterValues | Path parameters to insert in place of path wildcards ( |
QueryStringParameters | Additional query string parameters sent to the API Destination. |
Properties
Event
The event to send.
virtual RuleTargetInput Event { get; }
Property Value
Remarks
Default: - the entire EventBridge event
EventRole
The role to assume before invoking the target.
virtual IRole EventRole { get; }
Property Value
Remarks
Default: - a new role will be created
HeaderParameters
Additional headers sent to the API Destination.
virtual IDictionary<string, string> HeaderParameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.
You can only specify secret values on the Connection.
Default: - none
PathParameterValues
Path parameters to insert in place of path wildcards (*
).
virtual string[] PathParameterValues { get; }
Property Value
System.String[]
Remarks
If the API destination has a wilcard in the path, these path parts will be inserted in that place.
Default: - none
QueryStringParameters
Additional query string parameters sent to the API Destination.
virtual IDictionary<string, string> QueryStringParameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.
You can only specify secret values on the Connection.
Default: - none