Class CfnStreamProcessorMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.rekognition.CfnStreamProcessorMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStreamProcessorMixinProps>
- Enclosing interface:
CfnStreamProcessorMixinProps
@Stability(Stable)
public static final class CfnStreamProcessorMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStreamProcessorMixinProps>
A builder for
CfnStreamProcessorMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboundingBoxRegionsOfInterest(List<? extends Object> boundingBoxRegionsOfInterest) Sets the value ofCfnStreamProcessorMixinProps.getBoundingBoxRegionsOfInterest()boundingBoxRegionsOfInterest(IResolvable boundingBoxRegionsOfInterest) Sets the value ofCfnStreamProcessorMixinProps.getBoundingBoxRegionsOfInterest()build()Builds the configured instance.connectedHomeSettings(CfnStreamProcessorPropsMixin.ConnectedHomeSettingsProperty connectedHomeSettings) Sets the value ofCfnStreamProcessorMixinProps.getConnectedHomeSettings()connectedHomeSettings(IResolvable connectedHomeSettings) Sets the value ofCfnStreamProcessorMixinProps.getConnectedHomeSettings()dataSharingPreference(CfnStreamProcessorPropsMixin.DataSharingPreferenceProperty dataSharingPreference) Sets the value ofCfnStreamProcessorMixinProps.getDataSharingPreference()dataSharingPreference(IResolvable dataSharingPreference) Sets the value ofCfnStreamProcessorMixinProps.getDataSharingPreference()faceSearchSettings(CfnStreamProcessorPropsMixin.FaceSearchSettingsProperty faceSearchSettings) Sets the value ofCfnStreamProcessorMixinProps.getFaceSearchSettings()faceSearchSettings(IResolvable faceSearchSettings) Sets the value ofCfnStreamProcessorMixinProps.getFaceSearchSettings()kinesisDataStream(CfnStreamProcessorPropsMixin.KinesisDataStreamProperty kinesisDataStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisDataStream()kinesisDataStream(IResolvable kinesisDataStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisDataStream()kinesisVideoStream(CfnStreamProcessorPropsMixin.KinesisVideoStreamProperty kinesisVideoStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisVideoStream()kinesisVideoStream(IResolvable kinesisVideoStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisVideoStream()Sets the value ofCfnStreamProcessorMixinProps.getKmsKeyId()Sets the value ofCfnStreamProcessorMixinProps.getName()notificationChannel(CfnStreamProcessorPropsMixin.NotificationChannelProperty notificationChannel) Sets the value ofCfnStreamProcessorMixinProps.getNotificationChannel()notificationChannel(IResolvable notificationChannel) Sets the value ofCfnStreamProcessorMixinProps.getNotificationChannel()polygonRegionsOfInterest(Object polygonRegionsOfInterest) Sets the value ofCfnStreamProcessorMixinProps.getPolygonRegionsOfInterest()Sets the value ofCfnStreamProcessorMixinProps.getRoleArn()s3Destination(CfnStreamProcessorPropsMixin.S3DestinationProperty s3Destination) Sets the value ofCfnStreamProcessorMixinProps.getS3Destination()s3Destination(IResolvable s3Destination) Sets the value ofCfnStreamProcessorMixinProps.getS3Destination()Sets the value ofCfnStreamProcessorMixinProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
boundingBoxRegionsOfInterest
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder boundingBoxRegionsOfInterest(IResolvable boundingBoxRegionsOfInterest) Sets the value ofCfnStreamProcessorMixinProps.getBoundingBoxRegionsOfInterest()- Parameters:
boundingBoxRegionsOfInterest- List of BoundingBox objects, each of which denotes a region of interest on screen. For more information, see the BoundingBox field of RegionOfInterest .- Returns:
this
-
boundingBoxRegionsOfInterest
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder boundingBoxRegionsOfInterest(List<? extends Object> boundingBoxRegionsOfInterest) Sets the value ofCfnStreamProcessorMixinProps.getBoundingBoxRegionsOfInterest()- Parameters:
boundingBoxRegionsOfInterest- List of BoundingBox objects, each of which denotes a region of interest on screen. For more information, see the BoundingBox field of RegionOfInterest .- Returns:
this
-
connectedHomeSettings
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder connectedHomeSettings(IResolvable connectedHomeSettings) Sets the value ofCfnStreamProcessorMixinProps.getConnectedHomeSettings()- Parameters:
connectedHomeSettings- 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:
this
-
connectedHomeSettings
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder connectedHomeSettings(CfnStreamProcessorPropsMixin.ConnectedHomeSettingsProperty connectedHomeSettings) Sets the value ofCfnStreamProcessorMixinProps.getConnectedHomeSettings()- Parameters:
connectedHomeSettings- 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:
this
-
dataSharingPreference
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder dataSharingPreference(IResolvable dataSharingPreference) Sets the value ofCfnStreamProcessorMixinProps.getDataSharingPreference()- Parameters:
dataSharingPreference- 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:
this
-
dataSharingPreference
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder dataSharingPreference(CfnStreamProcessorPropsMixin.DataSharingPreferenceProperty dataSharingPreference) Sets the value ofCfnStreamProcessorMixinProps.getDataSharingPreference()- Parameters:
dataSharingPreference- 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:
this
-
faceSearchSettings
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder faceSearchSettings(IResolvable faceSearchSettings) Sets the value ofCfnStreamProcessorMixinProps.getFaceSearchSettings()- Parameters:
faceSearchSettings- 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:
this
-
faceSearchSettings
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder faceSearchSettings(CfnStreamProcessorPropsMixin.FaceSearchSettingsProperty faceSearchSettings) Sets the value ofCfnStreamProcessorMixinProps.getFaceSearchSettings()- Parameters:
faceSearchSettings- 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:
this
-
kinesisDataStream
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder kinesisDataStream(IResolvable kinesisDataStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisDataStream()- Parameters:
kinesisDataStream- 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:
this
-
kinesisDataStream
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder kinesisDataStream(CfnStreamProcessorPropsMixin.KinesisDataStreamProperty kinesisDataStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisDataStream()- Parameters:
kinesisDataStream- 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:
this
-
kinesisVideoStream
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder kinesisVideoStream(IResolvable kinesisVideoStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisVideoStream()- Parameters:
kinesisVideoStream- 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:
this
-
kinesisVideoStream
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder kinesisVideoStream(CfnStreamProcessorPropsMixin.KinesisVideoStreamProperty kinesisVideoStream) Sets the value ofCfnStreamProcessorMixinProps.getKinesisVideoStream()- Parameters:
kinesisVideoStream- 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:
this
-
kmsKeyId
Sets the value ofCfnStreamProcessorMixinProps.getKmsKeyId()- Parameters:
kmsKeyId- 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 .- Returns:
this
-
name
Sets the value ofCfnStreamProcessorMixinProps.getName()- Parameters:
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.- Returns:
this
-
notificationChannel
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder notificationChannel(IResolvable notificationChannel) Sets the value ofCfnStreamProcessorMixinProps.getNotificationChannel()- Parameters:
notificationChannel- 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:
this
-
notificationChannel
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder notificationChannel(CfnStreamProcessorPropsMixin.NotificationChannelProperty notificationChannel) Sets the value ofCfnStreamProcessorMixinProps.getNotificationChannel()- Parameters:
notificationChannel- 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:
this
-
polygonRegionsOfInterest
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder polygonRegionsOfInterest(Object polygonRegionsOfInterest) Sets the value ofCfnStreamProcessorMixinProps.getPolygonRegionsOfInterest()- Parameters:
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 .- Returns:
this
-
roleArn
Sets the value ofCfnStreamProcessorMixinProps.getRoleArn()- Parameters:
roleArn- 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 .- Returns:
this
-
s3Destination
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder s3Destination(IResolvable s3Destination) Sets the value ofCfnStreamProcessorMixinProps.getS3Destination()- Parameters:
s3Destination- 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:
this
-
s3Destination
@Stability(Stable) public CfnStreamProcessorMixinProps.Builder s3Destination(CfnStreamProcessorPropsMixin.S3DestinationProperty s3Destination) Sets the value ofCfnStreamProcessorMixinProps.getS3Destination()- Parameters:
s3Destination- 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:
this
-
tags
Sets the value ofCfnStreamProcessorMixinProps.getTags()- Parameters:
tags- 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 .- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnStreamProcessorMixinProps>- Returns:
- a new instance of
CfnStreamProcessorMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-