latest--aws-iotsitewise-gateway

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iotsitewise-gateway.json
Parent schema serverless-framework-configuration
Type: object

Resource schema for AWS::IoTSiteWise::Gateway. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git

Properties

GatewayName string | Aws_CF_FunctionString required

A unique, friendly name for the gateway.

GatewayPlatform object required

Contains a gateway's platform information.

One of: variant, variant
2 nested properties
Greengrass object

Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.

1 nested properties
GroupArn string | Aws_CF_FunctionString required

The ARN of the Greengrass group.

GreengrassV2 object

Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.

1 nested properties
CoreDeviceThingName string | Aws_CF_FunctionString required

The name of the CoreDevice in GreenGrass V2.

Tags Tag[]

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

GatewayCapabilitySummaries GatewayCapabilitySummary[]

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

uniqueItems=true

Definitions

GatewayPlatform object

Contains a gateway's platform information.

Greengrass object

Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.

1 nested properties
GroupArn string | Aws_CF_FunctionString required

The ARN of the Greengrass group.

GreengrassV2 object

Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.

1 nested properties
CoreDeviceThingName string | Aws_CF_FunctionString required

The name of the CoreDevice in GreenGrass V2.

Greengrass object

Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.

GroupArn string | Aws_CF_FunctionString required

The ARN of the Greengrass group.

GreengrassV2 object

Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.

CoreDeviceThingName string | Aws_CF_FunctionString required

The name of the CoreDevice in GreenGrass V2.

Tag object

To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted

Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
CapabilityNamespace string | Aws_CF_FunctionString

The namespace of the capability configuration.

CapabilityConfiguration string | Aws_CF_FunctionString

The JSON document that defines the gateway capability's configuration.

GatewayCapabilitySummary object

Contains a summary of a gateway capability configuration.

CapabilityNamespace string | Aws_CF_FunctionString required

The namespace of the capability configuration.

CapabilityConfiguration string | Aws_CF_FunctionString

The JSON document that defines the gateway capability's configuration.