CfnStreamProcessor (software.amazon.awscdk:monocdk 1.180.0.DEVPREVIEW API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.core.Construct
    - - software.amazon.awscdk.core.CfnElement
      - software.amazon.awscdk.core.CfnRefElement
        
        software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.rekognition.CfnStreamProcessor

All Implemented Interfaces:: IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:54.857Z")
 @Stability(value=Stable)
public class CfnStreamProcessor
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Rekognition::StreamProcessor`.

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. 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 .

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.*;
 CfnStreamProcessor cfnStreamProcessor = CfnStreamProcessor.Builder.create(this, "MyCfnStreamProcessor")
         .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(List.of(PolygonProperty.builder()
                 .polygon(List.of(PointProperty.builder()
                         .x(123)
                         .y(123)
                         .build()))
                 .build()))
         .s3Destination(S3DestinationProperty.builder()
                 .bucketName("bucketName")
                 // the properties below are optional
                 .objectKeyPrefix("objectKeyPrefix")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnStreamProcessor.BoundingBoxProperty` Identifies the bounding box around the label, face, text, or personal protective equipment.
`static class`	`CfnStreamProcessor.Builder` A fluent builder for `CfnStreamProcessor`.
`static interface`	`CfnStreamProcessor.ConnectedHomeSettingsProperty` Connected home settings to use on a streaming video.
`static interface`	`CfnStreamProcessor.DataSharingPreferenceProperty` Allows you to opt in or opt out to share data with Rekognition to improve model performance.
`static interface`	`CfnStreamProcessor.FaceSearchSettingsProperty` The input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.
`static interface`	`CfnStreamProcessor.KinesisDataStreamProperty` Amazon Rekognition Video Stream Processor take as input a Kinesis video stream (Input) and a Kinesis data stream (Output).
`static interface`	`CfnStreamProcessor.KinesisVideoStreamProperty` The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
`static interface`	`CfnStreamProcessor.NotificationChannelProperty` The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
`static interface`	`CfnStreamProcessor.PointProperty` The X and Y coordinates of a point on an image or video frame.
`static interface`	`CfnStreamProcessor.PolygonProperty` Example:
`static interface`	`CfnStreamProcessor.S3DestinationProperty` The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnStreamProcessor(Construct scope, String id, CfnStreamProcessorProps props)` Create a new `AWS::Rekognition::StreamProcessor`.
`protected`	`CfnStreamProcessor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnStreamProcessor(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrArn()` Amazon Resource Name for the newly created stream processor.
`String`	`getAttrStatus()` Current status of the Amazon Rekognition stream processor.
`String`	`getAttrStatusMessage()` Detailed status message about the stream processor.
`Object`	`getBoundingBoxRegionsOfInterest()` List of BoundingBox objects, each of which denotes a region of interest on screen.
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getConnectedHomeSettings()` Connected home settings to use on a streaming video.
`Object`	`getDataSharingPreference()` Allows you to opt in or opt out to share data with Rekognition to improve model performance.
`Object`	`getFaceSearchSettings()` The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.
`Object`	`getKinesisDataStream()` Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.
`Object`	`getKinesisVideoStream()` The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
`String`	`getKmsKeyId()` The identifier for your Amazon Key Management Service key (Amazon KMS key).
`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](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor) .
`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.
`Object`	`getPolygonRegionsOfInterest()` A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects.
`String`	`getRoleArn()` The ARN of the IAM role that allows access to the stream processor.
`Object`	`getS3Destination()` The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
`TagManager`	`getTags()` A set of tags (key-value pairs) that you want to attach to the stream processor.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setBoundingBoxRegionsOfInterest(IResolvable value)` List of BoundingBox objects, each of which denotes a region of interest on screen.
`void`	`setBoundingBoxRegionsOfInterest(List<Object> value)` List of BoundingBox objects, each of which denotes a region of interest on screen.
`void`	`setConnectedHomeSettings(CfnStreamProcessor.ConnectedHomeSettingsProperty value)` Connected home settings to use on a streaming video.
`void`	`setConnectedHomeSettings(IResolvable value)` Connected home settings to use on a streaming video.
`void`	`setDataSharingPreference(CfnStreamProcessor.DataSharingPreferenceProperty value)` Allows you to opt in or opt out to share data with Rekognition to improve model performance.
`void`	`setDataSharingPreference(IResolvable value)` Allows you to opt in or opt out to share data with Rekognition to improve model performance.
`void`	`setFaceSearchSettings(CfnStreamProcessor.FaceSearchSettingsProperty value)` The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.
`void`	`setFaceSearchSettings(IResolvable value)` The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.
`void`	`setKinesisDataStream(CfnStreamProcessor.KinesisDataStreamProperty value)` Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.
`void`	`setKinesisDataStream(IResolvable value)` Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.
`void`	`setKinesisVideoStream(CfnStreamProcessor.KinesisVideoStreamProperty value)` The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
`void`	`setKinesisVideoStream(IResolvable value)` The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
`void`	`setKmsKeyId(String value)` The identifier for your Amazon Key Management Service key (Amazon KMS key).
`void`	`setName(String value)` The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor) .
`void`	`setNotificationChannel(CfnStreamProcessor.NotificationChannelProperty value)` The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
`void`	`setNotificationChannel(IResolvable value)` The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
`void`	`setPolygonRegionsOfInterest(IResolvable value)` A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects.
`void`	`setPolygonRegionsOfInterest(List<Object> value)` A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects.
`void`	`setRoleArn(String value)` The ARN of the IAM role that allows access to the stream processor.
`void`	`setS3Destination(CfnStreamProcessor.S3DestinationProperty value)` The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
`void`	`setS3Destination(IResolvable value)` The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnStreamProcessor
```
protected CfnStreamProcessor(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnStreamProcessor
```
protected CfnStreamProcessor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnStreamProcessor
```
@Stability(value=Stable)
public CfnStreamProcessor(@NotNull
                                                   Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnStreamProcessorProps props)
```
    Create a new `AWS::Rekognition::StreamProcessor`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    Amazon Resource Name for the newly created stream processor.
  - getAttrStatus
```
@Stability(value=Stable)
 @NotNull
public String getAttrStatus()
```
    Current status of the Amazon Rekognition stream processor.
  - getAttrStatusMessage
```
@Stability(value=Stable)
 @NotNull
public String getAttrStatusMessage()
```
    Detailed status message about the stream processor.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager 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 .
  - getKinesisVideoStream
```
@Stability(value=Stable)
 @NotNull
public 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 .
  - setKinesisVideoStream
```
@Stability(value=Stable)
public void setKinesisVideoStream(@NotNull
                                                           CfnStreamProcessor.KinesisVideoStreamProperty value)
```
    The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.
    For more information, see KinesisVideoStream .
  - setKinesisVideoStream
```
@Stability(value=Stable)
public void setKinesisVideoStream(@NotNull
                                                           IResolvable value)
```
    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(value=Stable)
 @NotNull
public 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 .
  - setRoleArn
```
@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)
```
    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(value=Stable)
 @Nullable
public 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 .
  - setBoundingBoxRegionsOfInterest
```
@Stability(value=Stable)
public void setBoundingBoxRegionsOfInterest(@Nullable
                                                                     IResolvable value)
```
    List of BoundingBox objects, each of which denotes a region of interest on screen.
    For more information, see the BoundingBox field of RegionOfInterest .
  - setBoundingBoxRegionsOfInterest
```
@Stability(value=Stable)
public void setBoundingBoxRegionsOfInterest(@Nullable
                                                                     List<Object> value)
```
    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(value=Stable)
 @Nullable
public 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 .
  - setConnectedHomeSettings
```
@Stability(value=Stable)
public void setConnectedHomeSettings(@Nullable
                                                              CfnStreamProcessor.ConnectedHomeSettingsProperty value)
```
    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 .
  - setConnectedHomeSettings
```
@Stability(value=Stable)
public void setConnectedHomeSettings(@Nullable
                                                              IResolvable value)
```
    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(value=Stable)
 @Nullable
public 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 .
  - setDataSharingPreference
```
@Stability(value=Stable)
public void setDataSharingPreference(@Nullable
                                                              CfnStreamProcessor.DataSharingPreferenceProperty value)
```
    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 .
  - setDataSharingPreference
```
@Stability(value=Stable)
public void setDataSharingPreference(@Nullable
                                                              IResolvable value)
```
    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(value=Stable)
 @Nullable
public 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 .
  - setFaceSearchSettings
```
@Stability(value=Stable)
public void setFaceSearchSettings(@Nullable
                                                           CfnStreamProcessor.FaceSearchSettingsProperty value)
```
    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 .
  - setFaceSearchSettings
```
@Stability(value=Stable)
public void setFaceSearchSettings(@Nullable
                                                           IResolvable value)
```
    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(value=Stable)
 @Nullable
public 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 .
  - setKinesisDataStream
```
@Stability(value=Stable)
public void setKinesisDataStream(@Nullable
                                                          CfnStreamProcessor.KinesisDataStreamProperty value)
```
    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 .
  - setKinesisDataStream
```
@Stability(value=Stable)
public void setKinesisDataStream(@Nullable
                                                          IResolvable value)
```
    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(value=Stable)
 @Nullable
public 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 .
  - setKmsKeyId
```
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)
```
    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(value=Stable)
 @Nullable
public 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](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor) . If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name.
  - setName
```
@Stability(value=Stable)
public void setName(@Nullable
                                             String value)
```
    The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_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(value=Stable)
 @Nullable
public 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 .
  - setNotificationChannel
```
@Stability(value=Stable)
public void setNotificationChannel(@Nullable
                                                            CfnStreamProcessor.NotificationChannelProperty value)
```
    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 .
  - setNotificationChannel
```
@Stability(value=Stable)
public void setNotificationChannel(@Nullable
                                                            IResolvable value)
```
    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(value=Stable)
 @Nullable
public Object getPolygonRegionsOfInterest()
```
    A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_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](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest) .
  - setPolygonRegionsOfInterest
```
@Stability(value=Stable)
public void setPolygonRegionsOfInterest(@Nullable
                                                                 IResolvable value)
```
    A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_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](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest) .
  - setPolygonRegionsOfInterest
```
@Stability(value=Stable)
public void setPolygonRegionsOfInterest(@Nullable
                                                                 List<Object> value)
```
    A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_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](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest) .
  - getS3Destination
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setS3Destination
```
@Stability(value=Stable)
public void setS3Destination(@Nullable
                                                      CfnStreamProcessor.S3DestinationProperty value)
```
    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 .
  - setS3Destination
```
@Stability(value=Stable)
public void setS3Destination(@Nullable
                                                      IResolvable value)
```
    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 .

Class CfnStreamProcessor

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnStreamProcessor

CfnStreamProcessor

CfnStreamProcessor

Method Detail

inspect

renderProperties

getAttrArn

getAttrStatus

getAttrStatusMessage

getCfnProperties

getTags

getKinesisVideoStream

setKinesisVideoStream

setKinesisVideoStream

getRoleArn

setRoleArn

getBoundingBoxRegionsOfInterest

setBoundingBoxRegionsOfInterest

setBoundingBoxRegionsOfInterest

getConnectedHomeSettings

setConnectedHomeSettings

setConnectedHomeSettings

getDataSharingPreference

setDataSharingPreference

setDataSharingPreference

getFaceSearchSettings

setFaceSearchSettings

setFaceSearchSettings

getKinesisDataStream

setKinesisDataStream

setKinesisDataStream

getKmsKeyId

setKmsKeyId

getName

setName

getNotificationChannel

setNotificationChannel

setNotificationChannel

getPolygonRegionsOfInterest

setPolygonRegionsOfInterest

setPolygonRegionsOfInterest

getS3Destination

setS3Destination

setS3Destination