Package software.amazon.awscdk.services.rekognition

Interface CfnStreamProcessorProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnStreamProcessorProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.943Z") @Stability(Stable) public interface CfnStreamProcessorProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnStreamProcessor.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rekognition.*;
 Object polygonRegionsOfInterest;
 CfnStreamProcessorProps cfnStreamProcessorProps = CfnStreamProcessorProps.builder()
         .kinesisVideoStream(KinesisVideoStreamProperty.builder()
                 .arn("arn")
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .boundingBoxRegionsOfInterest(List.of(BoundingBoxProperty.builder()
                 .height(123)
                 .left(123)
                 .top(123)
                 .width(123)
                 .build()))
         .connectedHomeSettings(ConnectedHomeSettingsProperty.builder()
                 .labels(List.of("labels"))
                 // the properties below are optional
                 .minConfidence(123)
                 .build())
         .dataSharingPreference(DataSharingPreferenceProperty.builder()
                 .optIn(false)
                 .build())
         .faceSearchSettings(FaceSearchSettingsProperty.builder()
                 .collectionId("collectionId")
                 // the properties below are optional
                 .faceMatchThreshold(123)
                 .build())
         .kinesisDataStream(KinesisDataStreamProperty.builder()
                 .arn("arn")
                 .build())
         .kmsKeyId("kmsKeyId")
         .name("name")
         .notificationChannel(NotificationChannelProperty.builder()
                 .arn("arn")
                 .build())
         .polygonRegionsOfInterest(polygonRegionsOfInterest)
         .s3Destination(S3DestinationProperty.builder()
                 .bucketName("bucketName")
                 // the properties below are optional
                 .objectKeyPrefix("objectKeyPrefix")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getKinesisVideoStream

      @Stability(Stable) @NotNull Object 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 .

    • getRoleArn

      @Stability(Stable) @NotNull String 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 .

    • getBoundingBoxRegionsOfInterest

      @Stability(Stable) @Nullable default Object getBoundingBoxRegionsOfInterest()
      List of BoundingBox objects, each of which denotes a region of interest on screen.

      For more information, see the BoundingBox field of RegionOfInterest .

    • getConnectedHomeSettings

      @Stability(Stable) @Nullable default Object 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 .

    • getDataSharingPreference

      @Stability(Stable) @Nullable default Object 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 .

    • getFaceSearchSettings

      @Stability(Stable) @Nullable default Object 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 .

    • getKinesisDataStream

      @Stability(Stable) @Nullable default Object 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 .

    • getKmsKeyId

      @Stability(Stable) @Nullable default String 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 .

    • getName

      @Stability(Stable) @Nullable default String 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.

    • getNotificationChannel

      @Stability(Stable) @Nullable default Object 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 .

    • getPolygonRegionsOfInterest

      @Stability(Stable) @Nullable default Object 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 .

    • getS3Destination

      @Stability(Stable) @Nullable default Object 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 .

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> 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 .

    • builder

      @Stability(Stable) static CfnStreamProcessorProps.Builder builder()
      Returns:
      a CfnStreamProcessorProps.Builder of CfnStreamProcessorProps