Class: AWSCDK::IoTAnalytics::CfnPipeline::DeviceShadowEnrichProperty

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

Overview

An activity that adds information from the AWS IoT Device Shadows service to a 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) ⇒ DeviceShadowEnrichProperty

Returns a new instance of DeviceShadowEnrichProperty.

Parameters:

  • attribute (String) —

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

  • name (String) —

    The name of the 'deviceShadowEnrich' activity.

  • role_arn (String) —

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

  • thing_name (String) —

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

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

    The next activity in the pipeline.



907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'io_t_analytics/cfn_pipeline.rb', line 907

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:



944
945
946
 
# File 'io_t_analytics/cfn_pipeline.rb', line 944

def _next
  @_next
end

#attribute ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



924
925
926
 
# File 'io_t_analytics/cfn_pipeline.rb', line 924

def attribute
  @attribute
end

#name ⇒ String (readonly)

The name of the 'deviceShadowEnrich' activity.

Returns:

  • (String)

See Also:



929
930
931
 
# File 'io_t_analytics/cfn_pipeline.rb', line 929

def name
  @name
end

#role_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



934
935
936
 
# File 'io_t_analytics/cfn_pipeline.rb', line 934

def role_arn
  @role_arn
end

#thing_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



939
940
941
 
# File 'io_t_analytics/cfn_pipeline.rb', line 939

def thing_name
  @thing_name
end

Class Method Details

.jsii_properties ⇒ Object 



946
947
948
949
950
951
952
953
954
 
# File 'io_t_analytics/cfn_pipeline.rb', line 946

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

Instance Method Details

#to_jsii ⇒ Object 



956
957
958
959
960
961
962
963
964
965
966
 
# File 'io_t_analytics/cfn_pipeline.rb', line 956

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