Interface Tunnel.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Tunnel.Builder,Tunnel>, SdkBuilder<Tunnel.Builder,Tunnel>, SdkPojo
Enclosing class:
Tunnel
@Mutable @NotThreadSafe public static interface Tunnel.Builder extends SdkPojo, CopyableBuilder<Tunnel.Builder,Tunnel>

  • Method Details

    • tunnelId

      Tunnel.Builder tunnelId(String tunnelId)

      A unique alpha-numeric ID that identifies a tunnel.

      Parameters:
      tunnelId - A unique alpha-numeric ID that identifies a tunnel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tunnelArn

      Tunnel.Builder tunnelArn(String tunnelArn)

      The Amazon Resource Name (ARN) of a tunnel.

      Parameters:
      tunnelArn - The Amazon Resource Name (ARN) of a tunnel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Tunnel.Builder status(String status)

      The status of a tunnel. Valid values are: Open and Closed.

      Parameters:
      status - The status of a tunnel. Valid values are: Open and Closed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Tunnel.Builder status(TunnelStatus status)

      The status of a tunnel. Valid values are: Open and Closed.

      Parameters:
      status - The status of a tunnel. Valid values are: Open and Closed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceConnectionState

      Tunnel.Builder sourceConnectionState(ConnectionState sourceConnectionState)

      The connection state of the source application.

      Parameters:
      sourceConnectionState - The connection state of the source application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceConnectionState

      default Tunnel.Builder sourceConnectionState(Consumer<ConnectionState.Builder> sourceConnectionState)

      The connection state of the source application.

      This is a convenience method that creates an instance of the ConnectionState.Builder avoiding the need to create one manually via ConnectionState.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceConnectionState(ConnectionState).

      Parameters:
      sourceConnectionState - a consumer that will call methods on ConnectionState.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationConnectionState

      Tunnel.Builder destinationConnectionState(ConnectionState destinationConnectionState)

      The connection state of the destination application.

      Parameters:
      destinationConnectionState - The connection state of the destination application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationConnectionState

      default Tunnel.Builder destinationConnectionState(Consumer<ConnectionState.Builder> destinationConnectionState)

      The connection state of the destination application.

      This is a convenience method that creates an instance of the ConnectionState.Builder avoiding the need to create one manually via ConnectionState.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationConnectionState(ConnectionState).

      Parameters:
      destinationConnectionState - a consumer that will call methods on ConnectionState.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      Tunnel.Builder description(String description)

      A description of the tunnel.

      Parameters:
      description - A description of the tunnel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationConfig

      Tunnel.Builder destinationConfig(DestinationConfig destinationConfig)

      The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

      Parameters:
      destinationConfig - The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationConfig

      default Tunnel.Builder destinationConfig(Consumer<DestinationConfig.Builder> destinationConfig)

      The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

      This is a convenience method that creates an instance of the DestinationConfig.Builder avoiding the need to create one manually via DestinationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationConfig(DestinationConfig).

      Parameters:
      destinationConfig - a consumer that will call methods on DestinationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeoutConfig

      Tunnel.Builder timeoutConfig(TimeoutConfig timeoutConfig)

      Timeout configuration for the tunnel.

      Parameters:
      timeoutConfig - Timeout configuration for the tunnel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutConfig

      default Tunnel.Builder timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)

      Timeout configuration for the tunnel.

      This is a convenience method that creates an instance of the TimeoutConfig.Builder avoiding the need to create one manually via TimeoutConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeoutConfig(TimeoutConfig).

      Parameters:
      timeoutConfig - a consumer that will call methods on TimeoutConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Tunnel.Builder tags(Collection<Tag> tags)

      A list of tag metadata associated with the secure tunnel.

      Parameters:
      tags - A list of tag metadata associated with the secure tunnel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Tunnel.Builder tags(Tag... tags)

      A list of tag metadata associated with the secure tunnel.

      Parameters:
      tags - A list of tag metadata associated with the secure tunnel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Tunnel.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tag metadata associated with the secure tunnel.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Tunnel.Builder createdAt(Instant createdAt)

      The time when the tunnel was created.

      Parameters:
      createdAt - The time when the tunnel was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      Tunnel.Builder lastUpdatedAt(Instant lastUpdatedAt)

      The last time the tunnel was updated.

      Parameters:
      lastUpdatedAt - The last time the tunnel was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.