Package software.amazon.awscdk.services.rekognition

Class CfnStreamProcessor.Builder

java.lang.Object
software.amazon.awscdk.services.rekognition.CfnStreamProcessor.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStreamProcessor>
Enclosing class:
CfnStreamProcessor
@Stability(Stable) public static final class CfnStreamProcessor.Builder extends Object implements software.amazon.jsii.Builder<CfnStreamProcessor>
A fluent builder for CfnStreamProcessor.

  • Method Details

    • create

      @Stability(Stable) public static CfnStreamProcessor.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnStreamProcessor.Builder.

    • kinesisVideoStream

      @Stability(Stable) public CfnStreamProcessor.Builder kinesisVideoStream(CfnStreamProcessor.KinesisVideoStreamProperty 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 .

      Parameters:
      kinesisVideoStream - The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor. This parameter is required.
      Returns:
      this

    • kinesisVideoStream

      @Stability(Stable) public CfnStreamProcessor.Builder kinesisVideoStream(IResolvable 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 .

      Parameters:
      kinesisVideoStream - The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor. This parameter is required.
      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnStreamProcessor.Builder roleArn(String 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 .

      Parameters:
      roleArn - The ARN of the IAM role that allows access to the stream processor. This parameter is required.
      Returns:
      this

    • boundingBoxRegionsOfInterest

      @Stability(Stable) public CfnStreamProcessor.Builder boundingBoxRegionsOfInterest(IResolvable boundingBoxRegionsOfInterest)
      List of BoundingBox objects, each of which denotes a region of interest on screen.

      For more information, see the BoundingBox field of RegionOfInterest .

      Parameters:
      boundingBoxRegionsOfInterest - List of BoundingBox objects, each of which denotes a region of interest on screen. This parameter is required.
      Returns:
      this

    • boundingBoxRegionsOfInterest

      @Stability(Stable) public CfnStreamProcessor.Builder boundingBoxRegionsOfInterest(List<? extends Object> boundingBoxRegionsOfInterest)
      List of BoundingBox objects, each of which denotes a region of interest on screen.

      For more information, see the BoundingBox field of RegionOfInterest .

      Parameters:
      boundingBoxRegionsOfInterest - List of BoundingBox objects, each of which denotes a region of interest on screen. This parameter is required.
      Returns:
      this

    • connectedHomeSettings

      @Stability(Stable) public CfnStreamProcessor.Builder connectedHomeSettings(IResolvable 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 .

      Parameters:
      connectedHomeSettings - Connected home settings to use on a streaming video. This parameter is required.
      Returns:
      this

    • connectedHomeSettings

      @Stability(Stable) public CfnStreamProcessor.Builder connectedHomeSettings(CfnStreamProcessor.ConnectedHomeSettingsProperty 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 .

      Parameters:
      connectedHomeSettings - Connected home settings to use on a streaming video. This parameter is required.
      Returns:
      this

    • dataSharingPreference

      @Stability(Stable) public CfnStreamProcessor.Builder dataSharingPreference(IResolvable 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 .

      Parameters:
      dataSharingPreference - Allows you to opt in or opt out to share data with Rekognition to improve model performance. This parameter is required.
      Returns:
      this

    • dataSharingPreference

      @Stability(Stable) public CfnStreamProcessor.Builder dataSharingPreference(CfnStreamProcessor.DataSharingPreferenceProperty 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 .

      Parameters:
      dataSharingPreference - Allows you to opt in or opt out to share data with Rekognition to improve model performance. This parameter is required.
      Returns:
      this

    • faceSearchSettings

      @Stability(Stable) public CfnStreamProcessor.Builder faceSearchSettings(IResolvable 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 .

      Parameters:
      faceSearchSettings - The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor. This parameter is required.
      Returns:
      this

    • faceSearchSettings

      @Stability(Stable) public CfnStreamProcessor.Builder faceSearchSettings(CfnStreamProcessor.FaceSearchSettingsProperty 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 .

      Parameters:
      faceSearchSettings - The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor. This parameter is required.
      Returns:
      this

    • kinesisDataStream

      @Stability(Stable) public CfnStreamProcessor.Builder kinesisDataStream(IResolvable 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 .

      Parameters:
      kinesisDataStream - Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input. This parameter is required.
      Returns:
      this

    • kinesisDataStream

      @Stability(Stable) public CfnStreamProcessor.Builder kinesisDataStream(CfnStreamProcessor.KinesisDataStreamProperty 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 .

      Parameters:
      kinesisDataStream - Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input. This parameter is required.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnStreamProcessor.Builder kmsKeyId(String 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 .

      Parameters:
      kmsKeyId - The identifier for your Amazon Key Management Service key (Amazon KMS key). This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnStreamProcessor.Builder name(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.

      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. This parameter is required.
      Returns:
      this

    • notificationChannel

      @Stability(Stable) public CfnStreamProcessor.Builder notificationChannel(IResolvable 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 .

      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. This parameter is required.
      Returns:
      this

    • notificationChannel

      @Stability(Stable) public CfnStreamProcessor.Builder notificationChannel(CfnStreamProcessor.NotificationChannelProperty 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 .

      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. This parameter is required.
      Returns:
      this

    • polygonRegionsOfInterest

      @Stability(Stable) public CfnStreamProcessor.Builder polygonRegionsOfInterest(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 .

      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 . This parameter is required.
      Returns:
      this

    • s3Destination

      @Stability(Stable) public CfnStreamProcessor.Builder s3Destination(IResolvable 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 .

      Parameters:
      s3Destination - The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation. This parameter is required.
      Returns:
      this

    • s3Destination

      @Stability(Stable) public CfnStreamProcessor.Builder s3Destination(CfnStreamProcessor.S3DestinationProperty 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 .

      Parameters:
      s3Destination - The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnStreamProcessor.Builder tags(List<? extends CfnTag> 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 .

      Parameters:
      tags - A set of tags (key-value pairs) that you want to attach to the stream processor. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnStreamProcessor build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnStreamProcessor>
      Returns:
      a newly built instance of CfnStreamProcessor.