TargetConfig

class aws_cdk.aws_pipes_alpha.TargetConfig(*, target_parameters)

Bases: object

(experimental) Target config properties.

Parameters:

target_parameters (Union[PipeTargetParametersProperty, Dict[str, Any]]) – (experimental) The parameters required to set up a target for your pipe.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pipes_alpha as pipes_alpha

target_config = pipes_alpha.TargetConfig(
    target_parameters=PipeTargetParametersProperty(
        batch_job_parameters=PipeTargetBatchJobParametersProperty(
            job_definition="jobDefinition",
            job_name="jobName",

            # the properties below are optional
            array_properties=BatchArrayPropertiesProperty(
                size=123
            ),
            container_overrides=BatchContainerOverridesProperty(
                command=["command"],
                environment=[BatchEnvironmentVariableProperty(
                    name="name",
                    value="value"
                )],
                instance_type="instanceType",
                resource_requirements=[BatchResourceRequirementProperty(
                    type="type",
                    value="value"
                )]
            ),
            depends_on=[BatchJobDependencyProperty(
                job_id="jobId",
                type="type"
            )],
            parameters={
                "parameters_key": "parameters"
            },
            retry_strategy=BatchRetryStrategyProperty(
                attempts=123
            )
        ),
        cloud_watch_logs_parameters=PipeTargetCloudWatchLogsParametersProperty(
            log_stream_name="logStreamName",
            timestamp="timestamp"
        ),
        ecs_task_parameters=PipeTargetEcsTaskParametersProperty(
            task_definition_arn="taskDefinitionArn",

            # the properties below are optional
            capacity_provider_strategy=[CapacityProviderStrategyItemProperty(
                capacity_provider="capacityProvider",

                # the properties below are optional
                base=123,
                weight=123
            )],
            enable_ecs_managed_tags=False,
            enable_execute_command=False,
            group="group",
            launch_type="launchType",
            network_configuration=NetworkConfigurationProperty(
                awsvpc_configuration=AwsVpcConfigurationProperty(
                    subnets=["subnets"],

                    # the properties below are optional
                    assign_public_ip="assignPublicIp",
                    security_groups=["securityGroups"]
                )
            ),
            overrides=EcsTaskOverrideProperty(
                container_overrides=[EcsContainerOverrideProperty(
                    command=["command"],
                    cpu=123,
                    environment=[EcsEnvironmentVariableProperty(
                        name="name",
                        value="value"
                    )],
                    environment_files=[EcsEnvironmentFileProperty(
                        type="type",
                        value="value"
                    )],
                    memory=123,
                    memory_reservation=123,
                    name="name",
                    resource_requirements=[EcsResourceRequirementProperty(
                        type="type",
                        value="value"
                    )]
                )],
                cpu="cpu",
                ephemeral_storage=EcsEphemeralStorageProperty(
                    size_in_gi_b=123
                ),
                execution_role_arn="executionRoleArn",
                inference_accelerator_overrides=[EcsInferenceAcceleratorOverrideProperty(
                    device_name="deviceName",
                    device_type="deviceType"
                )],
                memory="memory",
                task_role_arn="taskRoleArn"
            ),
            placement_constraints=[PlacementConstraintProperty(
                expression="expression",
                type="type"
            )],
            placement_strategy=[PlacementStrategyProperty(
                field="field",
                type="type"
            )],
            platform_version="platformVersion",
            propagate_tags="propagateTags",
            reference_id="referenceId",
            tags=[CfnTag(
                key="key",
                value="value"
            )],
            task_count=123
        ),
        event_bridge_event_bus_parameters=PipeTargetEventBridgeEventBusParametersProperty(
            detail_type="detailType",
            endpoint_id="endpointId",
            resources=["resources"],
            source="source",
            time="time"
        ),
        http_parameters=PipeTargetHttpParametersProperty(
            header_parameters={
                "header_parameters_key": "headerParameters"
            },
            path_parameter_values=["pathParameterValues"],
            query_string_parameters={
                "query_string_parameters_key": "queryStringParameters"
            }
        ),
        input_template="inputTemplate",
        kinesis_stream_parameters=PipeTargetKinesisStreamParametersProperty(
            partition_key="partitionKey"
        ),
        lambda_function_parameters=PipeTargetLambdaFunctionParametersProperty(
            invocation_type="invocationType"
        ),
        redshift_data_parameters=PipeTargetRedshiftDataParametersProperty(
            database="database",
            sqls=["sqls"],

            # the properties below are optional
            db_user="dbUser",
            secret_manager_arn="secretManagerArn",
            statement_name="statementName",
            with_event=False
        ),
        sage_maker_pipeline_parameters=PipeTargetSageMakerPipelineParametersProperty(
            pipeline_parameter_list=[SageMakerPipelineParameterProperty(
                name="name",
                value="value"
            )]
        ),
        sqs_queue_parameters=PipeTargetSqsQueueParametersProperty(
            message_deduplication_id="messageDeduplicationId",
            message_group_id="messageGroupId"
        ),
        step_function_state_machine_parameters=PipeTargetStateMachineParametersProperty(
            invocation_type="invocationType"
        ),
        timestream_parameters=PipeTargetTimestreamParametersProperty(
            dimension_mappings=[DimensionMappingProperty(
                dimension_name="dimensionName",
                dimension_value="dimensionValue",
                dimension_value_type="dimensionValueType"
            )],
            time_value="timeValue",
            version_value="versionValue",

            # the properties below are optional
            epoch_time_unit="epochTimeUnit",
            multi_measure_mappings=[MultiMeasureMappingProperty(
                multi_measure_attribute_mappings=[MultiMeasureAttributeMappingProperty(
                    measure_value="measureValue",
                    measure_value_type="measureValueType",
                    multi_measure_attribute_name="multiMeasureAttributeName"
                )],
                multi_measure_name="multiMeasureName"
            )],
            single_measure_mappings=[SingleMeasureMappingProperty(
                measure_name="measureName",
                measure_value="measureValue",
                measure_value_type="measureValueType"
            )],
            time_field_type="timeFieldType",
            timestamp_format="timestampFormat"
        )
    )
)

Attributes

target_parameters

(experimental) The parameters required to set up a target for your pipe.

Stability:

experimental