class CfnStreamProcessorPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Rekognition.Mixins.CfnStreamProcessorPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsrekognition/mixins#CfnStreamProcessorPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.rekognition.mixins.CfnStreamProcessorPropsMixin
Python	aws_cdk.mixins_preview.aws_rekognition.mixins.CfnStreamProcessorPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_rekognition » mixins » CfnStreamProcessorPropsMixin

Implements IMixin

Extends Mixin

The AWS::Rekognition::StreamProcessor type creates a stream processor used to detect and recognize faces or to detect connected home labels in a streaming video.

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition, one for detecting faces and one for connected home features.

If you are creating a stream processor for detecting faces, you provide a Kinesis video stream (input) and a Kinesis data stream (output). You also specify the face recognition criteria in FaceSearchSettings. For example, the collection containing faces that you want to recognize.

If you are creating a stream processor for detection of connected home labels, you provide a Kinesis video stream for input, and for output an Amazon S3 bucket and an Amazon SNS topic. You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect in ConnectedHomeSettings, such as people, packages, and pets.

You can also specify where in the frame you want Amazon Rekognition to monitor with BoundingBoxRegionsOfInterest and PolygonRegionsOfInterest. The Name is used to manage the stream processor and it is the identifier for the stream processor. The AWS::Rekognition::StreamProcessor resource creates a stream processor in the same Region where you create the Amazon CloudFormation stack.

For more information, see CreateStreamProcessor .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as rekognition_mixins } from '@aws-cdk/mixins-preview/aws-rekognition';

declare const polygonRegionsOfInterest: any;
const cfnStreamProcessorPropsMixin = new rekognition_mixins.CfnStreamProcessorPropsMixin({
  boundingBoxRegionsOfInterest: [{
    height: 123,
    left: 123,
    top: 123,
    width: 123,
  }],
  connectedHomeSettings: {
    labels: ['labels'],
    minConfidence: 123,
  },
  dataSharingPreference: {
    optIn: false,
  },
  faceSearchSettings: {
    collectionId: 'collectionId',
    faceMatchThreshold: 123,
  },
  kinesisDataStream: {
    arn: 'arn',
  },
  kinesisVideoStream: {
    arn: 'arn',
  },
  kmsKeyId: 'kmsKeyId',
  name: 'name',
  notificationChannel: {
    arn: 'arn',
  },
  polygonRegionsOfInterest: polygonRegionsOfInterest,
  roleArn: 'roleArn',
  s3Destination: {
    bucketName: 'bucketName',
    objectKeyPrefix: 'objectKeyPrefix',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnStreamProcessorPropsMixin(props: CfnStreamProcessorMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::Rekognition::StreamProcessor.

Properties

Name	Type	Description
props	CfnStreamProcessorMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnStreamProcessorMixinProps

---

strategy

Type: PropertyMergeStrategy

---

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): IConstruct

Parameters

• construct IConstruct

Returns

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