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

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeTargetParametersProperty.Builder	A builder for CfnPipe.PipeTargetParametersProperty
static final class	CfnPipe.PipeTargetParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeTargetParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeTargetParametersProperty.Builder	builder()
default Object	getBatchJobParameters()
default Object	getCloudWatchLogsParameters()
default Object	getEcsTaskParameters()
default Object	getEventBridgeEventBusParameters()
default Object	getHttpParameters()
default String	getInputTemplate()	Valid JSON text passed to the target.
default Object	getKinesisStreamParameters()
default Object	getLambdaFunctionParameters()
default Object	getRedshiftDataParameters()
default Object	getSageMakerPipelineParameters()
default Object	getSqsQueueParameters()
default Object	getStepFunctionStateMachineParameters()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBatchJobParameters

@Stability(Stable)
@Nullable
default Object getBatchJobParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-batchjobparameters

getCloudWatchLogsParameters

@Stability(Stable)
@Nullable
default Object getCloudWatchLogsParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters

getEcsTaskParameters

@Stability(Stable)
@Nullable
default Object getEcsTaskParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-ecstaskparameters

getEventBridgeEventBusParameters

@Stability(Stable)
@Nullable
default Object getEventBridgeEventBusParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters

getHttpParameters

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-httpparameters

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate

getKinesisStreamParameters

@Stability(Stable)
@Nullable
default Object getKinesisStreamParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters

getLambdaFunctionParameters

@Stability(Stable)
@Nullable
default Object getLambdaFunctionParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters

getRedshiftDataParameters

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters

getSageMakerPipelineParameters

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters

getSqsQueueParameters

@Stability(Stable)
@Nullable
default Object getSqsQueueParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters

getStepFunctionStateMachineParameters

@Stability(Stable)
@Nullable
default Object getStepFunctionStateMachineParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters

builder

@Stability(Stable)
static CfnPipe.PipeTargetParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeTargetParametersProperty.Builder of CfnPipe.PipeTargetParametersProperty