class CfnPipelinePropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.OSIS.CfnPipelinePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsosis#CfnPipelinePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.osis.CfnPipelinePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_osis.CfnPipelinePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_osis » CfnPipelinePropsMixin

Implements IMixin

Extends Mixin

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
declare const policy: any;
const cfnPipelinePropsMixin = new osis.CfnPipelinePropsMixin({
  bufferOptions: {
    persistentBufferEnabled: false,
  },
  encryptionAtRestOptions: {
    kmsKeyArn: 'kmsKeyArn',
  },
  logPublishingOptions: {
    cloudWatchLogDestination: {
      logGroup: 'logGroup',
    },
    isLoggingEnabled: false,
  },
  maxUnits: 123,
  minUnits: 123,
  pipelineConfigurationBody: 'pipelineConfigurationBody',
  pipelineName: 'pipelineName',
  pipelineRoleArn: 'pipelineRoleArn',
  resourcePolicy: {
    policy: policy,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
    vpcAttachmentOptions: {
      attachToVpc: false,
      cidrBlock: 'cidrBlock',
    },
    vpcEndpointManagement: 'vpcEndpointManagement',
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnPipelinePropsMixin(props: CfnPipelineMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPipelineMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnPipelineMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPipelineMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.