CfnGatewayProps

class aws_cdk.aws_iotsitewise.CfnGatewayProps(*, gateway_name, gateway_platform, gateway_capability_summaries=None, tags=None)

Bases: object

Properties for defining a CfnGateway.

Parameters
  • gateway_name (str) – A unique, friendly name for the gateway. The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .

  • gateway_platform (Union[IResolvable, GatewayPlatformProperty]) – The gateway’s platform. You can only specify one platform in a gateway.

  • gateway_capability_summaries (Union[IResolvable, Sequence[Union[IResolvable, GatewayCapabilitySummaryProperty]], None]) – 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 (Optional[Sequence[CfnTag]]) – 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotsitewise as iotsitewise

cfn_gateway_props = iotsitewise.CfnGatewayProps(
    gateway_name="gatewayName",
    gateway_platform=iotsitewise.CfnGateway.GatewayPlatformProperty(
        greengrass=iotsitewise.CfnGateway.GreengrassProperty(
            group_arn="groupArn"
        ),
        greengrass_v2=iotsitewise.CfnGateway.GreengrassV2Property(
            core_device_thing_name="coreDeviceThingName"
        )
    ),

    # the properties below are optional
    gateway_capability_summaries=[iotsitewise.CfnGateway.GatewayCapabilitySummaryProperty(
        capability_namespace="capabilityNamespace",

        # the properties below are optional
        capability_configuration="capabilityConfiguration"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

gateway_capability_summaries

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewaycapabilitysummaries

Return type

Union[IResolvable, List[Union[IResolvable, GatewayCapabilitySummaryProperty]], None]

gateway_name

A unique, friendly name for the gateway.

The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayname

Return type

str

gateway_platform

The gateway’s platform.

You can only specify one platform in a gateway.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayplatform

Return type

Union[IResolvable, GatewayPlatformProperty]

tags

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-tags

Return type

Optional[List[CfnTag]]