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

Class AwsApi.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.AwsApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsApi>

Enclosing class:

AwsApi

@Stability(Stable)
public static final class AwsApi.Builder
extends Object
implements software.amazon.jsii.Builder<AwsApi>

A fluent builder for AwsApi.

Method Summary

Modifier and Type	Method	Description
AwsApi.Builder	action(String action)	The service action to call.
AwsApi.Builder	apiVersion(String apiVersion)	API version to use for the service.
AwsApi	build()
AwsApi.Builder	catchErrorPattern(String catchErrorPattern)	The regex pattern to use to catch API errors.
static AwsApi.Builder	create()
AwsApi.Builder	parameters(Object parameters)	The parameters for the service action.
AwsApi.Builder	policyStatement(PolicyStatement policyStatement)	The IAM policy statement to allow the API call.
AwsApi.Builder	service(String service)	The service to call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static AwsApi.Builder create()

Returns:

a new instance of AwsApi.Builder.

action

@Stability(Stable)
public AwsApi.Builder action(String action)

The service action to call.

Parameters:

action - The service action to call. This parameter is required.

Returns:

this

See Also:

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

service

@Stability(Stable)
public AwsApi.Builder service(String service)

The service to call.

Parameters:

service - The service to call. This parameter is required.

Returns:

this

See Also:

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

apiVersion

@Stability(Stable)
public AwsApi.Builder apiVersion(String apiVersion)

API version to use for the service.

Default: - use latest available API version

Parameters:

apiVersion - API version to use for the service. This parameter is required.

Returns:

this

See Also:

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

catchErrorPattern

@Stability(Stable)
public AwsApi.Builder catchErrorPattern(String catchErrorPattern)

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:

catchErrorPattern - The regex pattern to use to catch API errors. This parameter is required.

Returns:

this

parameters

@Stability(Stable)
public AwsApi.Builder parameters(Object parameters)

The parameters for the service action.

Default: - no parameters

Parameters:

parameters - The parameters for the service action. This parameter is required.

Returns:

this

See Also:

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

policyStatement

@Stability(Stable)
public AwsApi.Builder policyStatement(PolicyStatement 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

Parameters:

policyStatement - The IAM policy statement to allow the API call. This parameter is required.

Returns:

this

build

@Stability(Stable)
public AwsApi build()

Specified by:

build in interface software.amazon.jsii.Builder<AwsApi>

Returns:

a newly built instance of AwsApi.