We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.1.0 published on Friday, Oct 11, 2024 by Pulumi
aws-native.iotsitewise.Gateway
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.1.0 published on Friday, Oct 11, 2024 by Pulumi
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,
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 string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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
The Gateway resource accepts the following input properties:
- Gateway
Platform Pulumi.Aws Native. Io TSite Wise. Inputs. Gateway Platform - The gateway's platform. You can only specify one platform in a gateway.
- Gateway
Capability List<Pulumi.Summaries Aws Native. Io TSite Wise. Inputs. Gateway Capability Summary> - A list of gateway capability summaries that each contain a namespace and status.
- Gateway
Name string - A unique, friendly name for the gateway.
- List<Pulumi.
Aws Native. Inputs. Tag> - A list of key-value pairs that contain metadata for the gateway.
- Gateway
Platform GatewayPlatform Args - The gateway's platform. You can only specify one platform in a gateway.
- Gateway
Capability []GatewaySummaries Capability Summary Args - A list of gateway capability summaries that each contain a namespace and status.
- Gateway
Name string - A unique, friendly name for the gateway.
- Tag
Args - A list of key-value pairs that contain metadata for the gateway.
- gateway
Platform GatewayPlatform - The gateway's platform. You can only specify one platform in a gateway.
- gateway
Capability List<GatewaySummaries Capability Summary> - A list of gateway capability summaries that each contain a namespace and status.
- gateway
Name String - A unique, friendly name for the gateway.
- List<Tag>
- A list of key-value pairs that contain metadata for the gateway.
- gateway
Platform GatewayPlatform - The gateway's platform. You can only specify one platform in a gateway.
- gateway
Capability GatewaySummaries Capability Summary[] - A list of gateway capability summaries that each contain a namespace and status.
- gateway
Name string - A unique, friendly name for the gateway.
- Tag[]
- A list of key-value pairs that contain metadata for the gateway.
- gateway_
platform GatewayPlatform Args - The gateway's platform. You can only specify one platform in a gateway.
- gateway_
capability_ Sequence[Gatewaysummaries Capability Summary Args] - A list of gateway capability summaries that each contain a namespace and status.
- gateway_
name str - A unique, friendly name for the gateway.
- Sequence[Tag
Args] - A list of key-value pairs that contain metadata for the gateway.
- gateway
Platform Property Map - The gateway's platform. You can only specify one platform in a gateway.
- gateway
Capability List<Property Map>Summaries - A list of gateway capability summaries that each contain a namespace and status.
- gateway
Name String - A unique, friendly name for the gateway.
- 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:
- gateway_
id str - The ID of the gateway device.
- id str
- The provider-assigned unique ID for this managed resource.
Supporting Types
GatewayCapabilitySummary, GatewayCapabilitySummaryArgs
- Capability
Namespace 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
, whereversion
is a number such as1
. - Capability
Configuration 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 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
, whereversion
is a number such as1
. - Capability
Configuration 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 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
, whereversion
is a number such as1
. - capability
Configuration 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 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
, whereversion
is a number such as1
. - capability
Configuration 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 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
, whereversion
is a number such as1
. - 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 .
- capability
Namespace 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
, whereversion
is a number such as1
. - capability
Configuration 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 .
GatewayGreengrass, GatewayGreengrassArgs
- Group
Arn string - The ARN of the Greengrass group.
- Group
Arn string - The ARN of the Greengrass group.
- group
Arn String - The ARN of the Greengrass group.
- group
Arn string - The ARN of the Greengrass group.
- group_
arn str - The ARN of the Greengrass group.
- group
Arn String - The ARN of the Greengrass group.
GatewayGreengrassV2, GatewayGreengrassV2Args
- Core
Device stringThing Name - The name of the CoreDevice in GreenGrass V2.
- Core
Device stringThing Name - The name of the CoreDevice in GreenGrass V2.
- core
Device StringThing Name - The name of the CoreDevice in GreenGrass V2.
- core
Device stringThing Name - The name of the CoreDevice in GreenGrass V2.
- core_
device_ strthing_ name - The name of the CoreDevice in GreenGrass V2.
- core
Device StringThing Name - The name of the CoreDevice in GreenGrass V2.
GatewayPlatform, GatewayPlatformArgs
- Greengrass
Pulumi.
Aws Native. Io TSite Wise. Inputs. Gateway Greengrass - A gateway that runs on AWS IoT Greengrass V1.
- Greengrass
V2 Pulumi.Aws Native. Io TSite Wise. Inputs. Gateway Greengrass V2 - A gateway that runs on AWS IoT Greengrass V2.
- Siemens
Ie Pulumi.Aws Native. Io TSite Wise. Inputs. Gateway Siemens Ie - A gateway that runs on Siemens Industrial Edge.
- Greengrass
Gateway
Greengrass - A gateway that runs on AWS IoT Greengrass V1.
- Greengrass
V2 GatewayGreengrass V2 - A gateway that runs on AWS IoT Greengrass V2.
- Siemens
Ie GatewaySiemens Ie - A gateway that runs on Siemens Industrial Edge.
- greengrass
Gateway
Greengrass - A gateway that runs on AWS IoT Greengrass V1.
- greengrass
V2 GatewayGreengrass V2 - A gateway that runs on AWS IoT Greengrass V2.
- siemens
Ie GatewaySiemens Ie - A gateway that runs on Siemens Industrial Edge.
- greengrass
Gateway
Greengrass - A gateway that runs on AWS IoT Greengrass V1.
- greengrass
V2 GatewayGreengrass V2 - A gateway that runs on AWS IoT Greengrass V2.
- siemens
Ie GatewaySiemens Ie - A gateway that runs on Siemens Industrial Edge.
- greengrass
Gateway
Greengrass - A gateway that runs on AWS IoT Greengrass V1.
- greengrass_
v2 GatewayGreengrass V2 - A gateway that runs on AWS IoT Greengrass V2.
- siemens_
ie GatewaySiemens Ie - A gateway that runs on Siemens Industrial Edge.
- greengrass Property Map
- A gateway that runs on AWS IoT Greengrass V1.
- greengrass
V2 Property Map - A gateway that runs on AWS IoT Greengrass V2.
- siemens
Ie Property Map - A gateway that runs on Siemens Industrial Edge.
GatewaySiemensIe, GatewaySiemensIeArgs
- Iot
Core stringThing Name - The name of the IoT Core Thing.
- Iot
Core stringThing Name - The name of the IoT Core Thing.
- iot
Core StringThing Name - The name of the IoT Core Thing.
- iot
Core stringThing Name - The name of the IoT Core Thing.
- iot_
core_ strthing_ name - The name of the IoT Core Thing.
- iot
Core StringThing Name - The name of the IoT Core Thing.
Tag, TagArgs
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.1.0 published on Friday, Oct 11, 2024 by Pulumi