AwsApiCallProps

class aws_cdk.integ_tests_alpha.AwsApiCallProps(*, api, service, output_paths=None, parameters=None)

Bases: AwsApiCallOptions

(experimental) Construct that creates a custom resource that will perform a query using the AWS SDK.

Parameters:

  • api (str) – (experimental) The api call to make, i.e. getBucketLifecycle.

  • service (str) – (experimental) The AWS service, i.e. S3.

  • output_paths (Optional[Sequence[str]]) – (experimental) 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. Default: - return all data

  • parameters (Optional[Any]) – (experimental) Any parameters to pass to the api call. Default: - no parameters

Stability:

experimental

ExampleMetadata:

infused

Example:

# my_app_stack: Stack


AwsApiCall(my_app_stack, "GetObject",
    service="S3",
    api="getObject"
)

Attributes

api

(experimental) The api call to make, i.e. getBucketLifecycle.

Stability:

experimental

output_paths

(experimental) 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.

Default:

  • return all data

Stability:

experimental

parameters

(experimental) Any parameters to pass to the api call.

Default:

  • no parameters

Stability:

experimental

service

(experimental) The AWS service, i.e. S3.

Stability:

experimental