Interface TargetConfig
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
TargetConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-03-04T22:57:35.746Z")
@Stability(Experimental)
public interface TargetConfig
extends software.amazon.jsii.JsiiSerializable
(experimental) Target config properties.
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.alpha.*; TargetConfig targetConfig = TargetConfig.builder() .targetParameters(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()) .timestreamParameters(PipeTargetTimestreamParametersProperty.builder() .dimensionMappings(List.of(DimensionMappingProperty.builder() .dimensionName("dimensionName") .dimensionValue("dimensionValue") .dimensionValueType("dimensionValueType") .build())) .timeValue("timeValue") .versionValue("versionValue") // the properties below are optional .epochTimeUnit("epochTimeUnit") .multiMeasureMappings(List.of(MultiMeasureMappingProperty.builder() .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder() .measureValue("measureValue") .measureValueType("measureValueType") .multiMeasureAttributeName("multiMeasureAttributeName") .build())) .multiMeasureName("multiMeasureName") .build())) .singleMeasureMappings(List.of(SingleMeasureMappingProperty.builder() .measureName("measureName") .measureValue("measureValue") .measureValueType("measureValueType") .build())) .timeFieldType("timeFieldType") .timestampFormat("timestampFormat") .build()) .build()) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forTargetConfig
static final class
An implementation forTargetConfig
-
Method Summary
Modifier and TypeMethodDescriptionstatic TargetConfig.Builder
builder()
(experimental) The parameters required to set up a target for your pipe.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getTargetParameters
(experimental) The parameters required to set up a target for your pipe. -
builder
- Returns:
- a
TargetConfig.Builder
ofTargetConfig
-