@aws-cdk_integ-tests-alpha.AwsApiCallProps

interface AwsApiCallProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.IntegTests.Alpha.AwsApiCallProps
Gogithub.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#AwsApiCallProps
Javasoftware.amazon.awscdk.integtests.alpha.AwsApiCallProps
Pythonaws_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

NameTypeDescription
api๐Ÿ”นstringThe api call to make, i.e. getBucketLifecycle.
service๐Ÿ”นstringThe AWS service, i.e. S3.
outputPaths?๐Ÿ”นstring[]Restrict the data returned by the API call to specific paths in the API response.
parameters?๐Ÿ”นanyAny 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.