Package software.amazon.awssdk.services.eventbridge.model

Interface Target.Builder

    • Method Detail

      • id

        Target.Builder id​(String id)

        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.

        Parameters:
        id - 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:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        Target.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the target.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        Target.Builder roleArn​(String roleArn)

        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.

        Parameters:
        roleArn - 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:
        Returns a reference to this object so that method calls can be chained together.

      • inputPath

        Target.Builder inputPath​(String inputPath)

        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.

        Parameters:
        inputPath - 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:
        Returns a reference to this object so that method calls can be chained together.

      • inputTransformer

        Target.Builder inputTransformer​(InputTransformer 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • kinesisParameters

        Target.Builder kinesisParameters​(KinesisParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • runCommandParameters

        Target.Builder runCommandParameters​(RunCommandParameters runCommandParameters)

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

        Parameters:
        runCommandParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ecsParameters

        Target.Builder ecsParameters​(EcsParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • batchParameters

        Target.Builder batchParameters​(BatchParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sqsParameters

        Target.Builder sqsParameters​(SqsParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • httpParameters

        Target.Builder httpParameters​(HttpParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • httpParameters

        default Target.Builder httpParameters​(Consumer<HttpParameters.Builder> 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.

        This is a convenience method that creates an instance of the HttpParameters.Builder avoiding the need to create one manually via HttpParameters.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpParameters(HttpParameters).

        Parameters:
        httpParameters - a consumer that will call methods on HttpParameters.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        httpParameters(HttpParameters)

      • redshiftDataParameters

        Target.Builder redshiftDataParameters​(RedshiftDataParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sageMakerPipelineParameters

        Target.Builder sageMakerPipelineParameters​(SageMakerPipelineParameters 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • deadLetterConfig

        Target.Builder deadLetterConfig​(DeadLetterConfig deadLetterConfig)

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

        Parameters:
        deadLetterConfig - The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retryPolicy

        Target.Builder retryPolicy​(RetryPolicy retryPolicy)

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

        Parameters:
        retryPolicy - The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • appSyncParameters

        Target.Builder appSyncParameters​(AppSyncParameters appSyncParameters)

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

        Parameters:
        appSyncParameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.