Class AwsApiCallProps

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

Inheritance
object
AwsApiCallProps
Inherited Members
Namespace: Amazon.CDK.IntegTests.Alpha
Assembly: Amazon.CDK.IntegTests.Alpha.dll
Syntax (csharp)
public class AwsApiCallProps : IAwsApiCallProps, IAwsApiCallOptions, IProviderOptions
Syntax (vb)
Public Class AwsApiCallProps Implements IAwsApiCallProps, IAwsApiCallOptions, IProviderOptions
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Stack myAppStack;


             new AwsApiCall(myAppStack, "GetObject", new AwsApiCallProps {
                 Service = "S3",
                 Api = "getObject"
             });

Synopsis

Constructors

AwsApiCallProps()

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

Properties

Api

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

(experimental) Restrict the data returned by the API call to specific paths in the API response.
Parameters

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

(experimental) The log level of the provider lambda function.
Service

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

Constructors

AwsApiCallProps()

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

public AwsApiCallProps()
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Stack myAppStack;


             new AwsApiCall(myAppStack, "GetObject", new AwsApiCallProps {
                 Service = "S3",
                 Api = "getObject"
             });

Properties

Api

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

public string Api { get; set; }
Property Value

string

Remarks

Stability: Experimental

OutputPaths

(experimental) Restrict the data returned by the API call to specific paths in the API response.

public string[]? OutputPaths { get; set; }
Property Value

string[]

Remarks

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.

public object? Parameters { get; set; }
Property Value

object

Remarks

Default: - no parameters

Stability: Experimental

ProviderLogLevel

(experimental) The log level of the provider lambda function.

public ApplicationLogLevel? ProviderLogLevel { get; set; }
Property Value

ApplicationLogLevel?

Remarks

Default: ApplicationLogLevel.FATAL

Stability: Experimental

Service

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

public string Service { get; set; }
Property Value

string

Remarks

Stability: Experimental

Implements