Experimental
@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AwsApiCallProps Struct
Construct that creates a custom resource that will perform a query using the AWS SDK.
| Stability | Experimental |
|---|---|
| Source | lib/assertions/sdk.ts |
Example
ts
declare const myAppStack: Stack;
new AwsApiCall(myAppStack, 'GetObject', {
service: 'S3',
api: 'getObject',
});
python
# my_app_stack: Stack
AwsApiCall(my_app_stack, "GetObject",
service="S3",
api="getObject"
)
java
Stack myAppStack;
AwsApiCall.Builder.create(myAppStack, "GetObject")
.service("S3")
.api("getObject")
.build();
csharp
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
Stack myAppStack;
new AwsApiCall(myAppStack, "GetObject", new AwsApiCallProps {
Service = "S3",
Api = "getObject"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
var myAppStack Stack
awscdkintegtestsalpha.NewAwsApiCall(myAppStack, jsii.String("GetObject"), &AwsApiCallProps{
Service: jsii.String("S3"),
Api: jsii.String("getObject"),
})
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.