Package software.amazon.awscdk.services.events

Class CfnRule.TargetProperty.Builder

java.lang.Object

software.amazon.awscdk.services.events.CfnRule.TargetProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRule.TargetProperty>

Enclosing interface:

CfnRule.TargetProperty

@Stability(Stable)
public static final class CfnRule.TargetProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRule.TargetProperty>

A builder for CfnRule.TargetProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRule.TargetProperty.Builder	appSyncParameters(IResolvable appSyncParameters)	Sets the value of CfnRule.TargetProperty.getAppSyncParameters()
CfnRule.TargetProperty.Builder	appSyncParameters(CfnRule.AppSyncParametersProperty appSyncParameters)	Sets the value of CfnRule.TargetProperty.getAppSyncParameters()
CfnRule.TargetProperty.Builder	arn(String arn)	Sets the value of CfnRule.TargetProperty.getArn()
CfnRule.TargetProperty.Builder	batchParameters(IResolvable batchParameters)	Sets the value of CfnRule.TargetProperty.getBatchParameters()
CfnRule.TargetProperty.Builder	batchParameters(CfnRule.BatchParametersProperty batchParameters)	Sets the value of CfnRule.TargetProperty.getBatchParameters()
CfnRule.TargetProperty	build()	Builds the configured instance.
CfnRule.TargetProperty.Builder	deadLetterConfig(IResolvable deadLetterConfig)	Sets the value of CfnRule.TargetProperty.getDeadLetterConfig()
CfnRule.TargetProperty.Builder	deadLetterConfig(CfnRule.DeadLetterConfigProperty deadLetterConfig)	Sets the value of CfnRule.TargetProperty.getDeadLetterConfig()
CfnRule.TargetProperty.Builder	ecsParameters(IResolvable ecsParameters)	Sets the value of CfnRule.TargetProperty.getEcsParameters()
CfnRule.TargetProperty.Builder	ecsParameters(CfnRule.EcsParametersProperty ecsParameters)	Sets the value of CfnRule.TargetProperty.getEcsParameters()
CfnRule.TargetProperty.Builder	httpParameters(IResolvable httpParameters)	Sets the value of CfnRule.TargetProperty.getHttpParameters()
CfnRule.TargetProperty.Builder	httpParameters(CfnRule.HttpParametersProperty httpParameters)	Sets the value of CfnRule.TargetProperty.getHttpParameters()
CfnRule.TargetProperty.Builder	id(String id)	Sets the value of CfnRule.TargetProperty.getId()
CfnRule.TargetProperty.Builder	input(String input)	Sets the value of CfnRule.TargetProperty.getInput()
CfnRule.TargetProperty.Builder	inputPath(String inputPath)	Sets the value of CfnRule.TargetProperty.getInputPath()
CfnRule.TargetProperty.Builder	inputTransformer(IResolvable inputTransformer)	Sets the value of CfnRule.TargetProperty.getInputTransformer()
CfnRule.TargetProperty.Builder	inputTransformer(CfnRule.InputTransformerProperty inputTransformer)	Sets the value of CfnRule.TargetProperty.getInputTransformer()
CfnRule.TargetProperty.Builder	kinesisParameters(IResolvable kinesisParameters)	Sets the value of CfnRule.TargetProperty.getKinesisParameters()
CfnRule.TargetProperty.Builder	kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters)	Sets the value of CfnRule.TargetProperty.getKinesisParameters()
CfnRule.TargetProperty.Builder	redshiftDataParameters(IResolvable redshiftDataParameters)	Sets the value of CfnRule.TargetProperty.getRedshiftDataParameters()
CfnRule.TargetProperty.Builder	redshiftDataParameters(CfnRule.RedshiftDataParametersProperty redshiftDataParameters)	Sets the value of CfnRule.TargetProperty.getRedshiftDataParameters()
CfnRule.TargetProperty.Builder	retryPolicy(IResolvable retryPolicy)	Sets the value of CfnRule.TargetProperty.getRetryPolicy()
CfnRule.TargetProperty.Builder	retryPolicy(CfnRule.RetryPolicyProperty retryPolicy)	Sets the value of CfnRule.TargetProperty.getRetryPolicy()
CfnRule.TargetProperty.Builder	roleArn(String roleArn)	Sets the value of CfnRule.TargetProperty.getRoleArn()
CfnRule.TargetProperty.Builder	runCommandParameters(IResolvable runCommandParameters)	Sets the value of CfnRule.TargetProperty.getRunCommandParameters()
CfnRule.TargetProperty.Builder	runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters)	Sets the value of CfnRule.TargetProperty.getRunCommandParameters()
CfnRule.TargetProperty.Builder	sageMakerPipelineParameters(IResolvable sageMakerPipelineParameters)	Sets the value of CfnRule.TargetProperty.getSageMakerPipelineParameters()
CfnRule.TargetProperty.Builder	sageMakerPipelineParameters(CfnRule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)	Sets the value of CfnRule.TargetProperty.getSageMakerPipelineParameters()
CfnRule.TargetProperty.Builder	sqsParameters(IResolvable sqsParameters)	Sets the value of CfnRule.TargetProperty.getSqsParameters()
CfnRule.TargetProperty.Builder	sqsParameters(CfnRule.SqsParametersProperty sqsParameters)	Sets the value of CfnRule.TargetProperty.getSqsParameters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

arn

@Stability(Stable)
public CfnRule.TargetProperty.Builder arn(String arn)

Sets the value of CfnRule.TargetProperty.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target. This parameter is required.

Returns:

this

id

@Stability(Stable)
public CfnRule.TargetProperty.Builder id(String id)

Sets the value of CfnRule.TargetProperty.getId()

Parameters:

id - The ID of the target within the specified rule. This parameter is required. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.

Returns:

this

appSyncParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder appSyncParameters(IResolvable appSyncParameters)

Sets the value of CfnRule.TargetProperty.getAppSyncParameters()

Parameters:

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

Returns:

this

appSyncParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder appSyncParameters(CfnRule.AppSyncParametersProperty appSyncParameters)

Sets the value of CfnRule.TargetProperty.getAppSyncParameters()

Parameters:

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

Returns:

this

batchParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder batchParameters(IResolvable batchParameters)

Sets the value of CfnRule.TargetProperty.getBatchParameters()

Parameters:

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:

this

batchParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder batchParameters(CfnRule.BatchParametersProperty batchParameters)

Sets the value of CfnRule.TargetProperty.getBatchParameters()

Parameters:

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:

this

deadLetterConfig

@Stability(Stable)
public CfnRule.TargetProperty.Builder deadLetterConfig(IResolvable deadLetterConfig)

Sets the value of CfnRule.TargetProperty.getDeadLetterConfig()

Parameters:

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

Returns:

this

deadLetterConfig

@Stability(Stable)
public CfnRule.TargetProperty.Builder deadLetterConfig(CfnRule.DeadLetterConfigProperty deadLetterConfig)

Sets the value of CfnRule.TargetProperty.getDeadLetterConfig()

Parameters:

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

Returns:

this

ecsParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder ecsParameters(IResolvable ecsParameters)

Sets the value of CfnRule.TargetProperty.getEcsParameters()

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:

this

ecsParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder ecsParameters(CfnRule.EcsParametersProperty ecsParameters)

Sets the value of CfnRule.TargetProperty.getEcsParameters()

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:

this

httpParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder httpParameters(IResolvable httpParameters)

Sets the value of CfnRule.TargetProperty.getHttpParameters()

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:

this

httpParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder httpParameters(CfnRule.HttpParametersProperty httpParameters)

Sets the value of CfnRule.TargetProperty.getHttpParameters()

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:

this

input

@Stability(Stable)
public CfnRule.TargetProperty.Builder input(String input)

Sets the value of CfnRule.TargetProperty.getInput()

Parameters:

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

this

inputPath

@Stability(Stable)
public CfnRule.TargetProperty.Builder inputPath(String inputPath)

Sets the value of CfnRule.TargetProperty.getInputPath()

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:

this

inputTransformer

@Stability(Stable)
public CfnRule.TargetProperty.Builder inputTransformer(IResolvable inputTransformer)

Sets the value of CfnRule.TargetProperty.getInputTransformer()

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:

this

inputTransformer

@Stability(Stable)
public CfnRule.TargetProperty.Builder inputTransformer(CfnRule.InputTransformerProperty inputTransformer)

Sets the value of CfnRule.TargetProperty.getInputTransformer()

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:

this

kinesisParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder kinesisParameters(IResolvable kinesisParameters)

Sets the value of CfnRule.TargetProperty.getKinesisParameters()

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:

this

kinesisParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters)

Sets the value of CfnRule.TargetProperty.getKinesisParameters()

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:

this

redshiftDataParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder redshiftDataParameters(IResolvable redshiftDataParameters)

Sets the value of CfnRule.TargetProperty.getRedshiftDataParameters()

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:

this

redshiftDataParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder redshiftDataParameters(CfnRule.RedshiftDataParametersProperty redshiftDataParameters)

Sets the value of CfnRule.TargetProperty.getRedshiftDataParameters()

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:

this

retryPolicy

@Stability(Stable)
public CfnRule.TargetProperty.Builder retryPolicy(IResolvable retryPolicy)

Sets the value of CfnRule.TargetProperty.getRetryPolicy()

Parameters:

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

Returns:

this

retryPolicy

@Stability(Stable)
public CfnRule.TargetProperty.Builder retryPolicy(CfnRule.RetryPolicyProperty retryPolicy)

Sets the value of CfnRule.TargetProperty.getRetryPolicy()

Parameters:

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

Returns:

this

roleArn

@Stability(Stable)
public CfnRule.TargetProperty.Builder roleArn(String roleArn)

Sets the value of CfnRule.TargetProperty.getRoleArn()

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:

this

runCommandParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder runCommandParameters(IResolvable runCommandParameters)

Sets the value of CfnRule.TargetProperty.getRunCommandParameters()

Parameters:

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

Returns:

this

runCommandParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters)

Sets the value of CfnRule.TargetProperty.getRunCommandParameters()

Parameters:

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

Returns:

this

sageMakerPipelineParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder sageMakerPipelineParameters(IResolvable sageMakerPipelineParameters)

Sets the value of CfnRule.TargetProperty.getSageMakerPipelineParameters()

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:

this

sageMakerPipelineParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder sageMakerPipelineParameters(CfnRule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)

Sets the value of CfnRule.TargetProperty.getSageMakerPipelineParameters()

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:

this

sqsParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder sqsParameters(IResolvable sqsParameters)

Sets the value of CfnRule.TargetProperty.getSqsParameters()

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:

this

sqsParameters

@Stability(Stable)
public CfnRule.TargetProperty.Builder sqsParameters(CfnRule.SqsParametersProperty sqsParameters)

Sets the value of CfnRule.TargetProperty.getSqsParameters()

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:

this

build

@Stability(Stable)
public CfnRule.TargetProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRule.TargetProperty>

Returns:

a new instance of CfnRule.TargetProperty

Throws:

NullPointerException - if any required attribute was not provided