AwsApiProps

class aws_cdk.aws_events_targets.AwsApiProps(*, action, service, api_version=None, catch_error_pattern=None, parameters=None, policy_statement=None)

Bases: AwsApiInput

Properties for an AwsApi target.

Parameters:

action (str) – The service action to call.
service (str) – The service to call.
api_version (Optional[str]) – API version to use for the service. Default: - use latest available API version
catch_error_pattern (Optional[str]) – 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
parameters (Optional[Any]) – The parameters for the service action. Default: - no parameters
policy_statement (Optional[PolicyStatement]) – The IAM policy statement to allow the API call. Use only if resource restriction is needed. Default: - extract the permission from the API call

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events_targets as events_targets
import aws_cdk.aws_iam as iam

# parameters: Any
# policy_statement: iam.PolicyStatement

aws_api_props = events_targets.AwsApiProps(
    action="action",
    service="service",

    # the properties below are optional
    api_version="apiVersion",
    catch_error_pattern="catchErrorPattern",
    parameters=parameters,
    policy_statement=policy_statement
)

Attributes

action

The service action to call.

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

api_version

API version to use for the service.

Default:

use latest available API version

See:

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

catch_error_pattern

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

parameters

The parameters for the service action.

Default:

no parameters

See:

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

policy_statement

The IAM policy statement to allow the API call.

Use only if resource restriction is needed.

Default:

extract the permission from the API call

service

The service to call.

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