Package 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(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
         .appSyncParameters(AppSyncParametersProperty.builder()
                 .graphQlOperation("graphQlOperation")
                 .build())
         .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")
                 // the properties below are optional
                 .dbUser("dbUser")
                 .secretManagerArn("secretManagerArn")
                 .sql("sql")
                 .sqls(List.of("sqls"))
                 .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();

See Also:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnRule.TargetProperty.Builder
    builder()
     
    default Object
    getAppSyncParameters()
    Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
    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 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