software.amazon.awscdk.services.events.targets

Class ApiDestinationProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.targets.ApiDestinationProps.Jsii$Proxy

All Implemented Interfaces:

ApiDestinationProps, TargetBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ApiDestinationProps

@Stability(value=Stable)
 @Internal
public static final class ApiDestinationProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ApiDestinationProps

An implementation for ApiDestinationProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.targets.ApiDestinationProps

ApiDestinationProps.Builder, ApiDestinationProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(ApiDestinationProps.Builder builder) Constructor that initializes the object based on literal property values passed by the ApiDestinationProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
IQueue	getDeadLetterQueue() The SQS queue to be used as deadLetterQueue.
RuleTargetInput	getEvent() The event to send.
IRole	getEventRole() The role to assume before invoking the target.
Map<String,String>	getHeaderParameters() Additional headers sent to the API Destination.
Duration	getMaxEventAge() The maximum age of a request that Lambda sends to a function for processing.
List<String>	getPathParameterValues() Path parameters to insert in place of path wildcards (`*`).
Map<String,String>	getQueryStringParameters() Additional query string parameters sent to the API Destination.
Number	getRetryAttempts() The maximum number of times to retry when the function returns an error.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.events.targets.ApiDestinationProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ApiDestinationProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the ApiDestinationProps.Builder.

Method Detail

getEvent

public final RuleTargetInput getEvent()

Description copied from interface: ApiDestinationProps

The event to send.

Default: - the entire EventBridge event

Specified by:

getEvent in interface ApiDestinationProps

getEventRole

public final IRole getEventRole()

Description copied from interface: ApiDestinationProps

The role to assume before invoking the target.

Default: - a new role will be created

Specified by:

getEventRole in interface ApiDestinationProps

getHeaderParameters

public final Map<String,String> getHeaderParameters()

Description copied from interface: ApiDestinationProps

Additional headers sent to the API Destination.

These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.

You can only specify secret values on the Connection.

Default: - none

Specified by:

getHeaderParameters in interface ApiDestinationProps

getPathParameterValues

public final List<String> getPathParameterValues()

Description copied from interface: ApiDestinationProps

Path parameters to insert in place of path wildcards (`*`).

If the API destination has a wilcard in the path, these path parts will be inserted in that place.

Default: - none

Specified by:

getPathParameterValues in interface ApiDestinationProps

getQueryStringParameters

public final Map<String,String> getQueryStringParameters()

Description copied from interface: ApiDestinationProps

Additional query string parameters sent to the API Destination.

These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.

You can only specify secret values on the Connection.

Default: - none

Specified by:

getQueryStringParameters in interface ApiDestinationProps

getDeadLetterQueue

public final IQueue getDeadLetterQueue()

Description copied from interface: TargetBaseProps

The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Specified by:

getDeadLetterQueue in interface TargetBaseProps

getMaxEventAge

public final Duration getMaxEventAge()

Description copied from interface: TargetBaseProps

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Specified by:

getMaxEventAge in interface TargetBaseProps

getRetryAttempts

public final Number getRetryAttempts()

Description copied from interface: TargetBaseProps

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Specified by:

getRetryAttempts in interface TargetBaseProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object