CfnTunnelPropsMixin

class aws_cdk.cfn_property_mixins.aws_iotsecuretunneling.CfnTunnelPropsMixin(props, *, strategy=None)

Bases: Mixin

A connection between a source computer and a destination device using AWS IoT Secure Tunneling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsecuretunneling-tunnel.html
CloudformationResource:: AWS::IoTSecureTunneling::Tunnel
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.cfn_property_mixins import aws_iotsecuretunneling as iotsecuretunneling
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_tunnel_props_mixin = iotsecuretunneling.CfnTunnelPropsMixin(iotsecuretunneling.CfnTunnelMixinProps(
    description="description",
    destination_config=iotsecuretunneling.CfnTunnelPropsMixin.DestinationConfigProperty(
        services=["services"],
        thing_name="thingName"
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    timeout_config=iotsecuretunneling.CfnTunnelPropsMixin.TimeoutConfigProperty(
        max_lifetime_timeout_minutes=123
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::IoTSecureTunneling::Tunnel.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['description', 'destinationConfig', 'tags', 'timeoutConfig']

Static Methods

classmethod is_mixin(x)

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.

DestinationConfigProperty

class CfnTunnelPropsMixin.DestinationConfigProperty(*, services=None, thing_name=None)

Bases: object

The destination configuration.

Parameters:

services (Optional[Sequence[str]]) – A list of service names that identify the target application.
thing_name (Optional[str]) – The name of the IoT thing to which you want to connect.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsecuretunneling-tunnel-destinationconfig.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.cfn_property_mixins import aws_iotsecuretunneling as iotsecuretunneling

destination_config_property = iotsecuretunneling.CfnTunnelPropsMixin.DestinationConfigProperty(
    services=["services"],
    thing_name="thingName"
)

Attributes

services

A list of service names that identify the target application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsecuretunneling-tunnel-destinationconfig.html#cfn-iotsecuretunneling-tunnel-destinationconfig-services

thing_name

The name of the IoT thing to which you want to connect.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsecuretunneling-tunnel-destinationconfig.html#cfn-iotsecuretunneling-tunnel-destinationconfig-thingname

TimeoutConfigProperty

class CfnTunnelPropsMixin.TimeoutConfigProperty(*, max_lifetime_timeout_minutes=None)

Bases: object

Tunnel timeout configuration.

Parameters:: max_lifetime_timeout_minutes (Union[int, float, None]) – The maximum amount of time (in minutes) a tunnel can remain open.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsecuretunneling-tunnel-timeoutconfig.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.cfn_property_mixins import aws_iotsecuretunneling as iotsecuretunneling

timeout_config_property = iotsecuretunneling.CfnTunnelPropsMixin.TimeoutConfigProperty(
    max_lifetime_timeout_minutes=123
)

Attributes

max_lifetime_timeout_minutes

The maximum amount of time (in minutes) a tunnel can remain open.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsecuretunneling-tunnel-timeoutconfig.html#cfn-iotsecuretunneling-tunnel-timeoutconfig-maxlifetimetimeoutminutes