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.
- Alphabetic
- By Inheritance
- RuleTarget
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val Arn: Token[String]
- val EcsParameters: Option[RuleEcsParameters]
- val Id: String
- val Input: Option[Token[String]]
- val InputPath: Option[Token[String]]
- val InputTransformer: Option[RuleInputTransformer]
- val KinesisParameters: Option[RuleKinesisParameters]
- val RoleArn: Option[Token[String]]
- val RunCommandParameters: Option[RuleRunCommandParameters]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )