Class: AWSCDK::IoTAnalytics::CfnPipeline::DeviceRegistryEnrichProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_analytics/cfn_pipeline.rb

Overview

An activity that adds data from the AWS IoT device registry to your message.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attribute:, name:, role_arn:, thing_name:, _next: nil) ⇒ DeviceRegistryEnrichProperty

Returns a new instance of DeviceRegistryEnrichProperty.

Parameters:

  • attribute (String) —

    The name of the attribute that is added to the message.

  • name (String) —

    The name of the 'deviceRegistryEnrich' activity.

  • role_arn (String) —

    The ARN of the role that allows access to the device's registry information.

  • thing_name (String) —

    The name of the IoT device whose registry information is added to the message.

  • _next (String, nil) (defaults to: nil) —

    The next activity in the pipeline.



834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'io_t_analytics/cfn_pipeline.rb', line 834

def initialize(attribute:, name:, role_arn:, thing_name:, _next: nil)
  @attribute = attribute
  Jsii::Type.check_type(@attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attribute")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @thing_name = thing_name
  Jsii::Type.check_type(@thing_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "thingName")
  @_next = _next
  Jsii::Type.check_type(@_next, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "next") unless @_next.nil?
end

Instance Attribute Details

#_next ⇒ String? (readonly)

The next activity in the pipeline.

Returns:

  • (String, nil)

See Also:



871
872
873
 
# File 'io_t_analytics/cfn_pipeline.rb', line 871

def _next
  @_next
end

#attribute ⇒ String (readonly)

The name of the attribute that is added to the message.

Returns:

  • (String)

See Also:



851
852
853
 
# File 'io_t_analytics/cfn_pipeline.rb', line 851

def attribute
  @attribute
end

#name ⇒ String (readonly)

The name of the 'deviceRegistryEnrich' activity.

Returns:

  • (String)

See Also:



856
857
858
 
# File 'io_t_analytics/cfn_pipeline.rb', line 856

def name
  @name
end

#role_arn ⇒ String (readonly)

The ARN of the role that allows access to the device's registry information.

Returns:

  • (String)

See Also:



861
862
863
 
# File 'io_t_analytics/cfn_pipeline.rb', line 861

def role_arn
  @role_arn
end

#thing_name ⇒ String (readonly)

The name of the IoT device whose registry information is added to the message.

Returns:

  • (String)

See Also:



866
867
868
 
# File 'io_t_analytics/cfn_pipeline.rb', line 866

def thing_name
  @thing_name
end

Class Method Details

.jsii_properties ⇒ Object 



873
874
875
876
877
878
879
880
881
 
# File 'io_t_analytics/cfn_pipeline.rb', line 873

def self.jsii_properties
  {
    :attribute => "attribute",
    :name => "name",
    :role_arn => "roleArn",
    :thing_name => "thingName",
    :_next => "next",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



883
884
885
886
887
888
889
890
891
892
893
 
# File 'io_t_analytics/cfn_pipeline.rb', line 883

def to_jsii
  result = {}
  result.merge!({
    "attribute" => @attribute,
    "name" => @name,
    "roleArn" => @role_arn,
    "thingName" => @thing_name,
    "next" => @_next,
  })
  result.compact
end