Interface AwsApiProps
- All Superinterfaces:
AwsApiInput
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AwsApiProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-17T21:37:31.507Z")
@Stability(Stable)
public interface AwsApiProps
extends software.amazon.jsii.JsiiSerializable, AwsApiInput
Properties for an AwsApi 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.services.events.targets.*; import software.amazon.awscdk.services.iam.*; Object parameters; PolicyStatement policyStatement; AwsApiProps awsApiProps = AwsApiProps.builder() .action("action") .service("service") // the properties below are optional .apiVersion("apiVersion") .catchErrorPattern("catchErrorPattern") .parameters(parameters) .policyStatement(policyStatement) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forAwsApiProps
static final class
An implementation forAwsApiProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic AwsApiProps.Builder
builder()
default PolicyStatement
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
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
- Returns:
- a
AwsApiProps.Builder
ofAwsApiProps
-