Skip to content
v2.275.0

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AwsApiCallOptions Struct ​

Options to perform an AWS JavaScript V2 API call.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';
import { aws_lambda as lambda } from 'aws-cdk-lib';

declare const parameters: any;
const awsApiCallOptions: integ_tests_alpha.AwsApiCallOptions = {
  api: 'api',
  service: 'service',

  // the properties below are optional
  outputPaths: ['outputPaths'],
  parameters: parameters,
  providerLogLevel: lambda.ApplicationLogLevel.INFO,
};

Properties ​

apistringapistrapiStringApistringApi*stringrequired#
The api call to make, i.e. getBucketLifecycle.
outputPathsoptionalstring[]output_pathsoptionaltyping.List[str]outputPathsoptionalList<String>OutputPathsoptionalstring[]OutputPathsoptional*[]*string#
Restrict the data returned by the API call to specific paths in the API response.

Default: return all data

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.

parametersoptionalanyparametersoptionalAnyparametersoptionalObjectParametersoptionalobjectParametersoptionalinterface{}#
Any parameters to pass to the api call.

Default: no parameters

providerLogLeveloptionalApplicationLogLevelprovider_log_leveloptionalApplicationLogLevelproviderLogLeveloptionalApplicationLogLevelProviderLogLeveloptionalApplicationLogLevelProviderLogLeveloptionalApplicationLogLevel= ApplicationLogLevel.FATAL#
The log level of the provider lambda function.
servicestringservicestrserviceStringServicestringService*stringrequired#
The AWS service, i.e. S3.