Interface IAwsSdkCall

An AWS SDK call.

Namespace: Amazon.CDK.CustomResources

Assembly: Amazon.CDK.AWS.CustomResources.dll

Syntax (csharp)

public interface IAwsSdkCall

Syntax (vb)

Public Interface IAwsSdkCall

Synopsis

Properties

Action	The service action to call.
ApiVersion	API version to use for the service.
IgnoreErrorCodesMatching	The regex pattern to use to catch API errors.
OutputPath	Restrict the data returned by the custom resource to a specific path in the API response.
Parameters	The parameters for the service action.
PhysicalResourceId	The physical resource id of the custom resource for this call.
Region	The region to send service requests to.
Service	The service to call.

Properties

Action

The service action to call.

string Action { get; }

Property Value

System.String

Remarks

See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

ApiVersion

API version to use for the service.

virtual string ApiVersion { get; }

Property Value

System.String

Remarks

Default: - use latest available API version

See: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/locking-api-versions.html

IgnoreErrorCodesMatching

The regex pattern to use to catch API errors.

virtual string IgnoreErrorCodesMatching { get; }

Property Value

System.String

Remarks

The code property of the Error object will be tested against this pattern. If there is a match an error will not be thrown.

Default: - do not catch errors

OutputPath

Restrict the data returned by the custom resource to a specific path in the API response.

virtual string OutputPath { get; }

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.

Example for ECS / updateService: 'service.deploymentConfiguration.maximumPercent'

Default: - return all data

Parameters

The parameters for the service action.

virtual object Parameters { get; }

Property Value

System.Object

Remarks

Default: - no parameters

See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

PhysicalResourceId

The physical resource id of the custom resource for this call.

virtual PhysicalResourceId PhysicalResourceId { get; }

Property Value

PhysicalResourceId

Remarks

Mandatory for onCreate or onUpdate calls.

Default: - no physical resource id

Region

The region to send service requests to.

virtual string Region { get; }

Property Value

System.String

Remarks

Note: Cross-region operations are generally considered an anti-pattern. Consider first deploying a stack in that region.

Default: - the region where this custom resource is deployed

Service

The service to call.

string Service { get; }

Property Value

System.String

Remarks

See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html