Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeTargetParametersProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnPipe.PipeTargetParametersProperty.Jsii$Proxy
Enclosing class:
CfnPipe
@Stability(Stable) public static interface CfnPipe.PipeTargetParametersProperty extends software.amazon.jsii.JsiiSerializable
The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters 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.pipes.*;
 PipeTargetParametersProperty pipeTargetParametersProperty = PipeTargetParametersProperty.builder()
         .batchJobParameters(PipeTargetBatchJobParametersProperty.builder()
                 .jobDefinition("jobDefinition")
                 .jobName("jobName")
                 // the properties below are optional
                 .arrayProperties(BatchArrayPropertiesProperty.builder()
                         .size(123)
                         .build())
                 .containerOverrides(BatchContainerOverridesProperty.builder()
                         .command(List.of("command"))
                         .environment(List.of(BatchEnvironmentVariableProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .instanceType("instanceType")
                         .resourceRequirements(List.of(BatchResourceRequirementProperty.builder()
                                 .type("type")
                                 .value("value")
                                 .build()))
                         .build())
                 .dependsOn(List.of(BatchJobDependencyProperty.builder()
                         .jobId("jobId")
                         .type("type")
                         .build()))
                 .parameters(Map.of(
                         "parametersKey", "parameters"))
                 .retryStrategy(BatchRetryStrategyProperty.builder()
                         .attempts(123)
                         .build())
                 .build())
         .cloudWatchLogsParameters(PipeTargetCloudWatchLogsParametersProperty.builder()
                 .logStreamName("logStreamName")
                 .timestamp("timestamp")
                 .build())
         .ecsTaskParameters(PipeTargetEcsTaskParametersProperty.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())
                 .overrides(EcsTaskOverrideProperty.builder()
                         .containerOverrides(List.of(EcsContainerOverrideProperty.builder()
                                 .command(List.of("command"))
                                 .cpu(123)
                                 .environment(List.of(EcsEnvironmentVariableProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .environmentFiles(List.of(EcsEnvironmentFileProperty.builder()
                                         .type("type")
                                         .value("value")
                                         .build()))
                                 .memory(123)
                                 .memoryReservation(123)
                                 .name("name")
                                 .resourceRequirements(List.of(EcsResourceRequirementProperty.builder()
                                         .type("type")
                                         .value("value")
                                         .build()))
                                 .build()))
                         .cpu("cpu")
                         .ephemeralStorage(EcsEphemeralStorageProperty.builder()
                                 .sizeInGiB(123)
                                 .build())
                         .executionRoleArn("executionRoleArn")
                         .inferenceAcceleratorOverrides(List.of(EcsInferenceAcceleratorOverrideProperty.builder()
                                 .deviceName("deviceName")
                                 .deviceType("deviceType")
                                 .build()))
                         .memory("memory")
                         .taskRoleArn("taskRoleArn")
                         .build())
                 .placementConstraints(List.of(PlacementConstraintProperty.builder()
                         .expression("expression")
                         .type("type")
                         .build()))
                 .placementStrategy(List.of(PlacementStrategyProperty.builder()
                         .field("field")
                         .type("type")
                         .build()))
                 .platformVersion("platformVersion")
                 .propagateTags("propagateTags")
                 .referenceId("referenceId")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .taskCount(123)
                 .build())
         .eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParametersProperty.builder()
                 .detailType("detailType")
                 .endpointId("endpointId")
                 .resources(List.of("resources"))
                 .source("source")
                 .time("time")
                 .build())
         .httpParameters(PipeTargetHttpParametersProperty.builder()
                 .headerParameters(Map.of(
                         "headerParametersKey", "headerParameters"))
                 .pathParameterValues(List.of("pathParameterValues"))
                 .queryStringParameters(Map.of(
                         "queryStringParametersKey", "queryStringParameters"))
                 .build())
         .inputTemplate("inputTemplate")
         .kinesisStreamParameters(PipeTargetKinesisStreamParametersProperty.builder()
                 .partitionKey("partitionKey")
                 .build())
         .lambdaFunctionParameters(PipeTargetLambdaFunctionParametersProperty.builder()
                 .invocationType("invocationType")
                 .build())
         .redshiftDataParameters(PipeTargetRedshiftDataParametersProperty.builder()
                 .database("database")
                 .sqls(List.of("sqls"))
                 // the properties below are optional
                 .dbUser("dbUser")
                 .secretManagerArn("secretManagerArn")
                 .statementName("statementName")
                 .withEvent(false)
                 .build())
         .sageMakerPipelineParameters(PipeTargetSageMakerPipelineParametersProperty.builder()
                 .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .sqsQueueParameters(PipeTargetSqsQueueParametersProperty.builder()
                 .messageDeduplicationId("messageDeduplicationId")
                 .messageGroupId("messageGroupId")
                 .build())
         .stepFunctionStateMachineParameters(PipeTargetStateMachineParametersProperty.builder()
                 .invocationType("invocationType")
                 .build())
         .build();

  • Method Details

    • getBatchJobParameters

      @Stability(Stable) @Nullable default Object getBatchJobParameters()
      The parameters for using an AWS Batch job as a target.

    • getCloudWatchLogsParameters

      @Stability(Stable) @Nullable default Object getCloudWatchLogsParameters()
      The parameters for using an CloudWatch Logs log stream as a target.

    • getEcsTaskParameters

      @Stability(Stable) @Nullable default Object getEcsTaskParameters()
      The parameters for using an Amazon ECS task as a target.

    • getEventBridgeEventBusParameters

      @Stability(Stable) @Nullable default Object getEventBridgeEventBusParameters()
      The parameters for using an EventBridge event bus as a target.

    • getHttpParameters

      @Stability(Stable) @Nullable default Object getHttpParameters()
      These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

    • getInputTemplate

      @Stability(Stable) @Nullable default String getInputTemplate()
      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 .

      To remove an input template, specify an empty string.

    • getKinesisStreamParameters

      @Stability(Stable) @Nullable default Object getKinesisStreamParameters()
      The parameters for using a Kinesis stream as a source.

    • getLambdaFunctionParameters

      @Stability(Stable) @Nullable default Object getLambdaFunctionParameters()
      The parameters for using a Lambda function as a target.

    • getRedshiftDataParameters

      @Stability(Stable) @Nullable default Object getRedshiftDataParameters()
      These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

    • getSageMakerPipelineParameters

      @Stability(Stable) @Nullable default Object getSageMakerPipelineParameters()
      The parameters for using a SageMaker pipeline as a target.

    • getSqsQueueParameters

      @Stability(Stable) @Nullable default Object getSqsQueueParameters()
      The parameters for using a Amazon SQS stream as a source.

    • getStepFunctionStateMachineParameters

      @Stability(Stable) @Nullable default Object getStepFunctionStateMachineParameters()
      The parameters for using a Step Functions state machine as a target.

    • builder

      @Stability(Stable) static CfnPipe.PipeTargetParametersProperty.Builder builder()
      Returns:
      a CfnPipe.PipeTargetParametersProperty.Builder of CfnPipe.PipeTargetParametersProperty