CfnPipelineMixinProps

class aws_cdk.mixins_preview.aws_osis.mixins.CfnPipelineMixinProps(*, buffer_options=None, encryption_at_rest_options=None, log_publishing_options=None, max_units=None, min_units=None, pipeline_configuration_body=None, pipeline_name=None, pipeline_role_arn=None, resource_policy=None, tags=None, vpc_options=None)

Bases: object

Properties for CfnPipelinePropsMixin.

Parameters:
  • 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.

  • max_units (Union[int, float, None]) – The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

  • min_units (Union[int, float, None]) – The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

  • pipeline_configuration_body (Optional[str]) – The Data Prepper pipeline configuration in YAML format.

  • pipeline_name (Optional[str]) – The name of the pipeline.

  • 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.mixins_preview.aws_osis import mixins as osis_mixins

# policy: Any

cfn_pipeline_mixin_props = osis_mixins.CfnPipelineMixinProps(
    buffer_options=osis_mixins.CfnPipelinePropsMixin.BufferOptionsProperty(
        persistent_buffer_enabled=False
    ),
    encryption_at_rest_options=osis_mixins.CfnPipelinePropsMixin.EncryptionAtRestOptionsProperty(
        kms_key_arn="kmsKeyArn"
    ),
    log_publishing_options=osis_mixins.CfnPipelinePropsMixin.LogPublishingOptionsProperty(
        cloud_watch_log_destination=osis_mixins.CfnPipelinePropsMixin.CloudWatchLogDestinationProperty(
            log_group="logGroup"
        ),
        is_logging_enabled=False
    ),
    max_units=123,
    min_units=123,
    pipeline_configuration_body="pipelineConfigurationBody",
    pipeline_name="pipelineName",
    pipeline_role_arn="pipelineRoleArn",
    resource_policy=osis_mixins.CfnPipelinePropsMixin.ResourcePolicyProperty(
        policy=policy
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=osis_mixins.CfnPipelinePropsMixin.VpcOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"],
        vpc_attachment_options=osis_mixins.CfnPipelinePropsMixin.VpcAttachmentOptionsProperty(
            attach_to_vpc=False,
            cidr_block="cidrBlock"
        ),
        vpc_endpoint_management="vpcEndpointManagement"
    )
)

Attributes

buffer_options

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 .

See:

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

encryption_at_rest_options

Options to control how OpenSearch encrypts buffer data.

See:

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

log_publishing_options

Key-value pairs that represent log publishing settings.

See:

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

max_units

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

See:

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

min_units

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

See:

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

pipeline_configuration_body

The Data Prepper pipeline configuration in YAML format.

See:

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

pipeline_name

The name of the pipeline.

See:

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

pipeline_role_arn

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

See:

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

resource_policy

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

Type:

see

tags

List of tags to add to the pipeline upon creation.

See:

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

vpc_options

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#cfn-osis-pipeline-vpcoptions