software.amazon.awscdk.services.events

Interface CfnRule.TargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.TargetProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(value=Stable)
public static interface CfnRule.TargetProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 TargetProperty targetProperty = TargetProperty.builder()
         .arn("arn")
         .id("id")
         // the properties below are optional
         .batchParameters(BatchParametersProperty.builder()
                 .jobDefinition("jobDefinition")
                 .jobName("jobName")
                 // the properties below are optional
                 .arrayProperties(BatchArrayPropertiesProperty.builder()
                         .size(123)
                         .build())
                 .retryStrategy(BatchRetryStrategyProperty.builder()
                         .attempts(123)
                         .build())
                 .build())
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .ecsParameters(EcsParametersProperty.builder()
                 .taskDefinitionArn("taskDefinitionArn")
                 // the properties below are optional
                 .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                         .capacityProvider("capacityProvider")
                         // the properties below are optional
                         .base(123)
                         .weight(123)
                         .build()))
                 .enableEcsManagedTags(false)
                 .enableExecuteCommand(false)
                 .group("group")
                 .launchType("launchType")
                 .networkConfiguration(NetworkConfigurationProperty.builder()
                         .awsVpcConfiguration(AwsVpcConfigurationProperty.builder()
                                 .subnets(List.of("subnets"))
                                 // the properties below are optional
                                 .assignPublicIp("assignPublicIp")
                                 .securityGroups(List.of("securityGroups"))
                                 .build())
                         .build())
                 .placementConstraints(List.of(PlacementConstraintProperty.builder()
                         .expression("expression")
                         .type("type")
                         .build()))
                 .placementStrategies(List.of(PlacementStrategyProperty.builder()
                         .field("field")
                         .type("type")
                         .build()))
                 .platformVersion("platformVersion")
                 .propagateTags("propagateTags")
                 .referenceId("referenceId")
                 .tagList(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .taskCount(123)
                 .build())
         .httpParameters(HttpParametersProperty.builder()
                 .headerParameters(Map.of(
                         "headerParametersKey", "headerParameters"))
                 .pathParameterValues(List.of("pathParameterValues"))
                 .queryStringParameters(Map.of(
                         "queryStringParametersKey", "queryStringParameters"))
                 .build())
         .input("input")
         .inputPath("inputPath")
         .inputTransformer(InputTransformerProperty.builder()
                 .inputTemplate("inputTemplate")
                 // the properties below are optional
                 .inputPathsMap(Map.of(
                         "inputPathsMapKey", "inputPathsMap"))
                 .build())
         .kinesisParameters(KinesisParametersProperty.builder()
                 .partitionKeyPath("partitionKeyPath")
                 .build())
         .redshiftDataParameters(RedshiftDataParametersProperty.builder()
                 .database("database")
                 .sql("sql")
                 // the properties below are optional
                 .dbUser("dbUser")
                 .secretManagerArn("secretManagerArn")
                 .statementName("statementName")
                 .withEvent(false)
                 .build())
         .retryPolicy(RetryPolicyProperty.builder()
                 .maximumEventAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .build())
         .roleArn("roleArn")
         .runCommandParameters(RunCommandParametersProperty.builder()
                 .runCommandTargets(List.of(RunCommandTargetProperty.builder()
                         .key("key")
                         .values(List.of("values"))
                         .build()))
                 .build())
         .sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
                 .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .sqsParameters(SqsParametersProperty.builder()
                 .messageGroupId("messageGroupId")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRule.TargetProperty.Builder A builder for CfnRule.TargetProperty
static class	CfnRule.TargetProperty.Jsii$Proxy An implementation for CfnRule.TargetProperty

Method Summary

Modifier and Type	Method and Description
static CfnRule.TargetProperty.Builder	builder()
String	getArn() The Amazon Resource Name (ARN) of the target.
default Object	getBatchParameters() If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.
default Object	getDeadLetterConfig() The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
default Object	getEcsParameters() Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
default Object	getHttpParameters() Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
String	getId() The ID of the target within the specified rule.
default String	getInput() Valid JSON text passed to the target.
default String	getInputPath() The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
default Object	getInputTransformer() Settings to enable you to provide custom input to a target based on certain event data.
default Object	getKinesisParameters() The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.
default Object	getRedshiftDataParameters() Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
default Object	getRetryPolicy() The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.
default String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
default Object	getRunCommandParameters() Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
default Object	getSageMakerPipelineParameters() Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
default Object	getSqsParameters() Contains the message group ID to use when the target is a FIFO queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArn

@Stability(value=Stable)
 @NotNull
String getArn()

The Amazon Resource Name (ARN) of the target.

getId

@Stability(value=Stable)
 @NotNull
String getId()

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.

getBatchParameters

@Stability(value=Stable)
 @Nullable
default Object getBatchParameters()

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 .

getDeadLetterConfig

@Stability(value=Stable)
 @Nullable
default Object getDeadLetterConfig()

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

getEcsParameters

@Stability(value=Stable)
 @Nullable
default Object getEcsParameters()

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 .

getHttpParameters

@Stability(value=Stable)
 @Nullable
default Object getHttpParameters()

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.

getInput

@Stability(value=Stable)
 @Nullable
default String getInput()

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 .

getInputPath

@Stability(value=Stable)
 @Nullable
default String getInputPath()

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 .

getInputTransformer

@Stability(value=Stable)
 @Nullable
default Object getInputTransformer()

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.

getKinesisParameters

@Stability(value=Stable)
 @Nullable
default Object getKinesisParameters()

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.

getRedshiftDataParameters

@Stability(value=Stable)
 @Nullable
default Object getRedshiftDataParameters()

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.

getRetryPolicy

@Stability(value=Stable)
 @Nullable
default Object getRetryPolicy()

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

getRoleArn

@Stability(value=Stable)
 @Nullable
default String getRoleArn()

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.

getRunCommandParameters

@Stability(value=Stable)
 @Nullable
default Object getRunCommandParameters()

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

getSageMakerPipelineParameters

@Stability(value=Stable)
 @Nullable
default Object getSageMakerPipelineParameters()

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.

getSqsParameters

@Stability(value=Stable)
 @Nullable
default Object getSqsParameters()

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.

builder

@Stability(value=Stable)
static CfnRule.TargetProperty.Builder builder()

Returns:

a CfnRule.TargetProperty.Builder of CfnRule.TargetProperty