interface CfnGatewayProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.IoTSiteWise.CfnGatewayProps |
Java | software.amazon.awscdk.services.iotsitewise.CfnGatewayProps |
Python | aws_cdk.aws_iotsitewise.CfnGatewayProps |
TypeScript | @aws-cdk/aws-iotsitewise » CfnGatewayProps |
Properties for defining a CfnGateway
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotsitewise from '@aws-cdk/aws-iotsitewise';
const cfnGatewayProps: iotsitewise.CfnGatewayProps = {
gatewayName: 'gatewayName',
gatewayPlatform: {
greengrass: {
groupArn: 'groupArn',
},
greengrassV2: {
coreDeviceThingName: 'coreDeviceThingName',
},
},
// the properties below are optional
gatewayCapabilitySummaries: [{
capabilityNamespace: 'capabilityNamespace',
// the properties below are optional
capabilityConfiguration: 'capabilityConfiguration',
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
gateway | string | A unique, friendly name for the gateway. |
gateway | IResolvable | Gateway | The gateway's platform. |
gateway | IResolvable | IResolvable | Gateway [] | A list of gateway capability summaries that each contain a namespace and status. |
tags? | Cfn [] | A list of key-value pairs that contain metadata for the gateway. |
gatewayName
Type:
string
A unique, friendly name for the gateway.
The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+
.
gatewayPlatform
Type:
IResolvable
|
Gateway
The gateway's platform.
You can only specify one platform in a gateway.
gatewayCapabilitySummaries?
Type:
IResolvable
|
IResolvable
|
Gateway
[]
(optional)
A list of gateway capability summaries that each contain a namespace and status.
Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs that contain metadata for the gateway.
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .