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

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::Target

Defined in:

gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

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 are 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, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_sync_parameters ⇒ Types::AppSyncParameters

  Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the target.

• #batch_parameters ⇒ Types::BatchParameters

  If the event target is an Batch job, this contains the job definition, job name, and other parameters.

• #dead_letter_config ⇒ Types::DeadLetterConfig

  The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

• #ecs_parameters ⇒ Types::EcsParameters

  Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.

• #http_parameters ⇒ Types::HttpParameters

  Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

• #id ⇒ String

  The ID of the target within the specified rule.

• #input ⇒ String

  Valid JSON text passed to the target.

• #input_path ⇒ String

  The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.

• #input_transformer ⇒ Types::InputTransformer

  Settings to enable you to provide custom input to a target based on certain event data.

• #kinesis_parameters ⇒ Types::KinesisParameters

  The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.

• #redshift_data_parameters ⇒ Types::RedshiftDataParameters

  Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

• #retry_policy ⇒ Types::RetryPolicy

  The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.

• #run_command_parameters ⇒ Types::RunCommandParameters

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

• #sage_maker_pipeline_parameters ⇒ Types::SageMakerPipelineParameters

  Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

• #sqs_parameters ⇒ Types::SqsParameters

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

Instance Attribute Details

#app_sync_parameters ⇒ Types::AppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

Returns:

• (Types::AppSyncParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the target.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#batch_parameters ⇒ Types::BatchParameters

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

Returns:

• (Types::BatchParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#dead_letter_config ⇒ Types::DeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

Returns:

• (Types::DeadLetterConfig)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#ecs_parameters ⇒ Types::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.

Returns:

• (Types::EcsParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#http_parameters ⇒ Types::HttpParameters

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

Returns:

• (Types::HttpParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#input ⇒ String

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)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#input_path ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#input_transformer ⇒ Types::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.

Returns:

• (Types::InputTransformer)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_parameters ⇒ Types::KinesisParameters

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

Returns:

• (Types::KinesisParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_data_parameters ⇒ Types::RedshiftDataParameters

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Returns:

• (Types::RedshiftDataParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#retry_policy ⇒ Types::RetryPolicy

The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

Returns:

• (Types::RetryPolicy)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#run_command_parameters ⇒ Types::RunCommandParameters

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

Returns:

• (Types::RunCommandParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#sage_maker_pipeline_parameters ⇒ Types::SageMakerPipelineParameters

Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

Returns:

• (Types::SageMakerPipelineParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#sqs_parameters ⇒ Types::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.

Returns:

• (Types::SqsParameters)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4594

class Target < Struct.new(
  :id,
  :arn,
  :role_arn,
  :input,
  :input_path,
  :input_transformer,
  :kinesis_parameters,
  :run_command_parameters,
  :ecs_parameters,
  :batch_parameters,
  :sqs_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :dead_letter_config,
  :retry_policy,
  :app_sync_parameters)
  SENSITIVE = []
  include Aws::Structure
end