CfnPipelineProps

class aws_cdk.aws_osis.CfnPipelineProps(*, max_units, min_units, pipeline_configuration_body, pipeline_name, log_publishing_options=None, tags=None, vpc_options=None)

Bases: object

Properties for defining a CfnPipeline.

Parameters:

max_units (Union[int, float]) – The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
min_units (Union[int, float]) – The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
pipeline_configuration_body (str) – The Data Prepper pipeline configuration in YAML format.
pipeline_name (str) – The name of the pipeline.
log_publishing_options (Union[LogPublishingOptionsProperty, Dict[str, Any], IResolvable, None]) – Key-value pairs that represent log publishing settings.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – List of tags to add to the pipeline upon creation.
vpc_options (Union[IResolvable, VpcOptionsProperty, Dict[str, Any], None]) – Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

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_osis as osis

cfn_pipeline_props = osis.CfnPipelineProps(
    max_units=123,
    min_units=123,
    pipeline_configuration_body="pipelineConfigurationBody",
    pipeline_name="pipelineName",

    # the properties below are optional
    log_publishing_options=osis.CfnPipeline.LogPublishingOptionsProperty(
        cloud_watch_log_destination=osis.CfnPipeline.CloudWatchLogDestinationProperty(
            log_group="logGroup"
        ),
        is_logging_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=osis.CfnPipeline.VpcOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)