Docs Packages
  1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. Gateway
aws-native logo
AWS Native v0.63.0, May 25 23

aws-native.iotsitewise.Gateway

Explore with Pulumi AI

Resource schema for AWS::IoTSiteWise::Gateway

Create Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            gateway_capability_summaries: Optional[Sequence[GatewayCapabilitySummaryArgs]] = None,
            gateway_name: Optional[str] = None,
            gateway_platform: Optional[GatewayPlatformArgs] = None,
            tags: Optional[Sequence[GatewayTagArgs]] = None)
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = 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.
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:

GatewayPlatform Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayPlatformArgs

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

GatewayCapabilitySummaries List<Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayCapabilitySummaryArgs>

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

GatewayName string

A unique, friendly name for the gateway.

Tags List<Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayTagArgs>

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

GatewayPlatform 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.

Tags []GatewayTagArgs

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

gatewayPlatform GatewayPlatformArgs

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

gatewayCapabilitySummaries List<GatewayCapabilitySummaryArgs>

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

gatewayName String

A unique, friendly name for the gateway.

tags List<GatewayTagArgs>

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

gatewayPlatform 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.

tags GatewayTagArgs[]

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

gateway_platform 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.

tags Sequence[GatewayTagArgs]

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

gatewayPlatform 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.

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

GatewayGreengrass

GroupArn string

The ARN of the Greengrass group.

GroupArn string

The ARN of the Greengrass group.

groupArn String

The ARN of the Greengrass group.

groupArn string

The ARN of the Greengrass group.

group_arn str

The ARN of the Greengrass group.

groupArn String

The ARN of the Greengrass group.

GatewayGreengrassV2

CoreDeviceThingName string

The name of the CoreDevice in GreenGrass V2.

CoreDeviceThingName string

The name of the CoreDevice in GreenGrass V2.

coreDeviceThingName String

The name of the CoreDevice in GreenGrass V2.

coreDeviceThingName string

The name of the CoreDevice in GreenGrass V2.

core_device_thing_name str

The name of the CoreDevice in GreenGrass V2.

coreDeviceThingName String

The name of the CoreDevice in GreenGrass V2.

GatewayPlatform

Greengrass Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayGreengrass

A gateway that runs on AWS IoT Greengrass V1.

GreengrassV2 Pulumi.AwsNative.IoTSiteWise.Inputs.GatewayGreengrassV2

A gateway that runs on AWS IoT Greengrass V2.

Greengrass GatewayGreengrass

A gateway that runs on AWS IoT Greengrass V1.

GreengrassV2 GatewayGreengrassV2

A gateway that runs on AWS IoT Greengrass V2.

greengrass GatewayGreengrass

A gateway that runs on AWS IoT Greengrass V1.

greengrassV2 GatewayGreengrassV2

A gateway that runs on AWS IoT Greengrass V2.

greengrass GatewayGreengrass

A gateway that runs on AWS IoT Greengrass V1.

greengrassV2 GatewayGreengrassV2

A gateway that runs on AWS IoT Greengrass V2.

greengrass GatewayGreengrass

A gateway that runs on AWS IoT Greengrass V1.

greengrass_v2 GatewayGreengrassV2

A gateway that runs on AWS IoT Greengrass V2.

greengrass Property Map

A gateway that runs on AWS IoT Greengrass V1.

greengrassV2 Property Map

A gateway that runs on AWS IoT Greengrass V2.

GatewayTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

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