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

Class: Aws::EventBridge::Types::Target

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/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,
    launch_type: "EC2", # accepts EC2, FARGATE
    network_configuration: {
      awsvpc_configuration: {
        subnets: ["String"], # required
        security_groups: ["String"],
        assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
      },
    },
    platform_version: "String",
    group: "String",
  },
  batch_parameters: {
    job_definition: "String", # required
    job_name: "String", # required
    array_properties: {
      size: 1,
    },
    retry_strategy: {
      attempts: 1,
    },
  },
  sqs_parameters: {
    message_group_id: "MessageGroupId",
  },
}

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you're 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, 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.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

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

#batch_parametersTypes::BatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_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.



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

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

#idString

A name for the target. Use a string that will help you identify the target. Each target associated with a rule must have an Id unique for that rule.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_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. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_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)


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_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.



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

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

#kinesis_parametersTypes::KinesisParameters

The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_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)


2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

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

#run_command_parametersTypes::RunCommandParameters

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



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

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

#sqs_parametersTypes::SqsParameters

Contains the message group ID to use when the target is a FIFO queue.

If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2412

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