aws-cdk-lib.aws_events_targets.AwsApiInput

interface AwsApiInput

LanguageType name
.NETAmazon.CDK.AWS.Events.Targets.AwsApiInput
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseventstargets#AwsApiInput
Javasoftware.amazon.awscdk.services.events.targets.AwsApiInput
Pythonaws_cdk.aws_events_targets.AwsApiInput
TypeScript (source)aws-cdk-lib » aws_events_targets » AwsApiInput

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 { aws_events_targets as events_targets } from 'aws-cdk-lib';

declare const parameters: any;
const awsApiInput: events_targets.AwsApiInput = {
  action: 'action',
  service: 'service',

  // the properties below are optional
  apiVersion: 'apiVersion',
  catchErrorPattern: 'catchErrorPattern',
  parameters: parameters,
};

Properties

NameTypeDescription
actionstringThe service action to call.
servicestringThe service to call.
apiVersion?stringAPI version to use for the service.
catchErrorPattern?stringThe regex pattern to use to catch API errors.
parameters?anyThe parameters for the service action.

action

Type: string

The service action to call.

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


service

Type: string

The service to call.

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


apiVersion?

Type: string (optional, default: use latest available API version)

API version to use for the service.

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


catchErrorPattern?

Type: string (optional, default: do not catch errors)

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.


parameters?

Type: any (optional, default: no parameters)

The parameters for the service action.

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