Class CfnStreamProcessorProps
Properties for defining a CfnStreamProcessor
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Rekognition
Assembly: Amazon.CDK.AWS.Rekognition.dll
Syntax (csharp)
public class CfnStreamProcessorProps : Object, ICfnStreamProcessorProps
Syntax (vb)
Public Class CfnStreamProcessorProps
Inherits Object
Implements ICfnStreamProcessorProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Rekognition;
var polygonRegionsOfInterest;
var cfnStreamProcessorProps = new CfnStreamProcessorProps {
KinesisVideoStream = new KinesisVideoStreamProperty {
Arn = "arn"
},
RoleArn = "roleArn",
// the properties below are optional
BoundingBoxRegionsOfInterest = new [] { new BoundingBoxProperty {
Height = 123,
Left = 123,
Top = 123,
Width = 123
} },
ConnectedHomeSettings = new ConnectedHomeSettingsProperty {
Labels = new [] { "labels" },
// the properties below are optional
MinConfidence = 123
},
DataSharingPreference = new DataSharingPreferenceProperty {
OptIn = false
},
FaceSearchSettings = new FaceSearchSettingsProperty {
CollectionId = "collectionId",
// the properties below are optional
FaceMatchThreshold = 123
},
KinesisDataStream = new KinesisDataStreamProperty {
Arn = "arn"
},
KmsKeyId = "kmsKeyId",
Name = "name",
NotificationChannel = new NotificationChannelProperty {
Arn = "arn"
},
PolygonRegionsOfInterest = polygonRegionsOfInterest,
S3Destination = new S3DestinationProperty {
BucketName = "bucketName",
// the properties below are optional
ObjectKeyPrefix = "objectKeyPrefix"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnStreamProcessorProps() |
Properties
BoundingBoxRegionsOfInterest | List of BoundingBox objects, each of which denotes a region of interest on screen. |
ConnectedHomeSettings | Connected home settings to use on a streaming video. |
DataSharingPreference | Allows you to opt in or opt out to share data with Rekognition to improve model performance. |
FaceSearchSettings | The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor. |
KinesisDataStream | Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input. |
KinesisVideoStream | The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor. |
KmsKeyId | The identifier for your Amazon Key Management Service key (Amazon KMS key). |
Name | The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of StreamProcessor . If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name. |
NotificationChannel | The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation. |
PolygonRegionsOfInterest | A set of ordered lists of Point objects. Each entry of the set contains a polygon denoting a region of interest on the screen. Each polygon is an ordered list of Point objects. For more information, see the Polygon field of RegionOfInterest . |
RoleArn | The ARN of the IAM role that allows access to the stream processor. |
S3Destination | The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation. |
Tags | A set of tags (key-value pairs) that you want to attach to the stream processor. |
Constructors
CfnStreamProcessorProps()
public CfnStreamProcessorProps()
Properties
BoundingBoxRegionsOfInterest
List of BoundingBox objects, each of which denotes a region of interest on screen.
public object BoundingBoxRegionsOfInterest { get; set; }
Property Value
System.Object
Remarks
For more information, see the BoundingBox field of RegionOfInterest .
ConnectedHomeSettings
Connected home settings to use on a streaming video.
public object ConnectedHomeSettings { get; set; }
Property Value
System.Object
Remarks
You can use a stream processor for connected home features and select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For more information, see the ConnectedHome section of StreamProcessorSettings .
DataSharingPreference
Allows you to opt in or opt out to share data with Rekognition to improve model performance.
public object DataSharingPreference { get; set; }
Property Value
System.Object
Remarks
You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams. For more information, see StreamProcessorDataSharingPreference .
FaceSearchSettings
The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.
public object FaceSearchSettings { get; set; }
Property Value
System.Object
Remarks
For more information regarding the contents of the parameters, see FaceSearchSettings .
KinesisDataStream
Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.
public object KinesisDataStream { get; set; }
Property Value
System.Object
Remarks
This is the Amazon Kinesis Data Streams instance to which the Amazon Rekognition stream processor streams the analysis results. This must be created within the constraints specified at KinesisDataStream .
KinesisVideoStream
The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
public object KinesisVideoStream { get; set; }
Property Value
System.Object
Remarks
KmsKeyId
The identifier for your Amazon Key Management Service key (Amazon KMS key).
public string KmsKeyId { get; set; }
Property Value
System.String
Remarks
Optional parameter for connected home stream processors used to encrypt results and data published to your Amazon S3 bucket. For more information, see the KMSKeyId section of CreateStreamProcessor .
Name
The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of StreamProcessor . If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name.
public string Name { get; set; }
Property Value
System.String
Remarks
NotificationChannel
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
public object NotificationChannel { get; set; }
Property Value
System.Object
Remarks
Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. Amazon Rekognition also publishes an end-of-session notification with a summary when the stream processing session is complete. For more information, see StreamProcessorNotificationChannel .
PolygonRegionsOfInterest
A set of ordered lists of Point objects. Each entry of the set contains a polygon denoting a region of interest on the screen. Each polygon is an ordered list of Point objects. For more information, see the Polygon field of RegionOfInterest .
public object PolygonRegionsOfInterest { get; set; }
Property Value
System.Object
Remarks
RoleArn
The ARN of the IAM role that allows access to the stream processor.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
The IAM role provides Rekognition read permissions to the Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a connected home stream processor. This is required for both face search and connected home stream processors. For information about constraints, see the RoleArn section of CreateStreamProcessor .
S3Destination
The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
public object S3Destination { get; set; }
Property Value
System.Object
Remarks
For more information, see the S3Destination section of StreamProcessorOutput .
Tags
A set of tags (key-value pairs) that you want to attach to the stream processor.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see the Tags section of CreateStreamProcessor .