CreateManagedSshSessionTargetResourceDetails¶
- class oci.bastion.models.CreateManagedSshSessionTargetResourceDetails(**kwargs)¶
Bases:
CreateSessionTargetResourceDetailsDetails about a managed SSH session for a target resource.
Attributes:
A constant which can be used with the session_type property of a CreateSessionTargetResourceDetails.
A constant which can be used with the session_type property of a CreateSessionTargetResourceDetails.
A constant which can be used with the session_type property of a CreateSessionTargetResourceDetails.
[Required] Gets the session_type of this CreateSessionTargetResourceDetails.
[Required] Gets the target_resource_id of this CreateManagedSshSessionTargetResourceDetails.
[Required] Gets the target_resource_operating_system_user_name of this CreateManagedSshSessionTargetResourceDetails.
Gets the target_resource_port of this CreateManagedSshSessionTargetResourceDetails.
Gets the target_resource_private_ip_address of this CreateManagedSshSessionTargetResourceDetails.
Methods:
__init__(**kwargs)Initializes a new CreateManagedSshSessionTargetResourceDetails 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_DYNAMIC_PORT_FORWARDING = 'DYNAMIC_PORT_FORWARDING'¶
A constant which can be used with the session_type property of a CreateSessionTargetResourceDetails. This constant has a value of “DYNAMIC_PORT_FORWARDING”
- SESSION_TYPE_MANAGED_SSH = 'MANAGED_SSH'¶
A constant which can be used with the session_type property of a CreateSessionTargetResourceDetails. This constant has a value of “MANAGED_SSH”
- SESSION_TYPE_PORT_FORWARDING = 'PORT_FORWARDING'¶
A constant which can be used with the session_type property of a CreateSessionTargetResourceDetails. This constant has a value of “PORT_FORWARDING”
- __init__(**kwargs)¶
Initializes a new CreateManagedSshSessionTargetResourceDetails object with values from keyword arguments. The default value of the
session_typeattribute of this class isMANAGED_SSHand 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 CreateManagedSshSessionTargetResourceDetails. Allowed values for this property are: “MANAGED_SSH”, “PORT_FORWARDING”, “DYNAMIC_PORT_FORWARDING”
target_resource_operating_system_user_name (str) – The value to assign to the target_resource_operating_system_user_name property of this CreateManagedSshSessionTargetResourceDetails.
target_resource_id (str) – The value to assign to the target_resource_id property of this CreateManagedSshSessionTargetResourceDetails.
target_resource_private_ip_address (str) – The value to assign to the target_resource_private_ip_address property of this CreateManagedSshSessionTargetResourceDetails.
target_resource_port (int) – The value to assign to the target_resource_port property of this CreateManagedSshSessionTargetResourceDetails.
- 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.
- property session_type¶
[Required] Gets the session_type of this CreateSessionTargetResourceDetails. The session type.
Allowed values for this property are: “MANAGED_SSH”, “PORT_FORWARDING”, “DYNAMIC_PORT_FORWARDING”
- Returns
The session_type of this CreateSessionTargetResourceDetails.
- Return type
str
- property target_resource_id¶
[Required] Gets the target_resource_id of this CreateManagedSshSessionTargetResourceDetails. 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 CreateManagedSshSessionTargetResourceDetails.
- Return type
str
- property target_resource_operating_system_user_name¶
[Required] Gets the target_resource_operating_system_user_name of this CreateManagedSshSessionTargetResourceDetails. The name of the user on the target resource operating system that the session uses for the connection.
- Returns
The target_resource_operating_system_user_name of this CreateManagedSshSessionTargetResourceDetails.
- Return type
str
- property target_resource_port¶
Gets the target_resource_port of this CreateManagedSshSessionTargetResourceDetails. The port number to connect to on the target resource.
- Returns
The target_resource_port of this CreateManagedSshSessionTargetResourceDetails.
- Return type
int
- property target_resource_private_ip_address¶
Gets the target_resource_private_ip_address of this CreateManagedSshSessionTargetResourceDetails. The private IP address of the target resource that the session connects to.
- Returns
The target_resource_private_ip_address of this CreateManagedSshSessionTargetResourceDetails.
- Return type
str