Class: AWSCDK::Rekognition::CfnStreamProcessor::ConnectedHomeSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Rekognition::CfnStreamProcessor::ConnectedHomeSettingsProperty

Defined in:

rekognition/cfn_stream_processor.rb

Overview

Connected home settings to use on a streaming video.

Defining the settings is required in the request parameter for CreateStreamProcessor . Including this setting in the CreateStreamProcessor request lets you use the stream processor for connected home features. You can then 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 example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected. An end-of-session summary is also published. For more information, see the ConnectedHome section of StreamProcessorSettings .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html

Instance Attribute Summary

• #labels ⇒ Array<String> readonly

  Specifies what you want to detect in the video, such as people, packages, or pets.

• #min_confidence ⇒ Numeric^? readonly

  The minimum confidence required to label an object in the video.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(labels:, min_confidence: nil) ⇒ ConnectedHomeSettingsProperty constructor

  A new instance of ConnectedHomeSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(labels:, min_confidence: nil) ⇒ ConnectedHomeSettingsProperty

Returns a new instance of ConnectedHomeSettingsProperty.

Parameters:

• labels (Array<String>) —

  Specifies what you want to detect in the video, such as people, packages, or pets.

• min_confidence (Numeric, nil) (defaults to: nil) —

  The minimum confidence required to label an object in the video.

# File 'rekognition/cfn_stream_processor.rb', line 782

def initialize(labels:, min_confidence: nil)
  @labels = labels
  Jsii::Type.check_type(@labels, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "labels")
  @min_confidence = min_confidence
  Jsii::Type.check_type(@min_confidence, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minConfidence") unless @min_confidence.nil?
end

Instance Attribute Details

#labels ⇒ Array<String> (readonly)

Specifies what you want to detect in the video, such as people, packages, or pets.

The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

Returns:

• (Array<String>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html#cfn-rekognition-streamprocessor-connectedhomesettings-labels

# File 'rekognition/cfn_stream_processor.rb', line 795

def labels
  @labels
end

#min_confidence ⇒ Numeric^? (readonly)

The minimum confidence required to label an object in the video.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html#cfn-rekognition-streamprocessor-connectedhomesettings-minconfidence

# File 'rekognition/cfn_stream_processor.rb', line 800

def min_confidence
  @min_confidence
end

Class Method Details

.jsii_properties ⇒ Object

# File 'rekognition/cfn_stream_processor.rb', line 802

def self.jsii_properties
  {
    :labels => "labels",
    :min_confidence => "minConfidence",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'rekognition/cfn_stream_processor.rb', line 809

def to_jsii
  result = {}
  result.merge!({
    "labels" => @labels,
    "minConfidence" => @min_confidence,
  })
  result.compact
end