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

Interface AwsApiInput

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsApiProps

All Known Implementing Classes:

AwsApiInput.Jsii$Proxy, AwsApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.708Z")
@Stability(Stable)
public interface AwsApiInput
extends software.amazon.jsii.JsiiSerializable

Rule target input 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.*;
 Object parameters;
 AwsApiInput awsApiInput = AwsApiInput.builder()
         .action("action")
         .service("service")
         // the properties below are optional
         .apiVersion("apiVersion")
         .catchErrorPattern("catchErrorPattern")
         .parameters(parameters)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AwsApiInput.Builder	builder()
String	getAction()	The service action to call.
default String	getApiVersion()	API version to use for the service.
default String	getCatchErrorPattern()	The regex pattern to use to catch API errors.
default Object	getParameters()	The parameters for the service action.
String	getService()	The service to call.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

The service action to call.

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

getService

@Stability(Stable)
@NotNull
String getService()

The service to call.

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

getApiVersion

@Stability(Stable)
@Nullable
default String getApiVersion()

API version to use for the service.

Default: - use latest available API version

See Also:

• https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/locking-api-versions.html

getCatchErrorPattern

@Stability(Stable)
@Nullable
default String getCatchErrorPattern()

The regex pattern to use to catch API errors.

The code property of the Error object will be tested against this pattern. If there is a match an error will not be thrown.

Default: - do not catch errors

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

The parameters for the service action.

Default: - no parameters

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

builder

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

Returns:

a AwsApiInput.Builder of AwsApiInput