Bastion

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

Bases: object

A bastion resource. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Bastion.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Bastion.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Bastion.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Bastion.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Bastion.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Bastion.
bastion_type [Required] Gets the bastion_type of this Bastion.
client_cidr_block_allow_list Gets the client_cidr_block_allow_list of this Bastion.
compartment_id [Required] Gets the compartment_id of this Bastion.
defined_tags Gets the defined_tags of this Bastion.
freeform_tags Gets the freeform_tags of this Bastion.
id [Required] Gets the id of this Bastion.
lifecycle_details Gets the lifecycle_details of this Bastion.
lifecycle_state [Required] Gets the lifecycle_state of this Bastion.
max_session_ttl_in_seconds [Required] Gets the max_session_ttl_in_seconds of this Bastion.
max_sessions_allowed Gets the max_sessions_allowed of this Bastion.
name [Required] Gets the name of this Bastion.
phone_book_entry Gets the phone_book_entry of this Bastion.
private_endpoint_ip_address Gets the private_endpoint_ip_address of this Bastion.
static_jump_host_ip_addresses Gets the static_jump_host_ip_addresses of this Bastion.
system_tags Gets the system_tags of this Bastion.
target_subnet_id [Required] Gets the target_subnet_id of this Bastion.
target_vcn_id [Required] Gets the target_vcn_id of this Bastion.
time_created [Required] Gets the time_created of this Bastion.
time_updated Gets the time_updated of this Bastion.

Methods

__init__(**kwargs) Initializes a new Bastion object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Bastion. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Bastion. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Bastion. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Bastion. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Bastion. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Bastion. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Bastion object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • bastion_type (str) – The value to assign to the bastion_type property of this Bastion.
  • id (str) – The value to assign to the id property of this Bastion.
  • name (str) – The value to assign to the name property of this Bastion.
  • compartment_id (str) – The value to assign to the compartment_id property of this Bastion.
  • target_vcn_id (str) – The value to assign to the target_vcn_id property of this Bastion.
  • target_subnet_id (str) – The value to assign to the target_subnet_id property of this Bastion.
  • phone_book_entry (str) – The value to assign to the phone_book_entry property of this Bastion.
  • client_cidr_block_allow_list (list[str]) – The value to assign to the client_cidr_block_allow_list property of this Bastion.
  • static_jump_host_ip_addresses (list[str]) – The value to assign to the static_jump_host_ip_addresses property of this Bastion.
  • private_endpoint_ip_address (str) – The value to assign to the private_endpoint_ip_address property of this Bastion.
  • max_session_ttl_in_seconds (int) – The value to assign to the max_session_ttl_in_seconds property of this Bastion.
  • max_sessions_allowed (int) – The value to assign to the max_sessions_allowed property of this Bastion.
  • time_created (datetime) – The value to assign to the time_created property of this Bastion.
  • time_updated (datetime) – The value to assign to the time_updated property of this Bastion.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Bastion. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Bastion.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Bastion.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Bastion.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Bastion.
bastion_type

[Required] Gets the bastion_type of this Bastion. The type of bastion.

Returns:The bastion_type of this Bastion.
Return type:str
client_cidr_block_allow_list

Gets the client_cidr_block_allow_list of this Bastion. A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.

Returns:The client_cidr_block_allow_list of this Bastion.
Return type:list[str]
compartment_id

[Required] Gets the compartment_id of this Bastion. The unique identifier (OCID) of the compartment where the bastion is located.

Returns:The compartment_id of this Bastion.
Return type:str
defined_tags

Gets the defined_tags of this Bastion. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this Bastion.
Return type:dict(str, dict(str, object))
freeform_tags

Gets the freeform_tags of this Bastion. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:The freeform_tags of this Bastion.
Return type:dict(str, str)
id

[Required] Gets the id of this Bastion. The unique identifier (OCID) of the bastion, which can’t be changed after creation.

Returns:The id of this Bastion.
Return type:str
lifecycle_details

Gets the lifecycle_details of this Bastion. A message describing the current state in more detail.

Returns:The lifecycle_details of this Bastion.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this Bastion. The current state of the bastion.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Bastion.
Return type:str
max_session_ttl_in_seconds

[Required] Gets the max_session_ttl_in_seconds of this Bastion. The maximum amount of time that any session on the bastion can remain active.

Returns:The max_session_ttl_in_seconds of this Bastion.
Return type:int
max_sessions_allowed

Gets the max_sessions_allowed of this Bastion. The maximum number of active sessions allowed on the bastion.

Returns:The max_sessions_allowed of this Bastion.
Return type:int
name

[Required] Gets the name of this Bastion. The name of the bastion, which can’t be changed after creation.

Returns:The name of this Bastion.
Return type:str
phone_book_entry

Gets the phone_book_entry of this Bastion. The phonebook entry of the customer’s team, which can’t be changed after creation. Not applicable to standard bastions.

Returns:The phone_book_entry of this Bastion.
Return type:str
private_endpoint_ip_address

Gets the private_endpoint_ip_address of this Bastion. The private IP address of the created private endpoint.

Returns:The private_endpoint_ip_address of this Bastion.
Return type:str
static_jump_host_ip_addresses

Gets the static_jump_host_ip_addresses of this Bastion. A list of IP addresses of the hosts that the bastion has access to. Not applicable to standard bastions.

Returns:The static_jump_host_ip_addresses of this Bastion.
Return type:list[str]
system_tags

Gets the system_tags of this Bastion. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this Bastion.
Return type:dict(str, dict(str, object))
target_subnet_id

[Required] Gets the target_subnet_id of this Bastion. The unique identifier (OCID) of the subnet that the bastion connects to.

Returns:The target_subnet_id of this Bastion.
Return type:str
target_vcn_id

[Required] Gets the target_vcn_id of this Bastion. The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.

Returns:The target_vcn_id of this Bastion.
Return type:str
time_created

[Required] Gets the time_created of this Bastion. The time the bastion was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:The time_created of this Bastion.
Return type:datetime
time_updated

Gets the time_updated of this Bastion. The time the bastion was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:The time_updated of this Bastion.
Return type:datetime