interface AwsApiCallProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.IntegTests.Alpha.AwsApiCallProps |
 Go | github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#AwsApiCallProps |
 Java | software.amazon.awscdk.integtests.alpha.AwsApiCallProps |
 Python | aws_cdk.integ_tests_alpha.AwsApiCallProps |
 TypeScript (source) | @aws-cdk/integ-tests-alpha » AwsApiCallProps |
Construct that creates a custom resource that will perform a query using the AWS SDK.
Example
declare const myAppStack: Stack;
new AwsApiCall(myAppStack, 'GetObject', {
service: 'S3',
api: 'getObject',
});
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The api call to make, i.e. getBucketLifecycle. |
| service | string | The AWS service, i.e. S3. |
| output | string[] | Restrict the data returned by the API call to specific paths in the API response. |
| parameters? | any | Any parameters to pass to the api call. |
api
Type:
string
The api call to make, i.e. getBucketLifecycle.
service
Type:
string
The AWS service, i.e. S3.
outputPaths?
Type:
string[]
(optional, default: return all data)
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.
parameters?
Type:
any
(optional, default: no parameters)
Any parameters to pass to the api call.