Package software.amazon.awscdk.integtests.alpha

Interface AwsApiCallRequest

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsApiCallRequest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:26.413Z")
@Stability(Experimental)
public interface AwsApiCallRequest
extends software.amazon.jsii.JsiiSerializable

(experimental) A AWS JavaScript SDK V2 request.

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.alpha.*;
 Object parameters;
 AwsApiCallRequest awsApiCallRequest = AwsApiCallRequest.builder()
         .api("api")
         .service("service")
         // the properties below are optional
         .flattenResponse("flattenResponse")
         .outputPaths(List.of("outputPaths"))
         .parameters(parameters)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AwsApiCallRequest.Builder	builder()
String	getApi()	(experimental) The AWS api call to make i.e.
default String	getFlattenResponse()	(experimental) Whether or not to flatten the response from the api call.
default List<String>	getOutputPaths()	(experimental) Restrict the data returned by the API call to specific paths in the API response.
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 Details

getApi

@Stability(Experimental)
@NotNull
String getApi()

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

getService

@Stability(Experimental)
@NotNull
String getService()

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

getFlattenResponse

@Stability(Experimental)
@Nullable
default String getFlattenResponse()

(experimental) Whether or not to flatten the response from the api call.

Valid values are 'true' or 'false' as strings

Typically when using an SdkRequest you will be passing it as the actual value to an assertion provider so this would be set to 'false' (you want the actual response).

If you are using the SdkRequest to perform more of a query to return a single value to use, then this should be set to 'true'. For example, you could make a StepFunctions.startExecution api call and retreive the executionArn from the response.

Default: 'false'

getOutputPaths

@Stability(Experimental)
@Nullable
default List<String> getOutputPaths()

(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

getParameters

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

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

Default: - no parameters

builder

@Stability(Experimental)
static AwsApiCallRequest.Builder builder()

Returns:

a AwsApiCallRequest.Builder of AwsApiCallRequest