aws-cdk-lib.aws_events_targets.AwsApiInput

AwsApiInput Struct

Rule target input for an AwsApi target.

Source

aws-events-targets/lib/aws-api.ts

Type last changed

v2.95.0 · 7 Sep 2023

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

actionstringactionstractionStringActionstringAction*stringrequired#

The service action to call.

apiVersion?optionalstringapi_version?optionalstrapiVersion?optionalStringApiVersion?optionalstringApiVersion?optional*stringdeprecated#

the handler code was migrated to AWS SDK for JavaScript v3, which does not support this feature anymore

catchErrorPattern?optionalstringcatch_error_pattern?optionalstrcatchErrorPattern?optionalStringCatchErrorPattern?optionalstringCatchErrorPattern?optional*string#

The regex pattern to use to catch API errors.

Default: do not catch 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?optionalanyparameters?optionalAnyparameters?optionalObjectParameters?optionalobjectParameters?optionalinterface{}#

The parameters for the service action.

Default: no parameters

servicestringservicestrserviceStringServicestringService*stringrequired#

The service to call.