Interface CfnStreamProcessorMixinProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStreamProcessorMixinProps.Jsii$Proxy
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cfnpropertymixins.services.rekognition.*;
Object polygonRegionsOfInterest;
CfnStreamProcessorMixinProps cfnStreamProcessorMixinProps = CfnStreamProcessorMixinProps.builder()
.boundingBoxRegionsOfInterest(List.of(BoundingBoxProperty.builder()
.height(123)
.left(123)
.top(123)
.width(123)
.build()))
.connectedHomeSettings(ConnectedHomeSettingsProperty.builder()
.labels(List.of("labels"))
.minConfidence(123)
.build())
.dataSharingPreference(DataSharingPreferenceProperty.builder()
.optIn(false)
.build())
.faceSearchSettings(FaceSearchSettingsProperty.builder()
.collectionId("collectionId")
.faceMatchThreshold(123)
.build())
.kinesisDataStream(KinesisDataStreamProperty.builder()
.arn("arn")
.build())
.kinesisVideoStream(KinesisVideoStreamProperty.builder()
.arn("arn")
.build())
.kmsKeyId("kmsKeyId")
.name("name")
.notificationChannel(NotificationChannelProperty.builder()
.arn("arn")
.build())
.polygonRegionsOfInterest(polygonRegionsOfInterest)
.roleArn("roleArn")
.s3Destination(S3DestinationProperty.builder()
.bucketName("bucketName")
.objectKeyPrefix("objectKeyPrefix")
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnStreamProcessorMixinPropsstatic final classAn implementation forCfnStreamProcessorMixinProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectList of BoundingBox objects, each of which denotes a region of interest on screen.default ObjectConnected home settings to use on a streaming video.default ObjectAllows you to opt in or opt out to share data with Rekognition to improve model performance.default ObjectThe input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.default ObjectAmazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.default ObjectThe Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.default StringThe identifier for your Amazon Key Management Service key (Amazon KMS key).default StringgetName()The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of StreamProcessor .default ObjectThe Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.default ObjectA set of ordered lists of Point objects.default StringThe ARN of the IAM role that allows access to the stream processor.default ObjectThe Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.getTags()A set of tags (key-value pairs) that you want to attach to the stream processor.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBoundingBoxRegionsOfInterest
List of BoundingBox objects, each of which denotes a region of interest on screen.For more information, see the BoundingBox field of RegionOfInterest .
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnStreamProcessorPropsMixin.BoundingBoxProperty>- See Also:
-
getConnectedHomeSettings
Connected home settings to use on a streaming video.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 .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.ConnectedHomeSettingsProperty- See Also:
-
getDataSharingPreference
Allows you to opt in or opt out to share data with Rekognition to improve model performance.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 .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.DataSharingPreferenceProperty- See Also:
-
getFaceSearchSettings
The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.For more information regarding the contents of the parameters, see FaceSearchSettings .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.FaceSearchSettingsProperty- See Also:
-
getKinesisDataStream
Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.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 .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.KinesisDataStreamProperty- See Also:
-
getKinesisVideoStream
The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.For more information, see KinesisVideoStream .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.KinesisVideoStreamProperty- See Also:
-
getKmsKeyId
The identifier for your Amazon Key Management Service key (Amazon KMS key).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 .
- See Also:
-
getName
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.- See Also:
-
getNotificationChannel
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.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 .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.NotificationChannelProperty- See Also:
-
getPolygonRegionsOfInterest
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 .- See Also:
-
getRoleArn
The ARN of the IAM role that allows access to the stream processor.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 .
- See Also:
-
getS3Destination
The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.For more information, see the S3Destination section of StreamProcessorOutput .
Returns union: either
IResolvableorCfnStreamProcessorPropsMixin.S3DestinationProperty- See Also:
-
getTags
A set of tags (key-value pairs) that you want to attach to the stream processor.For more information, see the Tags section of CreateStreamProcessor .
- See Also:
-
builder
-