AWS Native v0.55.0, Mar 28 23

aws-native.rekognition.StreamProcessor

The AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.

Create StreamProcessor Resource

new StreamProcessor(name: string, args: StreamProcessorArgs, opts?: CustomResourceOptions);

@overload
def StreamProcessor(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bounding_box_regions_of_interest: Optional[Sequence[StreamProcessorBoundingBoxArgs]] = None,
                    connected_home_settings: Optional[StreamProcessorConnectedHomeSettingsArgs] = None,
                    data_sharing_preference: Optional[StreamProcessorDataSharingPreferenceArgs] = None,
                    face_search_settings: Optional[StreamProcessorFaceSearchSettingsArgs] = None,
                    kinesis_data_stream: Optional[StreamProcessorKinesisDataStreamArgs] = None,
                    kinesis_video_stream: Optional[StreamProcessorKinesisVideoStreamArgs] = None,
                    kms_key_id: Optional[str] = None,
                    name: Optional[str] = None,
                    notification_channel: Optional[StreamProcessorNotificationChannelArgs] = None,
                    polygon_regions_of_interest: Optional[Sequence[Sequence[StreamProcessorPointArgs]]] = None,
                    role_arn: Optional[str] = None,
                    s3_destination: Optional[StreamProcessorS3DestinationArgs] = None,
                    tags: Optional[Sequence[StreamProcessorTagArgs]] = None)
@overload
def StreamProcessor(resource_name: str,
                    args: StreamProcessorArgs,
                    opts: Optional[ResourceOptions] = None)

func NewStreamProcessor(ctx *Context, name string, args StreamProcessorArgs, opts ...ResourceOption) (*StreamProcessor, error)

public StreamProcessor(string name, StreamProcessorArgs args, CustomResourceOptions? opts = null)

public StreamProcessor(String name, StreamProcessorArgs args)
public StreamProcessor(String name, StreamProcessorArgs args, CustomResourceOptions options)

type: aws-native:rekognition:StreamProcessor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StreamProcessorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args StreamProcessorArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args StreamProcessorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StreamProcessorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StreamProcessorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

StreamProcessor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The StreamProcessor resource accepts the following input properties:

KinesisVideoStream Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorKinesisVideoStreamArgs
RoleArn string: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
BoundingBoxRegionsOfInterest List<Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorBoundingBoxArgs>: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
ConnectedHomeSettings Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorConnectedHomeSettingsArgs
DataSharingPreference Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorDataSharingPreferenceArgs
FaceSearchSettings Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorFaceSearchSettingsArgs
KinesisDataStream Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorKinesisDataStreamArgs
KmsKeyId string: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
Name string: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
NotificationChannel Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorNotificationChannelArgs
PolygonRegionsOfInterest List<ImmutableArray<Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorPointArgs>>: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
S3Destination Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorS3DestinationArgs
Tags List<Pulumi.AwsNative.Rekognition.Inputs.StreamProcessorTagArgs>: An array of key-value pairs to apply to this resource.

KinesisVideoStream StreamProcessorKinesisVideoStreamArgs
RoleArn string: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
BoundingBoxRegionsOfInterest []StreamProcessorBoundingBoxArgs: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
ConnectedHomeSettings StreamProcessorConnectedHomeSettingsArgs
DataSharingPreference StreamProcessorDataSharingPreferenceArgs
FaceSearchSettings StreamProcessorFaceSearchSettingsArgs
KinesisDataStream StreamProcessorKinesisDataStreamArgs
KmsKeyId string: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
Name string: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
NotificationChannel StreamProcessorNotificationChannelArgs
PolygonRegionsOfInterest [][]StreamProcessorPointArgs: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
S3Destination StreamProcessorS3DestinationArgs
Tags []StreamProcessorTagArgs: An array of key-value pairs to apply to this resource.

kinesisVideoStream StreamProcessorKinesisVideoStreamArgs
roleArn String: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
boundingBoxRegionsOfInterest List<StreamProcessorBoundingBoxArgs>: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
connectedHomeSettings StreamProcessorConnectedHomeSettingsArgs
dataSharingPreference StreamProcessorDataSharingPreferenceArgs
faceSearchSettings StreamProcessorFaceSearchSettingsArgs
kinesisDataStream StreamProcessorKinesisDataStreamArgs
kmsKeyId String: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
name String: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
notificationChannel StreamProcessorNotificationChannelArgs
polygonRegionsOfInterest List<List<StreamProcessorPointArgs>>: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
s3Destination StreamProcessorS3DestinationArgs
tags List<StreamProcessorTagArgs>: An array of key-value pairs to apply to this resource.

kinesisVideoStream StreamProcessorKinesisVideoStreamArgs
roleArn string: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
boundingBoxRegionsOfInterest StreamProcessorBoundingBoxArgs[]: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
connectedHomeSettings StreamProcessorConnectedHomeSettingsArgs
dataSharingPreference StreamProcessorDataSharingPreferenceArgs
faceSearchSettings StreamProcessorFaceSearchSettingsArgs
kinesisDataStream StreamProcessorKinesisDataStreamArgs
kmsKeyId string: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
name string: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
notificationChannel StreamProcessorNotificationChannelArgs
polygonRegionsOfInterest StreamProcessorPointArgs[][]: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
s3Destination StreamProcessorS3DestinationArgs
tags StreamProcessorTagArgs[]: An array of key-value pairs to apply to this resource.

kinesis_video_stream StreamProcessorKinesisVideoStreamArgs
role_arn str: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
bounding_box_regions_of_interest Sequence[StreamProcessorBoundingBoxArgs]: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
connected_home_settings StreamProcessorConnectedHomeSettingsArgs
data_sharing_preference StreamProcessorDataSharingPreferenceArgs
face_search_settings StreamProcessorFaceSearchSettingsArgs
kinesis_data_stream StreamProcessorKinesisDataStreamArgs
kms_key_id str: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
name str: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
notification_channel StreamProcessorNotificationChannelArgs
polygon_regions_of_interest Sequence[Sequence[StreamProcessorPointArgs]]: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
s3_destination StreamProcessorS3DestinationArgs
tags Sequence[StreamProcessorTagArgs]: An array of key-value pairs to apply to this resource.

kinesisVideoStream Property Map
roleArn String: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
boundingBoxRegionsOfInterest List<Property Map>: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
connectedHomeSettings Property Map
dataSharingPreference Property Map
faceSearchSettings Property Map
kinesisDataStream Property Map
kmsKeyId String: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
name String: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
notificationChannel Property Map
polygonRegionsOfInterest List<List<Property Map>>: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
s3Destination Property Map
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the StreamProcessor resource produces the following output properties:

Arn string
Id string: The provider-assigned unique ID for this managed resource.
Status string: Current status of the stream processor.
StatusMessage string: Detailed status message about the stream processor.

Arn string
Id string: The provider-assigned unique ID for this managed resource.
Status string: Current status of the stream processor.
StatusMessage string: Detailed status message about the stream processor.

arn String
id String: The provider-assigned unique ID for this managed resource.
status String: Current status of the stream processor.
statusMessage String: Detailed status message about the stream processor.

arn string
id string: The provider-assigned unique ID for this managed resource.
status string: Current status of the stream processor.
statusMessage string: Detailed status message about the stream processor.

arn str
id str: The provider-assigned unique ID for this managed resource.
status str: Current status of the stream processor.
status_message str: Detailed status message about the stream processor.

arn String
id String: The provider-assigned unique ID for this managed resource.
status String: Current status of the stream processor.
statusMessage String: Detailed status message about the stream processor.

Supporting Types

StreamProcessorBoundingBox

Height double
Left double
Top double
Width double

Height float64
Left float64
Top float64
Width float64

height Double
left Double
top Double
width Double

height number
left number
top number
width number

height float
left float
top float
width float

height Number
left Number
top Number
width Number

StreamProcessorConnectedHomeSettings

Labels List<string>
MinConfidence double: Minimum object class match confidence score that must be met to return a result for a recognized object.

Labels []string
MinConfidence float64: Minimum object class match confidence score that must be met to return a result for a recognized object.

labels List<String>
minConfidence Double: Minimum object class match confidence score that must be met to return a result for a recognized object.

labels string[]
minConfidence number: Minimum object class match confidence score that must be met to return a result for a recognized object.

labels Sequence[str]
min_confidence float: Minimum object class match confidence score that must be met to return a result for a recognized object.

labels List<String>
minConfidence Number: Minimum object class match confidence score that must be met to return a result for a recognized object.

StreamProcessorDataSharingPreference

OptIn bool: Flag to enable data-sharing

OptIn bool: Flag to enable data-sharing

optIn Boolean: Flag to enable data-sharing

optIn boolean: Flag to enable data-sharing

opt_in bool: Flag to enable data-sharing

optIn Boolean: Flag to enable data-sharing

StreamProcessorFaceSearchSettings

CollectionId string: The ID of a collection that contains faces that you want to search for.
FaceMatchThreshold double: Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

CollectionId string: The ID of a collection that contains faces that you want to search for.
FaceMatchThreshold float64: Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

collectionId String: The ID of a collection that contains faces that you want to search for.
faceMatchThreshold Double: Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

collectionId string: The ID of a collection that contains faces that you want to search for.
faceMatchThreshold number: Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

collection_id str: The ID of a collection that contains faces that you want to search for.
face_match_threshold float: Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

collectionId String: The ID of a collection that contains faces that you want to search for.
faceMatchThreshold Number: Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

StreamProcessorKinesisDataStream

Arn string: ARN of the Kinesis Data Stream stream.

Arn string: ARN of the Kinesis Data Stream stream.

arn String: ARN of the Kinesis Data Stream stream.

arn string: ARN of the Kinesis Data Stream stream.

arn str: ARN of the Kinesis Data Stream stream.

arn String: ARN of the Kinesis Data Stream stream.

StreamProcessorKinesisVideoStream

Arn string: ARN of the Kinesis Video Stream that streams the source video.

Arn string: ARN of the Kinesis Video Stream that streams the source video.

arn String: ARN of the Kinesis Video Stream that streams the source video.

arn string: ARN of the Kinesis Video Stream that streams the source video.

arn str: ARN of the Kinesis Video Stream that streams the source video.

arn String: ARN of the Kinesis Video Stream that streams the source video.

StreamProcessorNotificationChannel

Arn string: ARN of the SNS topic.

Arn string: ARN of the SNS topic.

arn String: ARN of the SNS topic.

arn string: ARN of the SNS topic.

arn str: ARN of the SNS topic.

arn String: ARN of the SNS topic.

StreamProcessorPoint

X double: The X coordinate of the point.
Y double: The Y coordinate of the point.

X float64: The X coordinate of the point.
Y float64: The Y coordinate of the point.

x Double: The X coordinate of the point.
y Double: The Y coordinate of the point.

x number: The X coordinate of the point.
y number: The Y coordinate of the point.

x float: The X coordinate of the point.
y float: The Y coordinate of the point.

x Number: The X coordinate of the point.
y Number: The Y coordinate of the point.

StreamProcessorS3Destination

BucketName string: Name of the S3 bucket.
ObjectKeyPrefix string: The object key prefix path where the results will be stored. Default is no prefix path

BucketName string: Name of the S3 bucket.
ObjectKeyPrefix string: The object key prefix path where the results will be stored. Default is no prefix path

bucketName String: Name of the S3 bucket.
objectKeyPrefix String: The object key prefix path where the results will be stored. Default is no prefix path

bucketName string: Name of the S3 bucket.
objectKeyPrefix string: The object key prefix path where the results will be stored. Default is no prefix path

bucket_name str: Name of the S3 bucket.
object_key_prefix str: The object key prefix path where the results will be stored. Default is no prefix path

bucketName String: Name of the S3 bucket.
objectKeyPrefix String: The object key prefix path where the results will be stored. Default is no prefix path

StreamProcessorTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0