1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. Gateway

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.iotsitewise.Gateway

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const gatewayResource = new aws_native.iotsitewise.Gateway("gatewayResource", {
        gatewayPlatform: {
            greengrass: {
                groupArn: "string",
            },
            greengrassV2: {
                coreDeviceThingName: "string",
            },
            siemensIe: {
                iotCoreThingName: "string",
            },
        },
        gatewayCapabilitySummaries: [{
            capabilityNamespace: "string",
            capabilityConfiguration: "string",
        }],
        gatewayName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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.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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    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 TagArgs
    A list of key-value pairs that contain metadata for the gateway.
    gatewayPlatform 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.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the gateway.
    gatewayPlatform 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.
    tags Tag[]
    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[TagArgs]
    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, GatewayCapabilitySummaryArgs

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

    GatewayGreengrass, GatewayGreengrassArgs

    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, GatewayGreengrassV2Args

    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, GatewayPlatformArgs

    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.
    SiemensIe Pulumi.AwsNative.IoTSiteWise.Inputs.GatewaySiemensIe
    A gateway that runs on Siemens Industrial Edge.
    Greengrass GatewayGreengrass
    A gateway that runs on AWS IoT Greengrass V1.
    GreengrassV2 GatewayGreengrassV2
    A gateway that runs on AWS IoT Greengrass V2.
    SiemensIe GatewaySiemensIe
    A gateway that runs on Siemens Industrial Edge.
    greengrass GatewayGreengrass
    A gateway that runs on AWS IoT Greengrass V1.
    greengrassV2 GatewayGreengrassV2
    A gateway that runs on AWS IoT Greengrass V2.
    siemensIe GatewaySiemensIe
    A gateway that runs on Siemens Industrial Edge.
    greengrass GatewayGreengrass
    A gateway that runs on AWS IoT Greengrass V1.
    greengrassV2 GatewayGreengrassV2
    A gateway that runs on AWS IoT Greengrass V2.
    siemensIe GatewaySiemensIe
    A gateway that runs on Siemens Industrial Edge.
    greengrass GatewayGreengrass
    A gateway that runs on AWS IoT Greengrass V1.
    greengrass_v2 GatewayGreengrassV2
    A gateway that runs on AWS IoT Greengrass V2.
    siemens_ie GatewaySiemensIe
    A gateway that runs on Siemens Industrial Edge.
    greengrass Property Map
    A gateway that runs on AWS IoT Greengrass V1.
    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 string
    The name of the IoT Core Thing.
    IotCoreThingName string
    The name of the IoT Core Thing.
    iotCoreThingName String
    The name of the IoT Core Thing.
    iotCoreThingName string
    The name of the IoT Core Thing.
    iot_core_thing_name str
    The name of the IoT Core Thing.
    iotCoreThingName String
    The name of the IoT Core Thing.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi