Package software.amazon.awscdk.services.events.targets

Class ApiGatewayProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.events.targets.ApiGatewayProps.Jsii$Proxy
All Implemented Interfaces:
ApiGatewayProps, TargetBaseProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
ApiGatewayProps
@Stability(Stable) @Internal public static final class ApiGatewayProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ApiGatewayProps
An implementation for ApiGatewayProps

  • Constructor Details

    • 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(ApiGatewayProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the ApiGatewayProps.Builder.

  • Method Details

    • getEventRole

      public final IRole getEventRole()
      Description copied from interface: ApiGatewayProps
      The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.

      Default: - a new role will be created

      Specified by:
      getEventRole in interface ApiGatewayProps

    • getHeaderParameters

      public final Map<String,String> getHeaderParameters()
      Description copied from interface: ApiGatewayProps
      The headers to be set when requesting API.

      Default: no header parameters

      Specified by:
      getHeaderParameters in interface ApiGatewayProps

    • getMethod

      public final String getMethod()
      Description copied from interface: ApiGatewayProps
      The method for api resource invoked by the rule.

      Default: '*' that treated as ANY

      Specified by:
      getMethod in interface ApiGatewayProps

    • getPath

      public final String getPath()
      Description copied from interface: ApiGatewayProps
      The api resource invoked by the rule.

      We can use wildcards('*') to specify the path. In that case, an equal number of real values must be specified for pathParameterValues.

      Default: '/'

      Specified by:
      getPath in interface ApiGatewayProps

    • getPathParameterValues

      public final List<String> getPathParameterValues()
      Description copied from interface: ApiGatewayProps
      The path parameter values to be used to populate to wildcards("*") of requesting api path.

      Default: no path parameters

      Specified by:
      getPathParameterValues in interface ApiGatewayProps

    • getPostBody

      public final RuleTargetInput getPostBody()
      Description copied from interface: ApiGatewayProps
      This will be the post request body send to the API.

      Default: the entire EventBridge event

      Specified by:
      getPostBody in interface ApiGatewayProps

    • getQueryStringParameters

      public final Map<String,String> getQueryStringParameters()
      Description copied from interface: ApiGatewayProps
      The query parameters to be set when requesting API.

      Default: no querystring parameters

      Specified by:
      getQueryStringParameters in interface ApiGatewayProps

    • getStage

      public final String getStage()
      Description copied from interface: ApiGatewayProps
      The deploy stage of api gateway invoked by the rule.

      Default: the value of deploymentStage.stageName of target api gateway.

      Specified by:
      getStage in interface ApiGatewayProps

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

      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