CfnGatewayMixinProps

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnGatewayMixinProps(*, gateway_capability_summaries=None, gateway_name=None, gateway_platform=None, gateway_version=None, tags=None)

Bases: object

Properties for CfnGatewayPropsMixin.

Parameters:

gateway_capability_summaries (Union[IResolvable, Sequence[Union[IResolvable, GatewayCapabilitySummaryProperty, Dict[str, Any]]], 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 .
gateway_name (Optional[str]) – A unique name for the gateway.
gateway_platform (Union[IResolvable, GatewayPlatformProperty, Dict[str, Any], None]) – The gateway’s platform. You can only specify one platform in a gateway.
gateway_version (Optional[str]) – The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

See:

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.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

cfn_gateway_mixin_props = iotsitewise_mixins.CfnGatewayMixinProps(
    gateway_capability_summaries=[iotsitewise_mixins.CfnGatewayPropsMixin.GatewayCapabilitySummaryProperty(
        capability_configuration="capabilityConfiguration",
        capability_namespace="capabilityNamespace"
    )],
    gateway_name="gatewayName",
    gateway_platform=iotsitewise_mixins.CfnGatewayPropsMixin.GatewayPlatformProperty(
        greengrass=iotsitewise_mixins.CfnGatewayPropsMixin.GreengrassProperty(
            group_arn="groupArn"
        ),
        greengrass_v2=iotsitewise_mixins.CfnGatewayPropsMixin.GreengrassV2Property(
            core_device_operating_system="coreDeviceOperatingSystem",
            core_device_thing_name="coreDeviceThingName"
        ),
        siemens_ie=iotsitewise_mixins.CfnGatewayPropsMixin.SiemensIEProperty(
            iot_core_thing_name="iotCoreThingName"
        )
    ),
    gateway_version="gatewayVersion",
    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 .