The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::IoTSecureTunneling::OpenTunnel - Arguments for method OpenTunnel on Paws::IoTSecureTunneling

DESCRIPTION

This class represents the parameters used for calling the method OpenTunnel on the AWS IoT Secure Tunneling service. Use the attributes of this class as arguments to method OpenTunnel.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to OpenTunnel.

SYNOPSIS

    my $api.tunneling.iot = Paws->service('IoTSecureTunneling');
    my $OpenTunnelResponse = $api . tunneling . iot->OpenTunnel(
      Description       => 'MyDescription',    # OPTIONAL
      DestinationConfig => {
        Services => [
          'MyService', ...                     # min: 1, max: 128
        ],    # min: 1
        ThingName => 'MyThingName',    # min: 1, max: 128; OPTIONAL
      },    # OPTIONAL
      Tags => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # max: 256

        },
        ...
      ],    # OPTIONAL
      TimeoutConfig => {
        MaxLifetimeTimeoutMinutes => 1,    # min: 1, max: 720; OPTIONAL
      },    # OPTIONAL
    );

    # Results:
    my $DestinationAccessToken = $OpenTunnelResponse->DestinationAccessToken;
    my $SourceAccessToken      = $OpenTunnelResponse->SourceAccessToken;
    my $TunnelArn              = $OpenTunnelResponse->TunnelArn;
    my $TunnelId               = $OpenTunnelResponse->TunnelId;

    # Returns a L<Paws::IoTSecureTunneling::OpenTunnelResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.tunneling.iot/OpenTunnel

ATTRIBUTES

Description => Str

A short text description of the tunnel.

DestinationConfig => Paws::IoTSecureTunneling::DestinationConfig

The destination configuration for the OpenTunnel request.

Tags => ArrayRef[Paws::IoTSecureTunneling::Tag]

A collection of tag metadata.

TimeoutConfig => Paws::IoTSecureTunneling::TimeoutConfig

Timeout configuration for a tunnel.

SEE ALSO

This class forms part of Paws, documenting arguments for method OpenTunnel in Paws::IoTSecureTunneling

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues