Package software.amazon.awscdk.integtests.alpha

Class AwsApiCallProps.Builder

java.lang.Object

software.amazon.awscdk.integtests.alpha.AwsApiCallProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsApiCallProps>

Enclosing interface:

AwsApiCallProps

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

A builder for AwsApiCallProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AwsApiCallProps.Builder	api(String api)	Sets the value of AwsApiCallOptions.getApi()
AwsApiCallProps	build()	Builds the configured instance.
AwsApiCallProps.Builder	outputPaths(List<String> outputPaths)	Sets the value of AwsApiCallOptions.getOutputPaths()
AwsApiCallProps.Builder	parameters(Object parameters)	Sets the value of AwsApiCallOptions.getParameters()
AwsApiCallProps.Builder	service(String service)	Sets the value of AwsApiCallOptions.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

api

@Stability(Experimental)
public AwsApiCallProps.Builder api(String api)

Sets the value of AwsApiCallOptions.getApi()

Parameters:

api - The api call to make, i.e. getBucketLifecycle. This parameter is required.

Returns:

this

service

@Stability(Experimental)
public AwsApiCallProps.Builder service(String service)

Sets the value of AwsApiCallOptions.getService()

Parameters:

service - The AWS service, i.e. S3. This parameter is required.

Returns:

this

outputPaths

@Stability(Experimental)
public AwsApiCallProps.Builder outputPaths(List<String> outputPaths)

Sets the value of AwsApiCallOptions.getOutputPaths()

Parameters:

outputPaths - Restrict the data returned by the API call to specific paths in the API response. Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes.

Returns:

this

parameters

@Stability(Experimental)
public AwsApiCallProps.Builder parameters(Object parameters)

Sets the value of AwsApiCallOptions.getParameters()

Parameters:

parameters - Any parameters to pass to the api call.

Returns:

this

build

@Stability(Experimental)
public AwsApiCallProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AwsApiCallProps

Throws:

NullPointerException - if any required attribute was not provided