Package software.amazon.awscdk.integtests.alpha

Class AwsApiCallRequest.Builder

java.lang.Object
software.amazon.awscdk.integtests.alpha.AwsApiCallRequest.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AwsApiCallRequest>
Enclosing interface:
AwsApiCallRequest
@Stability(Experimental) public static final class AwsApiCallRequest.Builder extends Object implements software.amazon.jsii.Builder<AwsApiCallRequest>
A builder for AwsApiCallRequest

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • api

      @Stability(Experimental) public AwsApiCallRequest.Builder api(String api)
      Sets the value of AwsApiCallRequest.getApi()
      Parameters:
      api - The AWS api call to make i.e. getBucketLifecycle. This parameter is required.
      Returns:
      this

    • service

      @Stability(Experimental) public AwsApiCallRequest.Builder service(String service)
      Sets the value of AwsApiCallRequest.getService()
      Parameters:
      service - The AWS service i.e. S3. This parameter is required.
      Returns:
      this

    • flattenResponse

      @Stability(Experimental) public AwsApiCallRequest.Builder flattenResponse(String flattenResponse)
      Sets the value of AwsApiCallRequest.getFlattenResponse()
      Parameters:
      flattenResponse - 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.

      Returns:
      this

    • outputPaths

      @Stability(Experimental) public AwsApiCallRequest.Builder outputPaths(List<String> outputPaths)
      Sets the value of AwsApiCallRequest.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 AwsApiCallRequest.Builder parameters(Object parameters)
      Sets the value of AwsApiCallRequest.getParameters()
      Parameters:
      parameters - Any parameters to pass to the api call.
      Returns:
      this

    • build

      @Stability(Experimental) public AwsApiCallRequest build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<AwsApiCallRequest>
      Returns:
      a new instance of AwsApiCallRequest
      Throws:
      NullPointerException - if any required attribute was not provided