Class: AWSCDK::Rekognition::CfnStreamProcessor

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSRekognition::IStreamProcessorRef
Defined in:
rekognition/cfn_stream_processor.rb

Overview

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 .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnStreamProcessor

Create a new AWS::Rekognition::StreamProcessor.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Rekognition::CfnStreamProcessorProps) —

    Resource properties.



28
29
30
31
32
33
34
 
# File 'rekognition/cfn_stream_processor.rb', line 28

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessorProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVrb2duaXRpb24uQ2ZuU3RyZWFtUHJvY2Vzc29yUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_stream_processor(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'rekognition/cfn_stream_processor.rb', line 96

def self.arn_for_stream_processor(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZWtvZ25pdGlvbi5JU3RyZWFtUHJvY2Vzc29yUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rekognition.CfnStreamProcessor", "arnForStreamProcessor", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


203
204
205
 
# File 'rekognition/cfn_stream_processor.rb', line 203

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rekognition.CfnStreamProcessor", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_stream_processor(x) ⇒ Boolean

Checks whether the given object is a CfnStreamProcessor.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'rekognition/cfn_stream_processor.rb', line 105

def self.is_cfn_stream_processor(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rekognition.CfnStreamProcessor", "isCfnStreamProcessor", [x])
end

.jsii_overridable_methods ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'rekognition/cfn_stream_processor.rb', line 36

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_message => { kind: :property, name: "attrStatusMessage", is_optional: false },
    :stream_processor_ref => { kind: :property, name: "streamProcessorRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :kinesis_video_stream => { kind: :property, name: "kinesisVideoStream", is_optional: false },
    :polygon_regions_of_interest => { kind: :property, name: "polygonRegionsOfInterest", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :bounding_box_regions_of_interest => { kind: :property, name: "boundingBoxRegionsOfInterest", is_optional: true },
    :connected_home_settings => { kind: :property, name: "connectedHomeSettings", is_optional: true },
    :data_sharing_preference => { kind: :property, name: "dataSharingPreference", is_optional: true },
    :face_search_settings => { kind: :property, name: "faceSearchSettings", is_optional: true },
    :kinesis_data_stream => { kind: :property, name: "kinesisDataStream", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :notification_channel => { kind: :property, name: "notificationChannel", is_optional: true },
    :s3_destination => { kind: :property, name: "s3Destination", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



442
443
444
445
 
# File 'rekognition/cfn_stream_processor.rb', line 442

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



454
455
456
457
 
# File 'rekognition/cfn_stream_processor.rb', line 454

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



464
465
466
467
 
# File 'rekognition/cfn_stream_processor.rb', line 464

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



475
476
477
478
479
 
# File 'rekognition/cfn_stream_processor.rb', line 475

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


532
533
534
535
536
 
# File 'rekognition/cfn_stream_processor.rb', line 532

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



542
543
544
545
 
# File 'rekognition/cfn_stream_processor.rb', line 542

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



554
555
556
557
558
 
# File 'rekognition/cfn_stream_processor.rb', line 554

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



567
568
569
570
 
# File 'rekognition/cfn_stream_processor.rb', line 567

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



589
590
591
592
593
594
 
# File 'rekognition/cfn_stream_processor.rb', line 589

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Amazon Resource Name for the newly created stream processor.

Returns:

  • (String) 


210
211
212
 
# File 'rekognition/cfn_stream_processor.rb', line 210

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_status ⇒ String

Current status of the Amazon Rekognition stream processor.

Returns:

  • (String) 


217
218
219
 
# File 'rekognition/cfn_stream_processor.rb', line 217

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_message ⇒ String

Detailed status message about the stream processor.

Returns:

  • (String) 


224
225
226
 
# File 'rekognition/cfn_stream_processor.rb', line 224

def attr_status_message()
  jsii_get_property("attrStatusMessage")
end

#bounding_box_regions_of_interest ⇒ AWSCDK::IResolvable, ...

List of BoundingBox objects, each of which denotes a region of interest on screen.

Returns:



282
283
284
 
# File 'rekognition/cfn_stream_processor.rb', line 282

def bounding_box_regions_of_interest()
  jsii_get_property("boundingBoxRegionsOfInterest")
end

#bounding_box_regions_of_interest=(value) ⇒ Object 



286
287
288
289
 
# File 'rekognition/cfn_stream_processor.rb', line 286

def bounding_box_regions_of_interest=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVrb2duaXRpb24uQ2ZuU3RyZWFtUHJvY2Vzc29yLkJvdW5kaW5nQm94UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "boundingBoxRegionsOfInterest") unless value.nil?
  jsii_set_property("boundingBoxRegionsOfInterest", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



156
157
158
 
# File 'rekognition/cfn_stream_processor.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'rekognition/cfn_stream_processor.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


598
599
600
601
 
# File 'rekognition/cfn_stream_processor.rb', line 598

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


166
167
168
 
# File 'rekognition/cfn_stream_processor.rb', line 166

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'rekognition/cfn_stream_processor.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connected_home_settings ⇒ AWSCDK::IResolvable, ...

Connected home settings to use on a streaming video.

Returns:



294
295
296
 
# File 'rekognition/cfn_stream_processor.rb', line 294

def connected_home_settings()
  jsii_get_property("connectedHomeSettings")
end

#connected_home_settings=(value) ⇒ Object 



298
299
300
301
302
 
# File 'rekognition/cfn_stream_processor.rb', line 298

def connected_home_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::ConnectedHomeSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuQ29ubmVjdGVkSG9tZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "connectedHomeSettings") unless value.nil?
  jsii_set_property("connectedHomeSettings", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'rekognition/cfn_stream_processor.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#data_sharing_preference ⇒ AWSCDK::IResolvable, ...

Allows you to opt in or opt out to share data with Rekognition to improve model performance.

Returns:



307
308
309
 
# File 'rekognition/cfn_stream_processor.rb', line 307

def data_sharing_preference()
  jsii_get_property("dataSharingPreference")
end

#data_sharing_preference=(value) ⇒ Object 



311
312
313
314
315
 
# File 'rekognition/cfn_stream_processor.rb', line 311

def data_sharing_preference=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::DataSharingPreferenceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuRGF0YVNoYXJpbmdQcmVmZXJlbmNlUHJvcGVydHkifV19fQ==")), "dataSharingPreference") unless value.nil?
  jsii_set_property("dataSharingPreference", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'rekognition/cfn_stream_processor.rb', line 178

def env()
  jsii_get_property("env")
end

#face_search_settings ⇒ AWSCDK::IResolvable, ...

The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.

Returns:



320
321
322
 
# File 'rekognition/cfn_stream_processor.rb', line 320

def face_search_settings()
  jsii_get_property("faceSearchSettings")
end

#face_search_settings=(value) ⇒ Object 



324
325
326
327
328
 
# File 'rekognition/cfn_stream_processor.rb', line 324

def face_search_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::FaceSearchSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuRmFjZVNlYXJjaFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "faceSearchSettings") unless value.nil?
  jsii_set_property("faceSearchSettings", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



611
612
613
614
615
 
# File 'rekognition/cfn_stream_processor.rb', line 611

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



622
623
624
625
 
# File 'rekognition/cfn_stream_processor.rb', line 622

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



692
693
694
695
 
# File 'rekognition/cfn_stream_processor.rb', line 692

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kinesis_data_stream ⇒ AWSCDK::IResolvable, ...

Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input.

Returns:



333
334
335
 
# File 'rekognition/cfn_stream_processor.rb', line 333

def kinesis_data_stream()
  jsii_get_property("kinesisDataStream")
end

#kinesis_data_stream=(value) ⇒ Object 



337
338
339
340
341
 
# File 'rekognition/cfn_stream_processor.rb', line 337

def kinesis_data_stream=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::KinesisDataStreamProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuS2luZXNpc0RhdGFTdHJlYW1Qcm9wZXJ0eSJ9XX19")), "kinesisDataStream") unless value.nil?
  jsii_set_property("kinesisDataStream", value)
end

#kinesis_video_stream ⇒ AWSCDK::IResolvable, AWSCDK::Rekognition::CfnStreamProcessor::KinesisVideoStreamProperty

The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor.

Returns:



245
246
247
 
# File 'rekognition/cfn_stream_processor.rb', line 245

def kinesis_video_stream()
  jsii_get_property("kinesisVideoStream")
end

#kinesis_video_stream=(value) ⇒ Object 



249
250
251
252
253
 
# File 'rekognition/cfn_stream_processor.rb', line 249

def kinesis_video_stream=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::KinesisVideoStreamProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuS2luZXNpc1ZpZGVvU3RyZWFtUHJvcGVydHkifV19fQ==")), "kinesisVideoStream")
  jsii_set_property("kinesisVideoStream", value)
end

#kms_key_id ⇒ String?

The identifier for your Amazon Key Management Service key (Amazon KMS key).

Returns:

  • (String, nil) 


346
347
348
 
# File 'rekognition/cfn_stream_processor.rb', line 346

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



350
351
352
353
 
# File 'rekognition/cfn_stream_processor.rb', line 350

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


130
131
132
 
# File 'rekognition/cfn_stream_processor.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

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:

  • (String, nil) 


358
359
360
 
# File 'rekognition/cfn_stream_processor.rb', line 358

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



362
363
364
365
 
# File 'rekognition/cfn_stream_processor.rb', line 362

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


113
114
115
 
# File 'rekognition/cfn_stream_processor.rb', line 113

def node()
  jsii_get_property("node")
end

#notification_channel ⇒ AWSCDK::IResolvable, ...

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

Returns:



370
371
372
 
# File 'rekognition/cfn_stream_processor.rb', line 370

def notification_channel()
  jsii_get_property("notificationChannel")
end

#notification_channel=(value) ⇒ Object 



374
375
376
377
378
 
# File 'rekognition/cfn_stream_processor.rb', line 374

def notification_channel=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::NotificationChannelProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuTm90aWZpY2F0aW9uQ2hhbm5lbFByb3BlcnR5In1dfX0=")), "notificationChannel") unless value.nil?
  jsii_set_property("notificationChannel", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



633
634
635
 
# File 'rekognition/cfn_stream_processor.rb', line 633

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



640
641
642
 
# File 'rekognition/cfn_stream_processor.rb', line 640

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



433
434
435
436
 
# File 'rekognition/cfn_stream_processor.rb', line 433

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#polygon_regions_of_interest ⇒ Object

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:

  • (Object) 


258
259
260
 
# File 'rekognition/cfn_stream_processor.rb', line 258

def polygon_regions_of_interest()
  jsii_get_property("polygonRegionsOfInterest")
end

#polygon_regions_of_interest=(value) ⇒ Object 



262
263
264
265
 
# File 'rekognition/cfn_stream_processor.rb', line 262

def polygon_regions_of_interest=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "polygonRegionsOfInterest")
  jsii_set_property("polygonRegionsOfInterest", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


149
150
151
 
# File 'rekognition/cfn_stream_processor.rb', line 149

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



651
652
653
654
 
# File 'rekognition/cfn_stream_processor.rb', line 651

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


658
659
660
661
 
# File 'rekognition/cfn_stream_processor.rb', line 658

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



668
669
670
671
672
 
# File 'rekognition/cfn_stream_processor.rb', line 668

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String

The ARN of the IAM role that allows access to the stream processor.

Returns:

  • (String) 


270
271
272
 
# File 'rekognition/cfn_stream_processor.rb', line 270

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



274
275
276
277
 
# File 'rekognition/cfn_stream_processor.rb', line 274

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#s3_destination ⇒ AWSCDK::IResolvable, ...

The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

Returns:



383
384
385
 
# File 'rekognition/cfn_stream_processor.rb', line 383

def s3_destination()
  jsii_get_property("s3Destination")
end

#s3_destination=(value) ⇒ Object 



387
388
389
390
391
 
# File 'rekognition/cfn_stream_processor.rb', line 387

def s3_destination=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Rekognition::CfnStreamProcessor::S3DestinationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWtvZ25pdGlvbi5DZm5TdHJlYW1Qcm9jZXNzb3IuUzNEZXN0aW5hdGlvblByb3BlcnR5In1dfX0=")), "s3Destination") unless value.nil?
  jsii_set_property("s3Destination", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



677
678
679
 
# File 'rekognition/cfn_stream_processor.rb', line 677

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



139
140
141
 
# File 'rekognition/cfn_stream_processor.rb', line 139

def stack()
  jsii_get_property("stack")
end

#stream_processor_ref ⇒ AWSCDK::Interfaces::AWSRekognition::StreamProcessorReference

A reference to a StreamProcessor resource.

Returns:



231
232
233
 
# File 'rekognition/cfn_stream_processor.rb', line 231

def stream_processor_ref()
  jsii_get_property("streamProcessorRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



238
239
240
 
# File 'rekognition/cfn_stream_processor.rb', line 238

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A set of tags (key-value pairs) that you want to attach to the stream processor.

Returns:



396
397
398
 
# File 'rekognition/cfn_stream_processor.rb', line 396

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



400
401
402
403
404
 
# File 'rekognition/cfn_stream_processor.rb', line 400

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



409
410
411
 
# File 'rekognition/cfn_stream_processor.rb', line 409

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'rekognition/cfn_stream_processor.rb', line 186

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


196
197
198
 
# File 'rekognition/cfn_stream_processor.rb', line 196

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


683
684
685
686
 
# File 'rekognition/cfn_stream_processor.rb', line 683

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


422
423
424
425
426
427
 
# File 'rekognition/cfn_stream_processor.rb', line 422

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end