Class: AWSCDK::IoTSiteWise::CfnGatewayProps

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

Overview

Properties for defining a CfnGateway.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(gateway_name:, gateway_platform:, gateway_capability_summaries: nil, gateway_version: nil, tags: nil) ⇒ CfnGatewayProps

Returns a new instance of CfnGatewayProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 14

def initialize(gateway_name:, gateway_platform:, gateway_capability_summaries: nil, gateway_version: nil, tags: nil)
  @gateway_name = gateway_name
  Jsii::Type.check_type(@gateway_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayName")
  @gateway_platform = gateway_platform.is_a?(Hash) ? ::AWSCDK::IoTSiteWise::CfnGateway::GatewayPlatformProperty.new(**gateway_platform.transform_keys(&:to_sym)) : gateway_platform
  Jsii::Type.check_type(@gateway_platform, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RzaXRld2lzZS5DZm5HYXRld2F5LkdhdGV3YXlQbGF0Zm9ybVByb3BlcnR5In1dfX0=")), "gatewayPlatform")
  @gateway_capability_summaries = gateway_capability_summaries
  Jsii::Type.check_type(@gateway_capability_summaries, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90c2l0ZXdpc2UuQ2ZuR2F0ZXdheS5HYXRld2F5Q2FwYWJpbGl0eVN1bW1hcnlQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "gatewayCapabilitySummaries") unless @gateway_capability_summaries.nil?
  @gateway_version = gateway_version
  Jsii::Type.check_type(@gateway_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayVersion") unless @gateway_version.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#gateway_capability_summaries ⇒ AWSCDK::IResolvable, ... (readonly)

A list of gateway capability summaries that each contain a namespace and status.

Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .

Returns:

See Also:



45
46
47
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 45

def gateway_capability_summaries
  @gateway_capability_summaries
end

#gateway_name ⇒ String (readonly)

A unique name for the gateway.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 31

def gateway_name
  @gateway_name
end

#gateway_platform ⇒ AWSCDK::IResolvable, AWSCDK::IoTSiteWise::CfnGateway::GatewayPlatformProperty (readonly)

The gateway's platform.

You can only specify one platform in a gateway.

Returns:

See Also:



38
39
40
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 38

def gateway_platform
  @gateway_platform
end

#gateway_version ⇒ String? (readonly)

The version of the gateway.

A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 52

def gateway_version
  @gateway_version
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of key-value pairs that contain metadata for the gateway.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

Returns:

See Also:



59
60
61
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 61

def self.jsii_properties
  {
    :gateway_name => "gatewayName",
    :gateway_platform => "gatewayPlatform",
    :gateway_capability_summaries => "gatewayCapabilitySummaries",
    :gateway_version => "gatewayVersion",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'io_t_site_wise/cfn_gateway_props.rb', line 71

def to_jsii
  result = {}
  result.merge!({
    "gatewayName" => @gateway_name,
    "gatewayPlatform" => @gateway_platform,
    "gatewayCapabilitySummaries" => @gateway_capability_summaries,
    "gatewayVersion" => @gateway_version,
    "tags" => @tags,
  })
  result.compact
end