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.
| Stability | Experimental |
|---|---|
| Source | lib/assertions/sdk.ts |
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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.integ_tests_alpha as integ_tests_alpha
from aws_cdk import aws_lambda as lambda_
# parameters: Any
aws_api_call_options = integ_tests_alpha.AwsApiCallOptions(
api="api",
service="service",
# the properties below are optional
output_paths=["outputPaths"],
parameters=parameters,
provider_log_level=lambda_.ApplicationLogLevel.INFO
)
java
// 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.*;
import software.amazon.awscdk.services.lambda.*;
Object parameters;
AwsApiCallOptions awsApiCallOptions = AwsApiCallOptions.builder()
.api("api")
.service("service")
// the properties below are optional
.outputPaths(List.of("outputPaths"))
.parameters(parameters)
.providerLogLevel(ApplicationLogLevel.INFO)
.build();
csharp
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.IntegTests.Alpha;
using Amazon.CDK.AWS.Lambda;
var parameters;
var awsApiCallOptions = new AwsApiCallOptions {
Api = "api",
Service = "service",
// the properties below are optional
OutputPaths = new [] { "outputPaths" },
Parameters = parameters,
ProviderLogLevel = ApplicationLogLevel.INFO
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import integ_tests_alpha "github.com/aws/aws-cdk-go/awscdkintegtestsalpha"
import "github.com/aws/aws-cdk-go/awscdk"
var parameters interface{}
awsApiCallOptions := &AwsApiCallOptions{
Api: jsii.String("api"),
Service: jsii.String("service"),
// the properties below are optional
OutputPaths: []*string{
jsii.String("outputPaths"),
},
Parameters: parameters,
ProviderLogLevel: awscdk.Aws_lambda.ApplicationLogLevel_INFO,
}
Properties
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.
The AWS service, i.e. S3.