Package software.amazon.awscdk.services.rekognition

Class CfnStreamProcessorProps.Builder

java.lang.Object

software.amazon.awscdk.services.rekognition.CfnStreamProcessorProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStreamProcessorProps>

Enclosing interface:

CfnStreamProcessorProps

@Stability(Stable)
public static final class CfnStreamProcessorProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStreamProcessorProps>

A builder for CfnStreamProcessorProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStreamProcessorProps.Builder	boundingBoxRegionsOfInterest(List<? extends Object> boundingBoxRegionsOfInterest)	Sets the value of CfnStreamProcessorProps.getBoundingBoxRegionsOfInterest()
CfnStreamProcessorProps.Builder	boundingBoxRegionsOfInterest(IResolvable boundingBoxRegionsOfInterest)	Sets the value of CfnStreamProcessorProps.getBoundingBoxRegionsOfInterest()
CfnStreamProcessorProps	build()	Builds the configured instance.
CfnStreamProcessorProps.Builder	connectedHomeSettings(IResolvable connectedHomeSettings)	Sets the value of CfnStreamProcessorProps.getConnectedHomeSettings()
CfnStreamProcessorProps.Builder	connectedHomeSettings(CfnStreamProcessor.ConnectedHomeSettingsProperty connectedHomeSettings)	Sets the value of CfnStreamProcessorProps.getConnectedHomeSettings()
CfnStreamProcessorProps.Builder	dataSharingPreference(IResolvable dataSharingPreference)	Sets the value of CfnStreamProcessorProps.getDataSharingPreference()
CfnStreamProcessorProps.Builder	dataSharingPreference(CfnStreamProcessor.DataSharingPreferenceProperty dataSharingPreference)	Sets the value of CfnStreamProcessorProps.getDataSharingPreference()
CfnStreamProcessorProps.Builder	faceSearchSettings(IResolvable faceSearchSettings)	Sets the value of CfnStreamProcessorProps.getFaceSearchSettings()
CfnStreamProcessorProps.Builder	faceSearchSettings(CfnStreamProcessor.FaceSearchSettingsProperty faceSearchSettings)	Sets the value of CfnStreamProcessorProps.getFaceSearchSettings()
CfnStreamProcessorProps.Builder	kinesisDataStream(IResolvable kinesisDataStream)	Sets the value of CfnStreamProcessorProps.getKinesisDataStream()
CfnStreamProcessorProps.Builder	kinesisDataStream(CfnStreamProcessor.KinesisDataStreamProperty kinesisDataStream)	Sets the value of CfnStreamProcessorProps.getKinesisDataStream()
CfnStreamProcessorProps.Builder	kinesisVideoStream(IResolvable kinesisVideoStream)	Sets the value of CfnStreamProcessorProps.getKinesisVideoStream()
CfnStreamProcessorProps.Builder	kinesisVideoStream(CfnStreamProcessor.KinesisVideoStreamProperty kinesisVideoStream)	Sets the value of CfnStreamProcessorProps.getKinesisVideoStream()
CfnStreamProcessorProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnStreamProcessorProps.getKmsKeyId()
CfnStreamProcessorProps.Builder	name(String name)	Sets the value of CfnStreamProcessorProps.getName()
CfnStreamProcessorProps.Builder	notificationChannel(IResolvable notificationChannel)	Sets the value of CfnStreamProcessorProps.getNotificationChannel()
CfnStreamProcessorProps.Builder	notificationChannel(CfnStreamProcessor.NotificationChannelProperty notificationChannel)	Sets the value of CfnStreamProcessorProps.getNotificationChannel()
CfnStreamProcessorProps.Builder	polygonRegionsOfInterest(Object polygonRegionsOfInterest)	Sets the value of CfnStreamProcessorProps.getPolygonRegionsOfInterest()
CfnStreamProcessorProps.Builder	roleArn(String roleArn)	Sets the value of CfnStreamProcessorProps.getRoleArn()
CfnStreamProcessorProps.Builder	s3Destination(IResolvable s3Destination)	Sets the value of CfnStreamProcessorProps.getS3Destination()
CfnStreamProcessorProps.Builder	s3Destination(CfnStreamProcessor.S3DestinationProperty s3Destination)	Sets the value of CfnStreamProcessorProps.getS3Destination()
CfnStreamProcessorProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnStreamProcessorProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

kinesisVideoStream

@Stability(Stable)
public CfnStreamProcessorProps.Builder kinesisVideoStream(CfnStreamProcessor.KinesisVideoStreamProperty kinesisVideoStream)

Sets the value of CfnStreamProcessorProps.getKinesisVideoStream()

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. For more information, see KinesisVideoStream .

Returns:

this

kinesisVideoStream

@Stability(Stable)
public CfnStreamProcessorProps.Builder kinesisVideoStream(IResolvable kinesisVideoStream)

Sets the value of CfnStreamProcessorProps.getKinesisVideoStream()

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. For more information, see KinesisVideoStream .

Returns:

this

roleArn

@Stability(Stable)
public CfnStreamProcessorProps.Builder roleArn(String roleArn)

Sets the value of CfnStreamProcessorProps.getRoleArn()

Parameters:

roleArn - The ARN of the IAM role that allows access to the stream processor. This parameter is required. 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

boundingBoxRegionsOfInterest

@Stability(Stable)
public CfnStreamProcessorProps.Builder boundingBoxRegionsOfInterest(IResolvable boundingBoxRegionsOfInterest)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder boundingBoxRegionsOfInterest(List<? extends Object> boundingBoxRegionsOfInterest)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder connectedHomeSettings(IResolvable connectedHomeSettings)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder connectedHomeSettings(CfnStreamProcessor.ConnectedHomeSettingsProperty connectedHomeSettings)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder dataSharingPreference(IResolvable dataSharingPreference)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder dataSharingPreference(CfnStreamProcessor.DataSharingPreferenceProperty dataSharingPreference)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder faceSearchSettings(IResolvable faceSearchSettings)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder faceSearchSettings(CfnStreamProcessor.FaceSearchSettingsProperty faceSearchSettings)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder kinesisDataStream(IResolvable kinesisDataStream)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder kinesisDataStream(CfnStreamProcessor.KinesisDataStreamProperty kinesisDataStream)

Sets the value of CfnStreamProcessorProps.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

kmsKeyId

@Stability(Stable)
public CfnStreamProcessorProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnStreamProcessorProps.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

@Stability(Stable)
public CfnStreamProcessorProps.Builder name(String name)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder notificationChannel(IResolvable notificationChannel)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder notificationChannel(CfnStreamProcessor.NotificationChannelProperty notificationChannel)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder polygonRegionsOfInterest(Object polygonRegionsOfInterest)

Sets the value of CfnStreamProcessorProps.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

s3Destination

@Stability(Stable)
public CfnStreamProcessorProps.Builder s3Destination(IResolvable s3Destination)

Sets the value of CfnStreamProcessorProps.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 CfnStreamProcessorProps.Builder s3Destination(CfnStreamProcessor.S3DestinationProperty s3Destination)

Sets the value of CfnStreamProcessorProps.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

@Stability(Stable)
public CfnStreamProcessorProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnStreamProcessorProps.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

@Stability(Stable)
public CfnStreamProcessorProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnStreamProcessorProps>

Returns:

a new instance of CfnStreamProcessorProps

Throws:

NullPointerException - if any required attribute was not provided