CfnGatewayPropsMixin

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnGatewayPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html
CloudformationResource:: AWS::IoTSiteWise::Gateway
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

cfn_gateway_props_mixin = iotsitewise_mixins.CfnGatewayPropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTSiteWise::Gateway.

Parameters:

props (Union[CfnGatewayMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['gatewayCapabilitySummaries', 'gatewayName', 'gatewayPlatform', 'gatewayVersion', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

GatewayCapabilitySummaryProperty

class CfnGatewayPropsMixin.GatewayCapabilitySummaryProperty(*, capability_configuration=None, capability_namespace=None)

Bases: object

Contains a summary of a gateway capability configuration.

Parameters:

capability_configuration (Optional[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 .
capability_namespace (Optional[str]) – The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.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

gateway_capability_summary_property = iotsitewise_mixins.CfnGatewayPropsMixin.GatewayCapabilitySummaryProperty(
    capability_configuration="capabilityConfiguration",
    capability_namespace="capabilityNamespace"
)

Attributes

capability_configuration

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilityconfiguration

capability_namespace

The namespace of the capability configuration.

For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilitynamespace

GatewayPlatformProperty

class CfnGatewayPropsMixin.GatewayPlatformProperty(*, greengrass=None, greengrass_v2=None, siemens_ie=None)

Bases: object

The gateway’s platform configuration. You can only specify one platform type in a gateway.

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway ( gatewayVersion=3 ), you must also specify the coreDeviceOperatingSystem .

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

Parameters:

greengrass (Union[IResolvable, GreengrassProperty, Dict[str, Any], None])
greengrass_v2 (Union[IResolvable, GreengrassV2Property, Dict[str, Any], None]) – A gateway that runs on AWS IoT Greengrass V2 .
siemens_ie (Union[IResolvable, SiemensIEProperty, Dict[str, Any], None]) – An AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.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

gateway_platform_property = 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"
    )
)

Attributes

greengrass

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

Type:: see

greengrass_v2

A gateway that runs on AWS IoT Greengrass V2 .

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

siemens_ie

An AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

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

GreengrassProperty

class CfnGatewayPropsMixin.GreengrassProperty(*, group_arn=None)

Bases: object

Parameters:: group_arn (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrass.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

greengrass_property = iotsitewise_mixins.CfnGatewayPropsMixin.GreengrassProperty(
    group_arn="groupArn"
)

Attributes

group_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrass.html#cfn-iotsitewise-gateway-greengrass-grouparn

Type:: see

GreengrassV2Property

class CfnGatewayPropsMixin.GreengrassV2Property(*, core_device_operating_system=None, core_device_thing_name=None)

Bases: object

Contains details for a gateway that runs on AWS IoT Greengrass V2 .

To create a gateway that runs on AWS IoT Greengrass V2 , you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device role must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using AWS IoT SiteWise at the edge in the AWS IoT SiteWise User Guide .

Parameters:

core_device_operating_system (Optional[str]) – The operating system of the core device in AWS IoT Greengrass V2.
core_device_thing_name (Optional[str]) – The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.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

greengrass_v2_property = iotsitewise_mixins.CfnGatewayPropsMixin.GreengrassV2Property(
    core_device_operating_system="coreDeviceOperatingSystem",
    core_device_thing_name="coreDeviceThingName"
)

Attributes

core_device_operating_system

The operating system of the core device in AWS IoT Greengrass V2.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html#cfn-iotsitewise-gateway-greengrassv2-coredeviceoperatingsystem

core_device_thing_name

The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html#cfn-iotsitewise-gateway-greengrassv2-coredevicethingname

SiemensIEProperty

class CfnGatewayPropsMixin.SiemensIEProperty(*, iot_core_thing_name=None)

Bases: object

Contains details for a AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

Parameters:: iot_core_thing_name (Optional[str]) – The name of the AWS IoT Thing for your AWS IoT SiteWise Edge gateway.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-siemensie.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

siemens_iEProperty = iotsitewise_mixins.CfnGatewayPropsMixin.SiemensIEProperty(
    iot_core_thing_name="iotCoreThingName"
)

Attributes

iot_core_thing_name

The name of the AWS IoT Thing for your AWS IoT SiteWise Edge gateway.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-siemensie.html#cfn-iotsitewise-gateway-siemensie-iotcorethingname