Class AwsApiInput
Rule target input for an AwsApi target.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Events.Targets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AwsApiInput : Object, IAwsApiInput
Syntax (vb)
Public Class AwsApiInput
Inherits Object
Implements IAwsApiInput
Remarks
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.AWS.Events.Targets;
var parameters;
var awsApiInput = new AwsApiInput {
Action = "action",
Service = "service",
// the properties below are optional
ApiVersion = "apiVersion",
CatchErrorPattern = "catchErrorPattern",
Parameters = parameters
};
Synopsis
Constructors
AwsApiInput() |
Properties
Action | The service action to call. |
ApiVersion | (deprecated) API version to use for the service. |
CatchErrorPattern | The regex pattern to use to catch API errors. |
Parameters | The parameters for the service action. |
Service | The service to call. |
Constructors
AwsApiInput()
public AwsApiInput()
Properties
Action
The service action to call.
public string Action { get; set; }
Property Value
System.String
Remarks
ApiVersion
(deprecated) API version to use for the service.
public string ApiVersion { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
CatchErrorPattern
The regex pattern to use to catch API errors.
public string CatchErrorPattern { get; set; }
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
Parameters
The parameters for the service action.
public object Parameters { get; set; }
Property Value
System.Object
Remarks
Default: - no parameters
See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
Service
The service to call.
public string Service { get; set; }
Property Value
System.String