Package software.amazon.awscdk.services.events.targets

Interface AwsApiProps

All Superinterfaces:

AwsApiInput, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:51:57.974Z")
@Stability(Stable)
public interface AwsApiProps
extends software.amazon.jsii.JsiiSerializable, AwsApiInput

Properties for an AwsApi target.

Example:

 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.hours(1)))
         .build();
 rule.addTarget(AwsApi.Builder.create()
         .service("ECS")
         .action("updateService")
         .parameters(Map.of(
                 "service", "my-service",
                 "forceNewDeployment", true))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AwsApiProps.Builder	A builder for AwsApiProps
static final class	AwsApiProps.Jsii$Proxy	An implementation for AwsApiProps

Method Summary

Modifier and Type	Method	Description
static AwsApiProps.Builder	builder()
default PolicyStatement	getPolicyStatement()	The IAM policy statement to allow the API call.

Methods inherited from interface software.amazon.awscdk.services.events.targets.AwsApiInput

getAction, getApiVersion, getCatchErrorPattern, getParameters, getService

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyStatement

@Stability(Stable)
@Nullable
default PolicyStatement getPolicyStatement()

The IAM policy statement to allow the API call.

Use only if resource restriction is needed.

Default: - extract the permission from the API call

builder

@Stability(Stable)
static AwsApiProps.Builder builder()

Returns:

a AwsApiProps.Builder of AwsApiProps