Interface ApiDestinationProps

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:02.167Z") @Stability(Stable) public interface ApiDestinationProps extends software.amazon.jsii.JsiiSerializable
The event API Destination properties.

Example:

 Connection connection = Connection.Builder.create(this, "Connection")
         .authorization(Authorization.apiKey("x-api-key", SecretValue.secretsManager("ApiSecretName")))
         .description("Connection with API Key x-api-key")
         .build();
 ApiDestination destination = ApiDestination.Builder.create(this, "Destination")
         .connection(connection)
         .endpoint("https://example.com")
         .description("Calling example.com with API key x-api-key")
         .build();
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.minutes(1)))
         .targets(List.of(new ApiDestination(destination)))
         .build();
 
  • Method Details

    • getConnection

      @Stability(Stable) @NotNull IConnection getConnection()
      The ARN of the connection to use for the API destination.
    • getEndpoint

      @Stability(Stable) @NotNull String getEndpoint()
      The URL to the HTTP invocation endpoint for the API destination..
    • getApiDestinationName

      @Stability(Stable) @Nullable default String getApiDestinationName()
      The name for the API destination.

      Default: - A unique name will be generated

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description for the API destination.

      Default: - none

    • getHttpMethod

      @Stability(Stable) @Nullable default HttpMethod getHttpMethod()
      The method to use for the request to the HTTP invocation endpoint.

      Default: HttpMethod.POST

    • getRateLimitPerSecond

      @Stability(Stable) @Nullable default Number getRateLimitPerSecond()
      The maximum number of requests per second to send to the HTTP invocation endpoint.

      Default: - Not rate limited

    • builder

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