Package software.amazon.awscdk.services.events

Class CfnRuleProps.Jsii$Proxy

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

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

    CfnRuleProps.Builder, CfnRuleProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnRuleProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnRuleProps.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
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getDescription()
    The description of the rule.
    final String
    getEventBusName()
    The name or ARN of the event bus associated with the rule.
    final Object
    getEventPattern()
    The event pattern of the rule.
    final String
    getName()
    The name of the rule.
    final String
    getRoleArn()
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    final String
    getScheduleExpression()
    The scheduling expression.
    final String
    getState()
    The state of the rule.
    final Object
    getTargets()
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
    final 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

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

  • Method Details

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnRuleProps
      The description of the rule.
      Specified by:
      getDescription in interface CfnRuleProps

    • getEventBusName

      public final String getEventBusName()
      Description copied from interface: CfnRuleProps
      The name or ARN of the event bus associated with the rule.

      If you omit this, the default event bus is used.

      Specified by:
      getEventBusName in interface CfnRuleProps

    • getEventPattern

      public final Object getEventPattern()
      Description copied from interface: CfnRuleProps
      The event pattern of the rule.

      For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

      Specified by:
      getEventPattern in interface CfnRuleProps

    • getName

      public final String getName()
      Description copied from interface: CfnRuleProps
      The name of the rule.
      Specified by:
      getName in interface CfnRuleProps

    • getRoleArn

      public final String getRoleArn()
      Description copied from interface: CfnRuleProps
      The Amazon Resource Name (ARN) of the role that is used for target invocation.

      If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

      Specified by:
      getRoleArn in interface CfnRuleProps

    • getScheduleExpression

      public final String getScheduleExpression()
      Description copied from interface: CfnRuleProps
      The scheduling expression.

      For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule .

      Specified by:
      getScheduleExpression in interface CfnRuleProps

    • getState

      public final String getState()
      Description copied from interface: CfnRuleProps
      The state of the rule.
      Specified by:
      getState in interface CfnRuleProps

    • getTargets

      public final Object getTargets()
      Description copied from interface: CfnRuleProps
      Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

      Targets are the resources that are invoked when a rule is triggered.

      The maximum number of entries per request is 10.

      Each rule can have up to five (5) targets associated with it at one time.

      For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide .

      Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:

      • Amazon EBS CreateSnapshot API call
      • Amazon EC2 RebootInstances API call
      • Amazon EC2 StopInstances API call
      • Amazon EC2 TerminateInstances API call

      For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

      To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

      • For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
      • For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets .

      For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .

      If another AWS account is in the same region and has granted you permission (using PutPermission ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing .

      Input , InputPath , and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

      If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide .

      If you have an IAM role on a cross-account event bus target, a PutTargets call without a role on the same target (same Id and Arn ) will not remove the role.

      For more information about enabling cross-account events, see PutPermission .

      Input , InputPath , and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

      • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
      • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
      • If InputPath is specified in the form of JSONPath (for example, $.detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
      • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

      When you specify InputPath or InputTransformer , you must use JSON dot notation, not bracket notation.

      When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

      This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

      Specified by:
      getTargets in interface CfnRuleProps

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