CfnPipelineProps

class aws_cdk.aws_osis.CfnPipelineProps(*, max_units, min_units, pipeline_configuration_body, pipeline_name, buffer_options=None, encryption_at_rest_options=None, log_publishing_options=None, pipeline_role_arn=None, resource_policy=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.
buffer_options (Union[IResolvable, BufferOptionsProperty, Dict[str, Any], None]) – Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
encryption_at_rest_options (Union[IResolvable, EncryptionAtRestOptionsProperty, Dict[str, Any], None]) – Options to control how OpenSearch encrypts buffer data.
log_publishing_options (Union[IResolvable, LogPublishingOptionsProperty, Dict[str, Any], None]) – Key-value pairs that represent log publishing settings.
pipeline_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
resource_policy (Union[IResolvable, ResourcePolicyProperty, Dict[str, Any], None])
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.

See:

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.
from aws_cdk import aws_osis as osis

# policy: Any

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

    # the properties below are optional
    buffer_options=osis.CfnPipeline.BufferOptionsProperty(
        persistent_buffer_enabled=False
    ),
    encryption_at_rest_options=osis.CfnPipeline.EncryptionAtRestOptionsProperty(
        kms_key_arn="kmsKeyArn"
    ),
    log_publishing_options=osis.CfnPipeline.LogPublishingOptionsProperty(
        cloud_watch_log_destination=osis.CfnPipeline.CloudWatchLogDestinationProperty(
            log_group="logGroup"
        ),
        is_logging_enabled=False
    ),
    pipeline_role_arn="pipelineRoleArn",
    resource_policy=osis.CfnPipeline.ResourcePolicyProperty(
        policy=policy
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=osis.CfnPipeline.VpcOptionsProperty(
        subnet_ids=["subnetIds"],

        # the properties below are optional
        security_group_ids=["securityGroupIds"],
        vpc_attachment_options=osis.CfnPipeline.VpcAttachmentOptionsProperty(
            attach_to_vpc=False,
            cidr_block="cidrBlock"
        ),
        vpc_endpoint_management="vpcEndpointManagement"
    )
)