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.98.0 (build 00b106d)", date="2024-05-30T02:11:15.721Z") @Stability(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.alpha.*;
 Object parameters;
 AwsApiCallOptions awsApiCallOptions = AwsApiCallOptions.builder()
         .api("api")
         .service("service")
         // the properties below are optional
         .outputPaths(List.of("outputPaths"))
         .parameters(parameters)
         .build();
 
  • Method Details

    • getApi

      @Stability(Experimental) @NotNull String getApi()
      (experimental) The api call to make, i.e. getBucketLifecycle.
    • getService

      @Stability(Experimental) @NotNull String getService()
      (experimental) The AWS service, i.e. S3.
    • 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 AwsApiCallOptions.Builder builder()
      Returns:
      a AwsApiCallOptions.Builder of AwsApiCallOptions