CfnPipeProps

class aws_cdk.aws_pipes.CfnPipeProps(*, role_arn, source, target, description=None, desired_state=None, enrichment=None, enrichment_parameters=None, kms_key_identifier=None, log_configuration=None, name=None, source_parameters=None, tags=None, target_parameters=None)

Bases: object

Properties for defining a CfnPipe.

Parameters:

role_arn (str) – The ARN of the role that allows the pipe to send data to the target.
source (str) – The ARN of the source resource.
target (str) – The ARN of the target resource.
description (Optional[str]) – A description of the pipe.
desired_state (Optional[str]) – The state the pipe should be in.
enrichment (Optional[str]) – The ARN of the enrichment resource.
enrichment_parameters (Union[IResolvable, PipeEnrichmentParametersProperty, Dict[str, Any], None]) – The parameters required to set up enrichment on your pipe.
kms_key_identifier (Optional[str]) – The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier. To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string. For more information, see Managing keys in the AWS Key Management Service Developer Guide .
log_configuration (Union[IResolvable, PipeLogConfigurationProperty, Dict[str, Any], None]) – The logging configuration settings for the pipe.
name (Optional[str]) – The name of the pipe.
source_parameters (Union[IResolvable, PipeSourceParametersProperty, Dict[str, Any], None]) – The parameters required to set up a source for your pipe.
tags (Optional[Mapping[str, str]]) – The list of key-value pairs to associate with the pipe.
target_parameters (Union[IResolvable, PipeTargetParametersProperty, Dict[str, Any], None]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_pipe_props = pipes.CfnPipeProps(
    role_arn="roleArn",
    source="source",
    target="target",

    # the properties below are optional
    description="description",
    desired_state="desiredState",
    enrichment="enrichment",
    enrichment_parameters=pipes.CfnPipe.PipeEnrichmentParametersProperty(
        http_parameters=pipes.CfnPipe.PipeEnrichmentHttpParametersProperty(
            header_parameters={
                "header_parameters_key": "headerParameters"
            },
            path_parameter_values=["pathParameterValues"],
            query_string_parameters={
                "query_string_parameters_key": "queryStringParameters"
            }
        ),
        input_template="inputTemplate"
    ),
    kms_key_identifier="kmsKeyIdentifier",
    log_configuration=pipes.CfnPipe.PipeLogConfigurationProperty(
        cloudwatch_logs_log_destination=pipes.CfnPipe.CloudwatchLogsLogDestinationProperty(
            log_group_arn="logGroupArn"
        ),
        firehose_log_destination=pipes.CfnPipe.FirehoseLogDestinationProperty(
            delivery_stream_arn="deliveryStreamArn"
        ),
        include_execution_data=["includeExecutionData"],
        level="level",
        s3_log_destination=pipes.CfnPipe.S3LogDestinationProperty(
            bucket_name="bucketName",
            bucket_owner="bucketOwner",
            output_format="outputFormat",
            prefix="prefix"
        )
    ),
    name="name",
    source_parameters=pipes.CfnPipe.PipeSourceParametersProperty(
        active_mq_broker_parameters=pipes.CfnPipe.PipeSourceActiveMQBrokerParametersProperty(
            credentials=pipes.CfnPipe.MQBrokerAccessCredentialsProperty(
                basic_auth="basicAuth"
            ),
            queue_name="queueName",

            # the properties below are optional
            batch_size=123,
            maximum_batching_window_in_seconds=123
        ),
        dynamo_db_stream_parameters=pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty(
            starting_position="startingPosition",

            # the properties below are optional
            batch_size=123,
            dead_letter_config=pipes.CfnPipe.DeadLetterConfigProperty(
                arn="arn"
            ),
            maximum_batching_window_in_seconds=123,
            maximum_record_age_in_seconds=123,
            maximum_retry_attempts=123,
            on_partial_batch_item_failure="onPartialBatchItemFailure",
            parallelization_factor=123
        ),
        filter_criteria=pipes.CfnPipe.FilterCriteriaProperty(
            filters=[pipes.CfnPipe.FilterProperty(
                pattern="pattern"
            )]
        ),
        kinesis_stream_parameters=pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty(
            starting_position="startingPosition",

            # the properties below are optional
            batch_size=123,
            dead_letter_config=pipes.CfnPipe.DeadLetterConfigProperty(
                arn="arn"
            ),
            maximum_batching_window_in_seconds=123,
            maximum_record_age_in_seconds=123,
            maximum_retry_attempts=123,
            on_partial_batch_item_failure="onPartialBatchItemFailure",
            parallelization_factor=123,
            starting_position_timestamp="startingPositionTimestamp"
        ),
        managed_streaming_kafka_parameters=pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty(
            topic_name="topicName",

            # the properties below are optional
            batch_size=123,
            consumer_group_id="consumerGroupId",
            credentials=pipes.CfnPipe.MSKAccessCredentialsProperty(
                client_certificate_tls_auth="clientCertificateTlsAuth",
                sasl_scram512_auth="saslScram512Auth"
            ),
            maximum_batching_window_in_seconds=123,
            starting_position="startingPosition"
        ),
        rabbit_mq_broker_parameters=pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty(
            credentials=pipes.CfnPipe.MQBrokerAccessCredentialsProperty(
                basic_auth="basicAuth"
            ),
            queue_name="queueName",

            # the properties below are optional
            batch_size=123,
            maximum_batching_window_in_seconds=123,
            virtual_host="virtualHost"
        ),
        self_managed_kafka_parameters=pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty(
            topic_name="topicName",

            # the properties below are optional
            additional_bootstrap_servers=["additionalBootstrapServers"],
            batch_size=123,
            consumer_group_id="consumerGroupId",
            credentials=pipes.CfnPipe.SelfManagedKafkaAccessConfigurationCredentialsProperty(
                basic_auth="basicAuth",
                client_certificate_tls_auth="clientCertificateTlsAuth",
                sasl_scram256_auth="saslScram256Auth",
                sasl_scram512_auth="saslScram512Auth"
            ),
            maximum_batching_window_in_seconds=123,
            server_root_ca_certificate="serverRootCaCertificate",
            starting_position="startingPosition",
            vpc=pipes.CfnPipe.SelfManagedKafkaAccessConfigurationVpcProperty(
                security_group=["securityGroup"],
                subnets=["subnets"]
            )
        ),
        sqs_queue_parameters=pipes.CfnPipe.PipeSourceSqsQueueParametersProperty(
            batch_size=123,
            maximum_batching_window_in_seconds=123
        )
    ),
    tags={
        "tags_key": "tags"
    },
    target_parameters=pipes.CfnPipe.PipeTargetParametersProperty(
        batch_job_parameters=pipes.CfnPipe.PipeTargetBatchJobParametersProperty(
            job_definition="jobDefinition",
            job_name="jobName",

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

            # the properties below are optional
            capacity_provider_strategy=[pipes.CfnPipe.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=pipes.CfnPipe.NetworkConfigurationProperty(
                awsvpc_configuration=pipes.CfnPipe.AwsVpcConfigurationProperty(
                    subnets=["subnets"],

                    # the properties below are optional
                    assign_public_ip="assignPublicIp",
                    security_groups=["securityGroups"]
                )
            ),
            overrides=pipes.CfnPipe.EcsTaskOverrideProperty(
                container_overrides=[pipes.CfnPipe.EcsContainerOverrideProperty(
                    command=["command"],
                    cpu=123,
                    environment=[pipes.CfnPipe.EcsEnvironmentVariableProperty(
                        name="name",
                        value="value"
                    )],
                    environment_files=[pipes.CfnPipe.EcsEnvironmentFileProperty(
                        type="type",
                        value="value"
                    )],
                    memory=123,
                    memory_reservation=123,
                    name="name",
                    resource_requirements=[pipes.CfnPipe.EcsResourceRequirementProperty(
                        type="type",
                        value="value"
                    )]
                )],
                cpu="cpu",
                ephemeral_storage=pipes.CfnPipe.EcsEphemeralStorageProperty(
                    size_in_gi_b=123
                ),
                execution_role_arn="executionRoleArn",
                inference_accelerator_overrides=[pipes.CfnPipe.EcsInferenceAcceleratorOverrideProperty(
                    device_name="deviceName",
                    device_type="deviceType"
                )],
                memory="memory",
                task_role_arn="taskRoleArn"
            ),
            placement_constraints=[pipes.CfnPipe.PlacementConstraintProperty(
                expression="expression",
                type="type"
            )],
            placement_strategy=[pipes.CfnPipe.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=pipes.CfnPipe.PipeTargetEventBridgeEventBusParametersProperty(
            detail_type="detailType",
            endpoint_id="endpointId",
            resources=["resources"],
            source="source",
            time="time"
        ),
        http_parameters=pipes.CfnPipe.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=pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty(
            partition_key="partitionKey"
        ),
        lambda_function_parameters=pipes.CfnPipe.PipeTargetLambdaFunctionParametersProperty(
            invocation_type="invocationType"
        ),
        redshift_data_parameters=pipes.CfnPipe.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=pipes.CfnPipe.PipeTargetSageMakerPipelineParametersProperty(
            pipeline_parameter_list=[pipes.CfnPipe.SageMakerPipelineParameterProperty(
                name="name",
                value="value"
            )]
        ),
        sqs_queue_parameters=pipes.CfnPipe.PipeTargetSqsQueueParametersProperty(
            message_deduplication_id="messageDeduplicationId",
            message_group_id="messageGroupId"
        ),
        step_function_state_machine_parameters=pipes.CfnPipe.PipeTargetStateMachineParametersProperty(
            invocation_type="invocationType"
        ),
        timestream_parameters=pipes.CfnPipe.PipeTargetTimestreamParametersProperty(
            dimension_mappings=[pipes.CfnPipe.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=[pipes.CfnPipe.MultiMeasureMappingProperty(
                multi_measure_attribute_mappings=[pipes.CfnPipe.MultiMeasureAttributeMappingProperty(
                    measure_value="measureValue",
                    measure_value_type="measureValueType",
                    multi_measure_attribute_name="multiMeasureAttributeName"
                )],
                multi_measure_name="multiMeasureName"
            )],
            single_measure_mappings=[pipes.CfnPipe.SingleMeasureMappingProperty(
                measure_name="measureName",
                measure_value="measureValue",
                measure_value_type="measureValueType"
            )],
            time_field_type="timeFieldType",
            timestamp_format="timestampFormat"
        )
    )
)

Attributes

description

A description of the pipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description

desired_state

The state the pipe should be in.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-desiredstate

enrichment

The ARN of the enrichment resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichment

enrichment_parameters

The parameters required to set up enrichment on your pipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichmentparameters

kms_key_identifier

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.

To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string.

For more information, see Managing keys in the AWS Key Management Service Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-kmskeyidentifier

log_configuration

The logging configuration settings for the pipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-logconfiguration

name

The name of the pipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-name

role_arn

The ARN of the role that allows the pipe to send data to the target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-rolearn

source

The ARN of the source resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-source

source_parameters

The parameters required to set up a source for your pipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-sourceparameters

tags

The list of key-value pairs to associate with the pipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags

target

The ARN of the target resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-target

target_parameters

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-targetparameters