@Stability(value=Stable) public static final class CfnRule.TargetProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnRule.TargetProperty>
CfnRule.TargetProperty| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnRule.TargetProperty.Builder arn(String arn)
CfnRule.TargetProperty.getArn()arn - The Amazon Resource Name (ARN) of the target. This parameter is required.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder id(String id)
CfnRule.TargetProperty.getId()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder batchParameters(CfnRule.BatchParametersProperty batchParameters)
CfnRule.TargetProperty.getBatchParameters()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 .this@Stability(value=Stable) public CfnRule.TargetProperty.Builder batchParameters(IResolvable batchParameters)
CfnRule.TargetProperty.getBatchParameters()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 .this@Stability(value=Stable) public CfnRule.TargetProperty.Builder deadLetterConfig(CfnRule.DeadLetterConfigProperty deadLetterConfig)
CfnRule.TargetProperty.getDeadLetterConfig()deadLetterConfig - The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder deadLetterConfig(IResolvable deadLetterConfig)
CfnRule.TargetProperty.getDeadLetterConfig()deadLetterConfig - The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder ecsParameters(CfnRule.EcsParametersProperty ecsParameters)
CfnRule.TargetProperty.getEcsParameters()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 .this@Stability(value=Stable) public CfnRule.TargetProperty.Builder ecsParameters(IResolvable ecsParameters)
CfnRule.TargetProperty.getEcsParameters()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 .this@Stability(value=Stable) public CfnRule.TargetProperty.Builder httpParameters(CfnRule.HttpParametersProperty httpParameters)
CfnRule.TargetProperty.getHttpParameters()httpParameters - Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST 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@Stability(value=Stable) public CfnRule.TargetProperty.Builder httpParameters(IResolvable httpParameters)
CfnRule.TargetProperty.getHttpParameters()httpParameters - Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST 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@Stability(value=Stable) public CfnRule.TargetProperty.Builder input(String input)
CfnRule.TargetProperty.getInput()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 .this@Stability(value=Stable) public CfnRule.TargetProperty.Builder inputPath(String inputPath)
CfnRule.TargetProperty.getInputPath()inputPath - 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 .this@Stability(value=Stable) public CfnRule.TargetProperty.Builder inputTransformer(CfnRule.InputTransformerProperty inputTransformer)
CfnRule.TargetProperty.getInputTransformer()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder inputTransformer(IResolvable inputTransformer)
CfnRule.TargetProperty.getInputTransformer()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters)
CfnRule.TargetProperty.getKinesisParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder kinesisParameters(IResolvable kinesisParameters)
CfnRule.TargetProperty.getKinesisParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder redshiftDataParameters(CfnRule.RedshiftDataParametersProperty redshiftDataParameters)
CfnRule.TargetProperty.getRedshiftDataParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder redshiftDataParameters(IResolvable redshiftDataParameters)
CfnRule.TargetProperty.getRedshiftDataParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder retryPolicy(CfnRule.RetryPolicyProperty retryPolicy)
CfnRule.TargetProperty.getRetryPolicy()retryPolicy - The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder retryPolicy(IResolvable retryPolicy)
CfnRule.TargetProperty.getRetryPolicy()retryPolicy - The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder roleArn(String roleArn)
CfnRule.TargetProperty.getRoleArn()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters)
CfnRule.TargetProperty.getRunCommandParameters()runCommandParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder runCommandParameters(IResolvable runCommandParameters)
CfnRule.TargetProperty.getRunCommandParameters()runCommandParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder sageMakerPipelineParameters(CfnRule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)
CfnRule.TargetProperty.getSageMakerPipelineParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder sageMakerPipelineParameters(IResolvable sageMakerPipelineParameters)
CfnRule.TargetProperty.getSageMakerPipelineParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder sqsParameters(CfnRule.SqsParametersProperty sqsParameters)
CfnRule.TargetProperty.getSqsParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty.Builder sqsParameters(IResolvable sqsParameters)
CfnRule.TargetProperty.getSqsParameters()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.this@Stability(value=Stable) public CfnRule.TargetProperty build()
build in interface software.amazon.jsii.Builder<CfnRule.TargetProperty>CfnRule.TargetPropertyNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.