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

Class AwsApiProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsApiProps>

Enclosing interface:

AwsApiProps

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

A builder for AwsApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AwsApiProps.Builder	action(String action)	Sets the value of AwsApiInput.getAction()
AwsApiProps.Builder	apiVersion(String apiVersion)	Sets the value of AwsApiInput.getApiVersion()
AwsApiProps	build()	Builds the configured instance.
AwsApiProps.Builder	catchErrorPattern(String catchErrorPattern)	Sets the value of AwsApiInput.getCatchErrorPattern()
AwsApiProps.Builder	parameters(Object parameters)	Sets the value of AwsApiInput.getParameters()
AwsApiProps.Builder	policyStatement(PolicyStatement policyStatement)	Sets the value of AwsApiProps.getPolicyStatement()
AwsApiProps.Builder	service(String service)	Sets the value of AwsApiInput.getService()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

policyStatement

@Stability(Stable)
public AwsApiProps.Builder policyStatement(PolicyStatement policyStatement)

Sets the value of AwsApiProps.getPolicyStatement()

Parameters:

policyStatement - The IAM policy statement to allow the API call. Use only if resource restriction is needed.

Returns:

this

action

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

Sets the value of AwsApiInput.getAction()

Parameters:

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

Returns:

this

service

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

Sets the value of AwsApiInput.getService()

Parameters:

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

Returns:

this

apiVersion

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

Sets the value of AwsApiInput.getApiVersion()

Parameters:

apiVersion - API version to use for the service.

Returns:

this

catchErrorPattern

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

Sets the value of AwsApiInput.getCatchErrorPattern()

Parameters:

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.

Returns:

this

parameters

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

Sets the value of AwsApiInput.getParameters()

Parameters:

parameters - The parameters for the service action.

Returns:

this

build

@Stability(Stable)
public AwsApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AwsApiProps

Throws:

NullPointerException - if any required attribute was not provided