Package software.amazon.awscdk.services.iotsecuretunneling

Class CfnTunnel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotsecuretunneling.CfnTunnel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITunnelRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:12.052Z") @Stability(Stable) public class CfnTunnel extends CfnResource implements IInspectable, ITunnelRef, ITaggableV2
A connection between a source computer and a destination device using AWS IoT Secure Tunneling.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsecuretunneling.*;
 CfnTunnel cfnTunnel = CfnTunnel.Builder.create(this, "MyCfnTunnel")
         .description("description")
         .destinationConfig(DestinationConfigProperty.builder()
                 .services(List.of("services"))
                 // the properties below are optional
                 .thingName("thingName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutConfig(TimeoutConfigProperty.builder()
                 .maxLifetimeTimeoutMinutes(123)
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTunnel

      protected CfnTunnel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTunnel

      protected CfnTunnel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTunnel

      @Stability(Stable) public CfnTunnel(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnTunnelProps props)
      Create a new AWS::IoTSecureTunneling::Tunnel.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnTunnel

      @Stability(Stable) public CfnTunnel(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IoTSecureTunneling::Tunnel.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForTunnel

      @Stability(Stable) @NotNull public static String arnForTunnel(@NotNull ITunnelRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnTunnel

      @Stability(Stable) @NotNull public static Boolean isCfnTunnel(@NotNull Object x)
      Checks whether the given object is a CfnTunnel.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the tunnel.

      Valid values are OPEN and CLOSED.

    • getAttrTunnelArn

      @Stability(Stable) @NotNull public String getAttrTunnelArn()
      The Amazon Resource Name (ARN) of the tunnel.

    • getAttrTunnelId

      @Stability(Stable) @NotNull public String getAttrTunnelId()
      A unique alpha-numeric tunnel ID.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getTunnelRef

      @Stability(Stable) @NotNull public TunnelReference getTunnelRef()
      A reference to a Tunnel resource.
      Specified by:
      getTunnelRef in interface ITunnelRef

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A short text description of the tunnel.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A short text description of the tunnel.

    • getDestinationConfig

      @Stability(Stable) @Nullable public Object getDestinationConfig()
      The destination configuration.

      Returns union: either IResolvable or CfnTunnel.DestinationConfigProperty

    • setDestinationConfig

      @Stability(Stable) public void setDestinationConfig(@Nullable IResolvable value)
      The destination configuration.

    • setDestinationConfig

      @Stability(Stable) public void setDestinationConfig(@Nullable CfnTunnel.DestinationConfigProperty value)
      The destination configuration.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A collection of tag metadata.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A collection of tag metadata.

    • getTimeoutConfig

      @Stability(Stable) @Nullable public Object getTimeoutConfig()
      Tunnel timeout configuration.

      Returns union: either IResolvable or CfnTunnel.TimeoutConfigProperty

    • setTimeoutConfig

      @Stability(Stable) public void setTimeoutConfig(@Nullable IResolvable value)
      Tunnel timeout configuration.

    • setTimeoutConfig

      @Stability(Stable) public void setTimeoutConfig(@Nullable CfnTunnel.TimeoutConfigProperty value)
      Tunnel timeout configuration.