Interface ApiDestinationProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, TargetBaseProps
All Known Implementing Classes:
ApiDestinationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:52.024Z") @Stability(Stable) public interface ApiDestinationProps extends software.amazon.jsii.JsiiSerializable, TargetBaseProps
Customize the EventBridge Api Destinations Target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.events.*;
 import software.amazon.awscdk.services.events.targets.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 Role role;
 RuleTargetInput ruleTargetInput;
 ApiDestinationProps apiDestinationProps = ApiDestinationProps.builder()
         .deadLetterQueue(queue)
         .event(ruleTargetInput)
         .eventRole(role)
         .headerParameters(Map.of(
                 "headerParametersKey", "headerParameters"))
         .maxEventAge(Duration.minutes(30))
         .pathParameterValues(List.of("pathParameterValues"))
         .queryStringParameters(Map.of(
                 "queryStringParametersKey", "queryStringParameters"))
         .retryAttempts(123)
         .build();
 
  • Method Details

    • getEvent

      @Stability(Stable) @Nullable default RuleTargetInput getEvent()
      The event to send.

      Default: - the entire EventBridge event

    • getEventRole

      @Stability(Stable) @Nullable default IRole getEventRole()
      The role to assume before invoking the target.

      Default: - a new role will be created

    • getHeaderParameters

      @Stability(Stable) @Nullable default Map<String,String> getHeaderParameters()
      Additional headers sent to the API Destination.

      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

    • getPathParameterValues

      @Stability(Stable) @Nullable default List<String> getPathParameterValues()
      Path parameters to insert in place of path wildcards (*).

      If the API destination has a wilcard in the path, these path parts will be inserted in that place.

      Default: - none

    • getQueryStringParameters

      @Stability(Stable) @Nullable default Map<String,String> getQueryStringParameters()
      Additional query string parameters sent to the API Destination.

      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

    • builder

      @Stability(Stable) static ApiDestinationProps.Builder builder()
      Returns:
      a ApiDestinationProps.Builder of ApiDestinationProps