CfnPipeline

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

Bases: CfnResource

A CloudFormation AWS::OSIS::Pipeline.

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

CloudformationResource:: AWS::OSIS::Pipeline
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 = osis.CfnPipeline(self, "MyCfnPipeline",
    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"]
    )
)

Create a new AWS::OSIS::Pipeline.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::OSIS::Pipeline'

attr_ingest_endpoint_urls

The ingestion endpoints for the pipeline that you can send data to.

For example, my-pipeline-123456789012.us-east-1.osis.amazonaws.com .

CloudformationAttribute:: IngestEndpointUrls

attr_pipeline_arn

The Amazon Resource Name (ARN) of the pipeline.

CloudformationAttribute:: PipelineArn

attr_vpc_endpoints

The VPC interface endpoints that have access to the pipeline.

CloudformationAttribute:: VpcEndpoints

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

log_publishing_options

Key-value pairs that represent log publishing settings.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

max_units

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

Link:: 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).

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

node: The construct tree node associated with this construct.

pipeline_configuration_body

The Data Prepper pipeline configuration in YAML format.

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

pipeline_name

The name of the pipeline.

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

List of tags to add to the pipeline upon creation.

Link:: 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.

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

CloudWatchLogDestinationProperty

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

Bases: object

Parameters:: log_group (Optional[str]) – CfnPipeline.CloudWatchLogDestinationProperty.LogGroup.
Link:: 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.
import aws_cdk.aws_osis as osis

cloud_watch_log_destination_property = osis.CfnPipeline.CloudWatchLogDestinationProperty(
    log_group="logGroup"
)

Attributes

log_group

CfnPipeline.CloudWatchLogDestinationProperty.LogGroup.

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

LogPublishingOptionsProperty

class CfnPipeline.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.

Link:

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

log_publishing_options_property = osis.CfnPipeline.LogPublishingOptionsProperty(
    cloud_watch_log_destination=osis.CfnPipeline.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 .

Link:: 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.

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

VpcEndpointProperty

class CfnPipeline.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.

Link:

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

vpc_endpoint_property = osis.CfnPipeline.VpcEndpointProperty(
    vpc_endpoint_id="vpcEndpointId",
    vpc_id="vpcId",
    vpc_options=osis.CfnPipeline.VpcOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

vpc_endpoint_id

The unique identifier of the endpoint.

Link:: 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.

Link:: 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.

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

VpcOptionsProperty

class CfnPipeline.VpcOptionsProperty(*, security_group_ids=None, subnet_ids=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.

Link:

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

vpc_options_property = osis.CfnPipeline.VpcOptionsProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

A list of security groups associated with the VPC endpoint.

Link:: 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.

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