Class AwsApiCallProps

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

Inheritance
System.Object
AwsApiCallProps
Namespace: Amazon.CDK.IntegTests.Alpha
Assembly: Amazon.CDK.IntegTests.Alpha.dll
Syntax (csharp)
public class AwsApiCallProps : Object, IAwsApiCallProps, IAwsApiCallOptions
Syntax (vb)
Public Class AwsApiCallProps
    Inherits Object
    Implements IAwsApiCallProps, IAwsApiCallOptions
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Stack myAppStack;


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

Synopsis

Constructors

AwsApiCallProps()

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.
Service

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

Constructors

AwsApiCallProps()

public AwsApiCallProps()

Properties

Api

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

public string Api { get; set; }
Property Value

System.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

System.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

System.Object

Remarks

Default: - no parameters

Stability: Experimental

Service

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

public string Service { get; set; }
Property Value

System.String

Remarks

Stability: Experimental

Implements