software.amazon.awscdk.integtests

Interface AwsApiCallOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsApiCallProps

All Known Implementing Classes:

AwsApiCallOptions.Jsii$Proxy, AwsApiCallProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:15.989Z")
 @Stability(value=Experimental)
public interface AwsApiCallOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to perform an AWS JavaScript V2 API call.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.integtests.*;
 Object parameters;
 AwsApiCallOptions awsApiCallOptions = AwsApiCallOptions.builder()
         .api("api")
         .service("service")
         // the properties below are optional
         .parameters(parameters)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AwsApiCallOptions.Builder A builder for AwsApiCallOptions
static class	AwsApiCallOptions.Jsii$Proxy An implementation for AwsApiCallOptions

Method Summary

Modifier and Type	Method and Description
static AwsApiCallOptions.Builder	builder()
String	getApi() (experimental) The api call to make, i.e.
default Object	getParameters() (experimental) Any parameters to pass to the api call.
String	getService() (experimental) The AWS service, i.e.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApi

@Stability(value=Experimental)
 @NotNull
String getApi()

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

getService

@Stability(value=Experimental)
 @NotNull
String getService()

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

getParameters

@Stability(value=Experimental)
 @Nullable
default Object getParameters()

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

Default: - no parameters

builder

@Stability(value=Experimental)
static AwsApiCallOptions.Builder builder()

Returns:

a AwsApiCallOptions.Builder of AwsApiCallOptions