Package software.amazon.awscdk.services.scheduler.targets

Class UniversalTargetProps.Jsii$Proxy

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

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

  • Method Details

    • getAction

      public final String getAction()
      Description copied from interface: UniversalTargetProps
      The API action to call. Must be camelCase.

      You cannot use read-only API actions such as common GET operations.

      Specified by:
      getAction in interface UniversalTargetProps
      See Also:

    • getService

      public final String getService()
      Description copied from interface: UniversalTargetProps
      The AWS service to call.

      This must be in lowercase.

      Specified by:
      getService in interface UniversalTargetProps

    • getPolicyStatements

      public final List<PolicyStatement> getPolicyStatements()
      Description copied from interface: UniversalTargetProps
      The IAM policy statements needed to invoke the target. These statements are attached to the Scheduler's role.

      Note that the default may not be the correct actions as not all AWS services follows the same IAM action pattern, or there may be more actions needed to invoke the target.

      Default: - Policy with `service:action` action only.

      Specified by:
      getPolicyStatements in interface UniversalTargetProps

    • getDeadLetterQueue

      public final IQueue getDeadLetterQueue()
      Description copied from interface: ScheduleTargetBaseProps
      The SQS queue to be used as deadLetterQueue.

      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 ScheduleTargetBaseProps

    • getInput

      public final ScheduleTargetInput getInput()
      Description copied from interface: ScheduleTargetBaseProps
      Input passed to the target.

      Default: - no input.

      Specified by:
      getInput in interface ScheduleTargetBaseProps

    • getMaxEventAge

      public final Duration getMaxEventAge()
      Description copied from interface: ScheduleTargetBaseProps
      The maximum age of a request that Scheduler sends to a target for processing.

      Minimum value of 60. Maximum value of 86400.

      Default: Duration.hours(24)

      Specified by:
      getMaxEventAge in interface ScheduleTargetBaseProps

    • getRetryAttempts

      public final Number getRetryAttempts()
      Description copied from interface: ScheduleTargetBaseProps
      The maximum number of times to retry when the target returns an error.

      Minimum value of 0. Maximum value of 185.

      Default: 185

      Specified by:
      getRetryAttempts in interface ScheduleTargetBaseProps

    • getRole

      public final IRole getRole()
      Description copied from interface: ScheduleTargetBaseProps
      An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

      If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.

      Default: - created by target

      Specified by:
      getRole in interface ScheduleTargetBaseProps

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