Package software.amazon.awscdk.integtests.alpha

Class AwsApiCall.Builder

java.lang.Object

software.amazon.awscdk.integtests.alpha.AwsApiCall.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsApiCall>

Enclosing class:

AwsApiCall

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

(experimental) A fluent builder for AwsApiCall.

Method Summary

Modifier and Type	Method	Description
AwsApiCall.Builder	api(String api)	(experimental) The api call to make, i.e.
AwsApiCall	build()
static AwsApiCall.Builder	create(software.constructs.Construct scope, String id)
AwsApiCall.Builder	outputPaths(List<String> outputPaths)	(experimental) Restrict the data returned by the API call to specific paths in the API response.
AwsApiCall.Builder	parameters(Object parameters)	(experimental) Any parameters to pass to the api call.
AwsApiCall.Builder	service(String service)	(experimental) The AWS service, i.e.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static AwsApiCall.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AwsApiCall.Builder.

api

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

(experimental) The api call to make, i.e. getBucketLifecycle.

Parameters:

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

Returns:

this

service

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

(experimental) The AWS service, i.e. S3.

Parameters:

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

Returns:

this

outputPaths

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

(experimental) 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.

Default: - return all data

Parameters:

outputPaths - Restrict the data returned by the API call to specific paths in the API response. This parameter is required.

Returns:

this

parameters

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

(experimental) Any parameters to pass to the api call.

Default: - no parameters

Parameters:

parameters - Any parameters to pass to the api call. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public AwsApiCall build()

Specified by:

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

Returns:

a newly built instance of AwsApiCall.