You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatchEvents::Types::Target

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Note:

When making an API call, you may pass Target data as a hash:

{
  id: "TargetId", # required
  arn: "TargetArn", # required
  role_arn: "RoleArn",
  input: "TargetInput",
  input_path: "TargetInputPath",
  input_transformer: {
    input_paths_map: {
      "InputTransformerPathKey" => "TargetInputPath",
    },
    input_template: "TransformerInput", # required
  },
  kinesis_parameters: {
    partition_key_path: "TargetPartitionKeyPath", # required
  },
  run_command_parameters: {
    run_command_targets: [ # required
      {
        key: "RunCommandTargetKey", # required
        values: ["RunCommandTargetValue"], # required
      },
    ],
  },
  ecs_parameters: {
    task_definition_arn: "Arn", # required
    task_count: 1,
  },
}

Targets are the resources to be invoked when a rule is triggered. Target types include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, Run Command, and built-in targets.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String)


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#ecs_parametersTypes::EcsParameters

Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#idString

The ID of the target.

Returns:

  • (String)


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#inputString

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. You must use JSON dot notation, not bracket notation. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

Returns:

  • (String)


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#input_pathString

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

Returns:

  • (String)


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#input_transformerTypes::InputTransformer

Settings to enable you to 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.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#kinesis_parametersTypes::KinesisParameters

The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream. If you do not include this parameter, the default is to use the eventId as the partition key.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

Returns:

  • (String)


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end

#run_command_parametersTypes::RunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1016

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters)
  include Aws::Structure
end