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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Target as input to an Aws::Client method, you can use a vanilla 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",
  },
  http_parameters: {
    path_parameter_values: ["PathParameter"],
    header_parameters: {
      "HeaderKey" => "HeaderValue",
    },
    query_string_parameters: {
      "QueryStringKey" => "QueryStringValue",
    },
  },
  redshift_data_parameters: {
    secret_manager_arn: "RedshiftSecretManagerArn",
    database: "Database", # required
    db_user: "DbUser",
    sql: "Sql", # required
    statement_name: "StatementName",
    with_event: false,
  },
  dead_letter_config: {
    arn: "ResourceArn",
  },
  retry_policy: {
    maximum_retry_attempts: 1,
    maximum_event_age_in_seconds: 1,
  },
}

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 AWS Accounts in the Amazon EventBridge User Guide.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the target.

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

Returns:

  • (Types::BatchParameters) —

    If the event target is an AWS 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.

Returns:

  • (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. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

Returns:

  • (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 REST endpoint.

If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.

Returns:

  • (Types::HttpParameters) —

    Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.

#id ⇒ String

The ID of the target.

Returns:

  • (String) —

    The ID of the target.

#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) —

    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. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

Returns:

  • (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. 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) —

    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. If you do not include this parameter, the default is to use the eventId as the partition key.

Returns:

  • (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 Redshift Data API parameters to use when the target is a Redshift cluster.

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

Returns:

#retry_policy ⇒ Types::RetryPolicy

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

Returns:

  • (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. If one rule triggers multiple targets, you can use a different IAM role for each target.

Returns:

  • (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.

Returns:

#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: