class CfnPipeline (construct)

Language	Type name
.NET	`Amazon.CDK.aws_osis.CfnPipeline`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsosis#CfnPipeline`
Java	`software.amazon.awscdk.services.osis.CfnPipeline`
Python	`aws_cdk.aws_osis.CfnPipeline`
TypeScript	`aws-cdk-lib` » `aws_osis` » `CfnPipeline`

Implements IConstruct, IDependable, IInspectable, ITaggable

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_osis as osis } from 'aws-cdk-lib';
const cfnPipeline = new osis.CfnPipeline(this, 'MyCfnPipeline', {
  maxUnits: 123,
  minUnits: 123,
  pipelineConfigurationBody: 'pipelineConfigurationBody',
  pipelineName: 'pipelineName',

  // the properties below are optional
  bufferOptions: {
    persistentBufferEnabled: false,
  },
  encryptionAtRestOptions: {
    kmsKeyArn: 'kmsKeyArn',
  },
  logPublishingOptions: {
    cloudWatchLogDestination: {
      logGroup: 'logGroup',
    },
    isLoggingEnabled: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    subnetIds: ['subnetIds'],

    // the properties below are optional
    securityGroupIds: ['securityGroupIds'],
    vpcAttachmentOptions: {
      attachToVpc: false,
      cidrBlock: 'cidrBlock',
    },
    vpcEndpointManagement: 'vpcEndpointManagement',
  },
});

Initializer

new CfnPipeline(scope: Construct, id: string, props: CfnPipelineProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnPipelineProps — Resource properties.

Construct Props

Name	Type	Description
maxUnits	`number`	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
minUnits	`number`	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
pipelineConfigurationBody	`string`	The Data Prepper pipeline configuration in YAML format.
pipelineName	`string`	The name of the pipeline.
bufferOptions?	`IResolvable` `\|` `BufferOptionsProperty`	Options that specify the configuration of a persistent buffer.
encryptionAtRestOptions?	`IResolvable` `\|` `EncryptionAtRestOptionsProperty`	Options to control how OpenSearch encrypts buffer data.
logPublishingOptions?	`IResolvable` `\|` `LogPublishingOptionsProperty`	Key-value pairs that represent log publishing settings.
tags?	`CfnTag[]`	List of tags to add to the pipeline upon creation.
vpcOptions?	`IResolvable` `\|` `VpcOptionsProperty`	Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

maxUnits

Type: number

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

minUnits

Type: number

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

pipelineConfigurationBody

Type: string

The Data Prepper pipeline configuration in YAML format.

pipelineName

Type: string

The name of the pipeline.

bufferOptions?

Type: IResolvable | BufferOptionsProperty (optional)

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 .

encryptionAtRestOptions?

Type: IResolvable | EncryptionAtRestOptionsProperty (optional)

Options to control how OpenSearch encrypts buffer data.

logPublishingOptions?

Type: IResolvable | LogPublishingOptionsProperty (optional)

Key-value pairs that represent log publishing settings.

tags?

Type: CfnTag[] (optional)

List of tags to add to the pipeline upon creation.

vpcOptions?

Type: IResolvable | VpcOptionsProperty (optional)

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

Properties

Name	Type	Description
attrIngestEndpointUrls	`string[]`	A list of the ingestion endpoints for the pipeline that you can send data to.
attrPipelineArn	`string`	The Amazon Resource Name (ARN) of the pipeline.
attrVpcEndpointService	`string`	The VPC endpoint service name for the pipeline.
attrVpcEndpoints	`IResolvable`	The VPC interface endpoints that have access to the pipeline.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
maxUnits	`number`	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
minUnits	`number`	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
node	`Node`	The tree node.
pipelineConfigurationBody	`string`	The Data Prepper pipeline configuration in YAML format.
pipelineName	`string`	The name of the pipeline.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
bufferOptions?	`IResolvable` `\|` `BufferOptionsProperty`	Options that specify the configuration of a persistent buffer.
encryptionAtRestOptions?	`IResolvable` `\|` `EncryptionAtRestOptionsProperty`	Options to control how OpenSearch encrypts buffer data.
logPublishingOptions?	`IResolvable` `\|` `LogPublishingOptionsProperty`	Key-value pairs that represent log publishing settings.
tagsRaw?	`CfnTag[]`	List of tags to add to the pipeline upon creation.
vpcOptions?	`IResolvable` `\|` `VpcOptionsProperty`	Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrIngestEndpointUrls

Type: string[]

A list of the ingestion endpoints for the pipeline that you can send data to.

Currently, only a single ingestion endpoint is supported for a pipeline. For example, my-pipeline-123456789012.us-east-1.osis.amazonaws.com .

attrPipelineArn

Type: string

The Amazon Resource Name (ARN) of the pipeline.

attrVpcEndpointService

Type: string

The VPC endpoint service name for the pipeline.

attrVpcEndpoints

Type: IResolvable

The VPC interface endpoints that have access to the pipeline.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

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

maxUnits

Type: number

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

minUnits

Type: number

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

node

Type: Node

The tree node.

pipelineConfigurationBody

Type: string

The Data Prepper pipeline configuration in YAML format.

pipelineName

Type: string

The name of the pipeline.

ref

Type: string

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

Type: Stack

The stack in which this element is defined.

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

bufferOptions?

Type: IResolvable | BufferOptionsProperty (optional)

Options that specify the configuration of a persistent buffer.

encryptionAtRestOptions?

Type: IResolvable | EncryptionAtRestOptionsProperty (optional)

Options to control how OpenSearch encrypts buffer data.

logPublishingOptions?

Type: IResolvable | LogPublishingOptionsProperty (optional)

Key-value pairs that represent log publishing settings.

tagsRaw?

Type: CfnTag[] (optional)

List of tags to add to the pipeline upon creation.

vpcOptions?

Type: IResolvable | VpcOptionsProperty (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

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

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.](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.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }