Class CfnStreamProcessor
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.
Inherited Members
Namespace: Amazon.CDK.AWS.Rekognition
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStreamProcessor : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStreamProcessor
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
CloudformationResource: AWS::Rekognition::StreamProcessor
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 cfnStreamProcessor = new CfnStreamProcessor(this, "MyCfnStreamProcessor", 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
CfnStreamProcessor(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStreamProcessor(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStreamProcessor(Construct, String, ICfnStreamProcessorProps) |
Properties
AttrArn | Amazon Resource Name for the newly created stream processor. |
AttrStatus | Current status of the Amazon Rekognition stream processor. |
AttrStatusMessage | Detailed status message about the stream processor. |
BoundingBoxRegionsOfInterest | List of BoundingBox objects, each of which denotes a region of interest on screen. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | A set of tags (key-value pairs) that you want to attach to the stream processor. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStreamProcessor(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStreamProcessor(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStreamProcessor(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStreamProcessor(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStreamProcessor(Construct, String, ICfnStreamProcessorProps)
public CfnStreamProcessor(Construct scope, string id, ICfnStreamProcessorProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStreamProcessorProps
Resource properties.
Properties
AttrArn
Amazon Resource Name for the newly created stream processor.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrStatus
Current status of the Amazon Rekognition stream processor.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
AttrStatusMessage
Detailed status message about the stream processor.
public virtual string AttrStatusMessage { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StatusMessage
BoundingBoxRegionsOfInterest
List of BoundingBox objects, each of which denotes a region of interest on screen.
public virtual object BoundingBoxRegionsOfInterest { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConnectedHomeSettings
Connected home settings to use on a streaming video.
public virtual object ConnectedHomeSettings { get; set; }
Property Value
System.Object
DataSharingPreference
Allows you to opt in or opt out to share data with Rekognition to improve model performance.
public virtual object DataSharingPreference { get; set; }
Property Value
System.Object
FaceSearchSettings
The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.
public virtual object FaceSearchSettings { get; set; }
Property Value
System.Object
KinesisDataStream
Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.
public virtual object KinesisDataStream { get; set; }
Property Value
System.Object
KinesisVideoStream
The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
public virtual object KinesisVideoStream { get; set; }
Property Value
System.Object
KmsKeyId
The identifier for your Amazon Key Management Service key (Amazon KMS key).
public virtual string KmsKeyId { get; set; }
Property Value
System.String
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 virtual string Name { get; set; }
Property Value
System.String
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 virtual object NotificationChannel { get; set; }
Property Value
System.Object
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 virtual object PolygonRegionsOfInterest { get; set; }
Property Value
System.Object
RoleArn
The ARN of the IAM role that allows access to the stream processor.
public virtual string RoleArn { get; set; }
Property Value
System.String
S3Destination
The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
public virtual object S3Destination { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A set of tags (key-value pairs) that you want to attach to the stream processor.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>