Class AwsApiCallOptions
(experimental) Options to perform an AWS JavaScript V2 API call.
Inheritance
Implements
Namespace: Amazon.CDK.IntegTests.Alpha
Assembly: Amazon.CDK.IntegTests.Alpha.dll
Syntax (csharp)
public class AwsApiCallOptions : Object, IAwsApiCallOptions
Syntax (vb)
Public Class AwsApiCallOptions
Inherits Object
Implements IAwsApiCallOptions
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.IntegTests.Alpha;
var parameters;
var awsApiCallOptions = new AwsApiCallOptions {
Api = "api",
Service = "service",
// the properties below are optional
OutputPaths = new [] { "outputPaths" },
Parameters = parameters
};
Synopsis
Constructors
AwsApiCallOptions() |
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
AwsApiCallOptions()
public AwsApiCallOptions()
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