Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotsitewise
  5. Gateway

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.Gateway

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::IoTSiteWise::Gateway

Create Gateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            gateway_platform: Optional[GatewayPlatformArgs] = None,
            gateway_capability_summaries: Optional[Sequence[GatewayCapabilitySummaryArgs]] = None,
            gateway_name: Optional[str] = None,
            gateway_version: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

type: aws-native:iotsitewise:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Gateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Gateway resource accepts the following input properties:

GatewayPlatform This property is required. Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayPlatform
The gateway's platform. You can only specify one platform in a gateway.
GatewayCapabilitySummaries List<Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayCapabilitySummary>
A list of gateway capability summaries that each contain a namespace and status.
GatewayName string
A unique, friendly name for the gateway.
GatewayVersion string
The version of the gateway you want to create.
Tags List<Pulumi.AwsNative.Inputs.Tag>
A list of key-value pairs that contain metadata for the gateway.
GatewayPlatform This property is required. GatewayPlatformArgs
The gateway's platform. You can only specify one platform in a gateway.
GatewayCapabilitySummaries []GatewayCapabilitySummaryArgs
A list of gateway capability summaries that each contain a namespace and status.
GatewayName string
A unique, friendly name for the gateway.
GatewayVersion string
The version of the gateway you want to create.
Tags TagArgs
A list of key-value pairs that contain metadata for the gateway.
gatewayPlatform This property is required. GatewayPlatform
The gateway's platform. You can only specify one platform in a gateway.
gatewayCapabilitySummaries List<GatewayCapabilitySummary>
A list of gateway capability summaries that each contain a namespace and status.
gatewayName String
A unique, friendly name for the gateway.
gatewayVersion String
The version of the gateway you want to create.
tags List<Tag>
A list of key-value pairs that contain metadata for the gateway.
gatewayPlatform This property is required. GatewayPlatform
The gateway's platform. You can only specify one platform in a gateway.
gatewayCapabilitySummaries GatewayCapabilitySummary[]
A list of gateway capability summaries that each contain a namespace and status.
gatewayName string
A unique, friendly name for the gateway.
gatewayVersion string
The version of the gateway you want to create.
tags Tag[]
A list of key-value pairs that contain metadata for the gateway.
gateway_platform This property is required. GatewayPlatformArgs
The gateway's platform. You can only specify one platform in a gateway.
gateway_capability_summaries Sequence[GatewayCapabilitySummaryArgs]
A list of gateway capability summaries that each contain a namespace and status.
gateway_name str
A unique, friendly name for the gateway.
gateway_version str
The version of the gateway you want to create.
tags Sequence[TagArgs]
A list of key-value pairs that contain metadata for the gateway.
gatewayPlatform This property is required. Property Map
The gateway's platform. You can only specify one platform in a gateway.
gatewayCapabilitySummaries List<Property Map>
A list of gateway capability summaries that each contain a namespace and status.
gatewayName String
A unique, friendly name for the gateway.
gatewayVersion String
The version of the gateway you want to create.
tags List<Property Map>
A list of key-value pairs that contain metadata for the gateway.

Outputs

All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:

GatewayId string
The ID of the gateway device.
Id string
The provider-assigned unique ID for this managed resource.
GatewayId string
The ID of the gateway device.
Id string
The provider-assigned unique ID for this managed resource.
gatewayId String
The ID of the gateway device.
id String
The provider-assigned unique ID for this managed resource.
gatewayId string
The ID of the gateway device.
id string
The provider-assigned unique ID for this managed resource.
gateway_id str
The ID of the gateway device.
id str
The provider-assigned unique ID for this managed resource.
gatewayId String
The ID of the gateway device.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

GatewayCapabilitySummary
, GatewayCapabilitySummaryArgs

CapabilityNamespace This property is required. string
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
CapabilityConfiguration string
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 .
CapabilityNamespace This property is required. string
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
CapabilityConfiguration string
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 .
capabilityNamespace This property is required. String
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
capabilityConfiguration String
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 .
capabilityNamespace This property is required. string
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
capabilityConfiguration string
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 .
capability_namespace This property is required. str
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
capability_configuration str
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 .
capabilityNamespace This property is required. String
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
capabilityConfiguration String
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 .

GatewayGreengrassV2
, GatewayGreengrassV2Args

CoreDeviceThingName This property is required. string
The name of the CoreDevice in GreenGrass V2.
CoreDeviceOperatingSystem Pulumi.AwsNative.IoTSiteWise.GatewayGreengrassV2CoreDeviceOperatingSystem
The operating system of the core device in AWS IoT Greengrass V2.
CoreDeviceThingName This property is required. string
The name of the CoreDevice in GreenGrass V2.
CoreDeviceOperatingSystem GatewayGreengrassV2CoreDeviceOperatingSystem
The operating system of the core device in AWS IoT Greengrass V2.
coreDeviceThingName This property is required. String
The name of the CoreDevice in GreenGrass V2.
coreDeviceOperatingSystem GatewayGreengrassV2CoreDeviceOperatingSystem
The operating system of the core device in AWS IoT Greengrass V2.
coreDeviceThingName This property is required. string
The name of the CoreDevice in GreenGrass V2.
coreDeviceOperatingSystem GatewayGreengrassV2CoreDeviceOperatingSystem
The operating system of the core device in AWS IoT Greengrass V2.
core_device_thing_name This property is required. str
The name of the CoreDevice in GreenGrass V2.
core_device_operating_system GatewayGreengrassV2CoreDeviceOperatingSystem
The operating system of the core device in AWS IoT Greengrass V2.
coreDeviceThingName This property is required. String
The name of the CoreDevice in GreenGrass V2.
coreDeviceOperatingSystem "LINUX_AARCH64" | "LINUX_AMD64" | "WINDOWS_AMD64"
The operating system of the core device in AWS IoT Greengrass V2.

GatewayGreengrassV2CoreDeviceOperatingSystem
, GatewayGreengrassV2CoreDeviceOperatingSystemArgs

LinuxAarch64
LINUX_AARCH64
LinuxAmd64
LINUX_AMD64
WindowsAmd64
WINDOWS_AMD64
GatewayGreengrassV2CoreDeviceOperatingSystemLinuxAarch64
LINUX_AARCH64
GatewayGreengrassV2CoreDeviceOperatingSystemLinuxAmd64
LINUX_AMD64
GatewayGreengrassV2CoreDeviceOperatingSystemWindowsAmd64
WINDOWS_AMD64
LinuxAarch64
LINUX_AARCH64
LinuxAmd64
LINUX_AMD64
WindowsAmd64
WINDOWS_AMD64
LinuxAarch64
LINUX_AARCH64
LinuxAmd64
LINUX_AMD64
WindowsAmd64
WINDOWS_AMD64
LINUX_AARCH64
LINUX_AARCH64
LINUX_AMD64
LINUX_AMD64
WINDOWS_AMD64
WINDOWS_AMD64
"LINUX_AARCH64"
LINUX_AARCH64
"LINUX_AMD64"
LINUX_AMD64
"WINDOWS_AMD64"
WINDOWS_AMD64

GatewayPlatform
, GatewayPlatformArgs

GreengrassV2 Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayGreengrassV2
A gateway that runs on AWS IoT Greengrass V2.
SiemensIe Pulumi.AwsNative.IoTSiteWise.Inputs.GatewaySiemensIe
A gateway that runs on Siemens Industrial Edge.
GreengrassV2 GatewayGreengrassV2
A gateway that runs on AWS IoT Greengrass V2.
SiemensIe GatewaySiemensIe
A gateway that runs on Siemens Industrial Edge.
greengrassV2 GatewayGreengrassV2
A gateway that runs on AWS IoT Greengrass V2.
siemensIe GatewaySiemensIe
A gateway that runs on Siemens Industrial Edge.
greengrassV2 GatewayGreengrassV2
A gateway that runs on AWS IoT Greengrass V2.
siemensIe GatewaySiemensIe
A gateway that runs on Siemens Industrial Edge.
greengrass_v2 GatewayGreengrassV2
A gateway that runs on AWS IoT Greengrass V2.
siemens_ie GatewaySiemensIe
A gateway that runs on Siemens Industrial Edge.
greengrassV2 Property Map
A gateway that runs on AWS IoT Greengrass V2.
siemensIe Property Map
A gateway that runs on Siemens Industrial Edge.

GatewaySiemensIe
, GatewaySiemensIeArgs

IotCoreThingName This property is required. string
The name of the IoT Core Thing.
IotCoreThingName This property is required. string
The name of the IoT Core Thing.
iotCoreThingName This property is required. String
The name of the IoT Core Thing.
iotCoreThingName This property is required. string
The name of the IoT Core Thing.
iot_core_thing_name This property is required. str
The name of the IoT Core Thing.
iotCoreThingName This property is required. String
The name of the IoT Core Thing.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native