Class: AWSCDK::IoTSiteWise::CfnGateway::GatewayCapabilitySummaryProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_site_wise/cfn_gateway.rb

Overview

Contains a summary of a gateway capability configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(capability_namespace:, capability_configuration: nil) ⇒ GatewayCapabilitySummaryProperty

Returns a new instance of GatewayCapabilitySummaryProperty.

Parameters:

  • capability_namespace (String) —

    The namespace of the capability configuration.

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

    The JSON document that defines the configuration for the gateway capability.



586
587
588
589
590
591
 
# File 'io_t_site_wise/cfn_gateway.rb', line 586

def initialize(capability_namespace:, capability_configuration: nil)
  @capability_namespace = capability_namespace
  Jsii::Type.check_type(@capability_namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capabilityNamespace")
  @capability_configuration = capability_configuration
  Jsii::Type.check_type(@capability_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capabilityConfiguration") unless @capability_configuration.nil?
end

Instance Attribute Details

#capability_configuration ⇒ String? (readonly)

The JSON document that defines the configuration for the gateway capability.

For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .

Returns:

  • (String, nil)

See Also:



606
607
608
 
# File 'io_t_site_wise/cfn_gateway.rb', line 606

def capability_configuration
  @capability_configuration
end

#capability_namespace ⇒ String (readonly)

The namespace of the capability configuration.

For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3 .

Returns:

  • (String)

See Also:



599
600
601
 
# File 'io_t_site_wise/cfn_gateway.rb', line 599

def capability_namespace
  @capability_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



608
609
610
611
612
613
 
# File 'io_t_site_wise/cfn_gateway.rb', line 608

def self.jsii_properties
  {
    :capability_namespace => "capabilityNamespace",
    :capability_configuration => "capabilityConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



615
616
617
618
619
620
621
622
 
# File 'io_t_site_wise/cfn_gateway.rb', line 615

def to_jsii
  result = {}
  result.merge!({
    "capabilityNamespace" => @capability_namespace,
    "capabilityConfiguration" => @capability_configuration,
  })
  result.compact
end