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

Class: Aws::EventBridge::Types::PutTargetsRequest

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 PutTargetsRequest data as a hash:

{
  rule: "RuleName", # required
  event_bus_name: "EventBusName",
  targets: [ # required
    {
      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",
      },
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#event_bus_name ⇒ String

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

  • (String) 


1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1899

class PutTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :targets)
  include Aws::Structure
end

#rule ⇒ String

The name of the rule.

Returns:

  • (String) 


1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1899

class PutTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :targets)
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

The targets to update or add to the rule.

Returns:



1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1899

class PutTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :targets)
  include Aws::Structure
end