Packages

case class RuleTarget(Arn: Token[String], Id: String, EcsParameters: Option[RuleEcsParameters] = None, Input: Option[Token[String]] = None, InputPath: Option[Token[String]] = None, InputTransformer: Option[RuleInputTransformer] = None, KinesisParameters: Option[RuleKinesisParameters] = None, RoleArn: Option[Token[String]] = None, RunCommandParameters: Option[RuleRunCommandParameters] = None) extends Product with Serializable

The Target property type specifies a target, such as AWS Lambda (Lambda) functions or Kinesis streams, that CloudWatch Events invokes when a rule is triggered.

Arn

The Amazon Resource Name (ARN) of the target.

Id

A unique, user-defined identifier for the target. Acceptable values include alphanumeric characters, periods (.), hyphens (-), and underscores (_).

EcsParameters

The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.

Input

A JSON-formatted text string that is passed to the target. This value overrides the matched event.

InputPath

When you don't want to pass the entire matched event, the JSONPath that describes which part of the event to pass to the target.

InputTransformer

Settings that provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event, and then use that data to send customized input to the target.

KinesisParameters

Settings that control shard assignment, when the target is a Kinesis stream. If you don't include this parameter, eventId is used as the partition key.

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to use for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target. NOTE: CloudWatch Events needs appropriate permissions to make API calls against the resources you own. For Kinesis streams, CloudWatch Events relies on IAM roles. For Lambda, Amazon SNS, and Amazon SQS resources, CloudWatch Events relies on resource-based policies.

RunCommandParameters

Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RuleTarget
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RuleTarget(Arn: Token[String], Id: String, EcsParameters: Option[RuleEcsParameters] = None, Input: Option[Token[String]] = None, InputPath: Option[Token[String]] = None, InputTransformer: Option[RuleInputTransformer] = None, KinesisParameters: Option[RuleKinesisParameters] = None, RoleArn: Option[Token[String]] = None, RunCommandParameters: Option[RuleRunCommandParameters] = None)

    Arn

    The Amazon Resource Name (ARN) of the target.

    Id

    A unique, user-defined identifier for the target. Acceptable values include alphanumeric characters, periods (.), hyphens (-), and underscores (_).

    EcsParameters

    The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.

    Input

    A JSON-formatted text string that is passed to the target. This value overrides the matched event.

    InputPath

    When you don't want to pass the entire matched event, the JSONPath that describes which part of the event to pass to the target.

    InputTransformer

    Settings that provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event, and then use that data to send customized input to the target.

    KinesisParameters

    Settings that control shard assignment, when the target is a Kinesis stream. If you don't include this parameter, eventId is used as the partition key.

    RoleArn

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to use for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target. NOTE: CloudWatch Events needs appropriate permissions to make API calls against the resources you own. For Kinesis streams, CloudWatch Events relies on IAM roles. For Lambda, Amazon SNS, and Amazon SQS resources, CloudWatch Events relies on resource-based policies.

    RunCommandParameters

    Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Arn: Token[String]
  5. val EcsParameters: Option[RuleEcsParameters]
  6. val Id: String
  7. val Input: Option[Token[String]]
  8. val InputPath: Option[Token[String]]
  9. val InputTransformer: Option[RuleInputTransformer]
  10. val KinesisParameters: Option[RuleKinesisParameters]
  11. val RoleArn: Option[Token[String]]
  12. val RunCommandParameters: Option[RuleRunCommandParameters]
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped