Class: Aws::IoTSiteWise::Types::CreateGatewayRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#gateway_name ⇒ String

A unique name for the gateway.

Returns:

  • (String) 


3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3640

class CreateGatewayRequest < Struct.new(
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_platform ⇒ Types::GatewayPlatform

The gateway's platform. You can only specify one platform in a gateway.

Returns:



3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3640

class CreateGatewayRequest < Struct.new(
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_version ⇒ String

The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway).

When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter.

We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.

Returns:

  • (String) 


3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3640

class CreateGatewayRequest < Struct.new(
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:

  • (Hash<String,String>) 


3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3640

class CreateGatewayRequest < Struct.new(
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end