PortForwardingSessionTargetResourceDetails

class oci.bastion.models.PortForwardingSessionTargetResourceDetails(**kwargs)

Bases: oci.bastion.models.target_resource_details.TargetResourceDetails

Details about a port forwarding session for a target resource.

Attributes

SESSION_TYPE_MANAGED_SSH str(object=’’) -> str
SESSION_TYPE_PORT_FORWARDING str(object=’’) -> str
session_type [Required] Gets the session_type of this TargetResourceDetails.
target_resource_display_name Gets the target_resource_display_name of this PortForwardingSessionTargetResourceDetails.
target_resource_id Gets the target_resource_id of this PortForwardingSessionTargetResourceDetails.
target_resource_port [Required] Gets the target_resource_port of this TargetResourceDetails.
target_resource_private_ip_address Gets the target_resource_private_ip_address of this PortForwardingSessionTargetResourceDetails.

Methods

__init__(**kwargs) Initializes a new PortForwardingSessionTargetResourceDetails object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
SESSION_TYPE_MANAGED_SSH = 'MANAGED_SSH'
SESSION_TYPE_PORT_FORWARDING = 'PORT_FORWARDING'
__init__(**kwargs)

Initializes a new PortForwardingSessionTargetResourceDetails object with values from keyword arguments. The default value of the session_type attribute of this class is PORT_FORWARDING and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • session_type (str) – The value to assign to the session_type property of this PortForwardingSessionTargetResourceDetails. Allowed values for this property are: “MANAGED_SSH”, “PORT_FORWARDING”
  • target_resource_port (int) – The value to assign to the target_resource_port property of this PortForwardingSessionTargetResourceDetails.
  • target_resource_id (str) – The value to assign to the target_resource_id property of this PortForwardingSessionTargetResourceDetails.
  • target_resource_private_ip_address (str) – The value to assign to the target_resource_private_ip_address property of this PortForwardingSessionTargetResourceDetails.
  • target_resource_display_name (str) – The value to assign to the target_resource_display_name property of this PortForwardingSessionTargetResourceDetails.
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

session_type

[Required] Gets the session_type of this TargetResourceDetails. The Bastion service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.

Allowed values for this property are: “MANAGED_SSH”, “PORT_FORWARDING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The session_type of this TargetResourceDetails.
Return type:str
target_resource_display_name

Gets the target_resource_display_name of this PortForwardingSessionTargetResourceDetails. The display name of the target Compute instance that the session connects to.

Returns:The target_resource_display_name of this PortForwardingSessionTargetResourceDetails.
Return type:str
target_resource_id

Gets the target_resource_id of this PortForwardingSessionTargetResourceDetails. The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

Returns:The target_resource_id of this PortForwardingSessionTargetResourceDetails.
Return type:str
target_resource_port

[Required] Gets the target_resource_port of this TargetResourceDetails. The port number to connect to on the target resource.

Returns:The target_resource_port of this TargetResourceDetails.
Return type:int
target_resource_private_ip_address

Gets the target_resource_private_ip_address of this PortForwardingSessionTargetResourceDetails. The private IP address of the target resource that the session connects to.

Returns:The target_resource_private_ip_address of this PortForwardingSessionTargetResourceDetails.
Return type:str