CfnPipelinePropsMixin

class aws_cdk.mixins_preview.aws_osis.mixins.CfnPipelinePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html
CloudformationResource:: AWS::OSIS::Pipeline
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_osis import mixins as osis_mixins

# policy: Any

cfn_pipeline_props_mixin = osis_mixins.CfnPipelinePropsMixin(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"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::OSIS::Pipeline.

Parameters:

props (Union[CfnPipelineMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['bufferOptions', 'encryptionAtRestOptions', 'logPublishingOptions', 'maxUnits', 'minUnits', 'pipelineConfigurationBody', 'pipelineName', 'pipelineRoleArn', 'resourcePolicy', 'tags', 'vpcOptions']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BufferOptionsProperty

class CfnPipelinePropsMixin.BufferOptionsProperty(*, persistent_buffer_enabled=None)

Bases: object

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 .

Parameters:: persistent_buffer_enabled (Union[bool, IResolvable, None]) – Whether persistent buffering should be enabled.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-bufferoptions.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

buffer_options_property = osis_mixins.CfnPipelinePropsMixin.BufferOptionsProperty(
    persistent_buffer_enabled=False
)

Attributes

persistent_buffer_enabled

Whether persistent buffering should be enabled.

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

CloudWatchLogDestinationProperty

class CfnPipelinePropsMixin.CloudWatchLogDestinationProperty(*, log_group=None)

Bases: object

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.

Parameters:: log_group (Optional[str]) – The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-cloudwatchlogdestination.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

cloud_watch_log_destination_property = osis_mixins.CfnPipelinePropsMixin.CloudWatchLogDestinationProperty(
    log_group="logGroup"
)

Attributes

log_group

The name of the CloudWatch Logs group to send pipeline logs to.

You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-cloudwatchlogdestination.html#cfn-osis-pipeline-cloudwatchlogdestination-loggroup

EncryptionAtRestOptionsProperty

class CfnPipelinePropsMixin.EncryptionAtRestOptionsProperty(*, kms_key_arn=None)

Bases: object

Options to control how OpenSearch encrypts buffer data.

Parameters:: kms_key_arn (Optional[str]) – The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an AWS owned key.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-encryptionatrestoptions.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

encryption_at_rest_options_property = osis_mixins.CfnPipelinePropsMixin.EncryptionAtRestOptionsProperty(
    kms_key_arn="kmsKeyArn"
)

Attributes

kms_key_arn

The ARN of the KMS key used to encrypt buffer data.

By default, data is encrypted using an AWS owned key.

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

LogPublishingOptionsProperty

class CfnPipelinePropsMixin.LogPublishingOptionsProperty(*, cloud_watch_log_destination=None, is_logging_enabled=None)

Bases: object

Container for the values required to configure logging for the pipeline.

If you don’t specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.

Parameters:

cloud_watch_log_destination (Union[IResolvable, CloudWatchLogDestinationProperty, Dict[str, Any], None]) – The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true .
is_logging_enabled (Union[bool, IResolvable, None]) – Whether logs should be published.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-logpublishingoptions.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

log_publishing_options_property = osis_mixins.CfnPipelinePropsMixin.LogPublishingOptionsProperty(
    cloud_watch_log_destination=osis_mixins.CfnPipelinePropsMixin.CloudWatchLogDestinationProperty(
        log_group="logGroup"
    ),
    is_logging_enabled=False
)

Attributes

cloud_watch_log_destination

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs.

This parameter is required if IsLoggingEnabled is set to true .

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

is_logging_enabled

Whether logs should be published.

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

ResourcePolicyProperty

class CfnPipelinePropsMixin.ResourcePolicyProperty(*, policy=None)

Bases: object

Parameters:: policy (Any)
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-resourcepolicy.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

resource_policy_property = osis_mixins.CfnPipelinePropsMixin.ResourcePolicyProperty(
    policy=policy
)

Attributes

policy

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

Type:: see

VpcAttachmentOptionsProperty

class CfnPipelinePropsMixin.VpcAttachmentOptionsProperty(*, attach_to_vpc=None, cidr_block=None)

Bases: object

Options for attaching a VPC to pipeline.

Parameters:

attach_to_vpc (Union[bool, IResolvable, None]) – Whether a VPC is attached to the pipeline.
cidr_block (Optional[str]) – The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcattachmentoptions.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

vpc_attachment_options_property = osis_mixins.CfnPipelinePropsMixin.VpcAttachmentOptionsProperty(
    attach_to_vpc=False,
    cidr_block="cidrBlock"
)

Attributes

attach_to_vpc

Whether a VPC is attached to the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcattachmentoptions.html#cfn-osis-pipeline-vpcattachmentoptions-attachtovpc

cidr_block

The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcattachmentoptions.html#cfn-osis-pipeline-vpcattachmentoptions-cidrblock

VpcEndpointProperty

class CfnPipelinePropsMixin.VpcEndpointProperty(*, vpc_endpoint_id=None, vpc_id=None, vpc_options=None)

Bases: object

An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.

Parameters:

vpc_endpoint_id (Optional[str]) – The unique identifier of the endpoint.
vpc_id (Optional[str]) – The ID for your VPC. AWS PrivateLink generates this value when you create a VPC.
vpc_options (Union[IResolvable, VpcOptionsProperty, Dict[str, Any], None]) – Information about the VPC, including associated subnets and security groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.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

vpc_endpoint_property = osis_mixins.CfnPipelinePropsMixin.VpcEndpointProperty(
    vpc_endpoint_id="vpcEndpointId",
    vpc_id="vpcId",
    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

vpc_endpoint_id

The unique identifier of the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcendpointid

vpc_id

The ID for your VPC.

AWS PrivateLink generates this value when you create a VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcid

vpc_options

Information about the VPC, including associated subnets and security groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcoptions

VpcOptionsProperty

class CfnPipelinePropsMixin.VpcOptionsProperty(*, security_group_ids=None, subnet_ids=None, vpc_attachment_options=None, vpc_endpoint_management=None)

Bases: object

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

Parameters:

security_group_ids (Optional[Sequence[str]]) – A list of security groups associated with the VPC endpoint.
subnet_ids (Optional[Sequence[str]]) – A list of subnet IDs associated with the VPC endpoint.
vpc_attachment_options (Union[IResolvable, VpcAttachmentOptionsProperty, Dict[str, Any], None]) – Options for attaching a VPC to a pipeline.
vpc_endpoint_management (Optional[str]) – Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.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

vpc_options_property = 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

security_group_ids

A list of security groups associated with the VPC endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-securitygroupids

subnet_ids

A list of subnet IDs associated with the VPC endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-subnetids

vpc_attachment_options

Options for attaching a VPC to a pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-vpcattachmentoptions

vpc_endpoint_management

Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-vpcendpointmanagement