BastionSummary¶
-
class
oci.bastion.models.
BastionSummary
(**kwargs)¶ Bases:
object
Summary information for 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
DNS_PROXY_STATUS_DISABLED
A constant which can be used with the dns_proxy_status property of a BastionSummary. DNS_PROXY_STATUS_ENABLED
A constant which can be used with the dns_proxy_status property of a BastionSummary. LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a BastionSummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a BastionSummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a BastionSummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a BastionSummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a BastionSummary. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a BastionSummary. bastion_type
[Required] Gets the bastion_type of this BastionSummary. compartment_id
[Required] Gets the compartment_id of this BastionSummary. defined_tags
Gets the defined_tags of this BastionSummary. dns_proxy_status
Gets the dns_proxy_status of this BastionSummary. freeform_tags
Gets the freeform_tags of this BastionSummary. id
[Required] Gets the id of this BastionSummary. lifecycle_details
Gets the lifecycle_details of this BastionSummary. lifecycle_state
[Required] Gets the lifecycle_state of this BastionSummary. name
[Required] Gets the name of this BastionSummary. system_tags
Gets the system_tags of this BastionSummary. target_subnet_id
[Required] Gets the target_subnet_id of this BastionSummary. target_vcn_id
[Required] Gets the target_vcn_id of this BastionSummary. time_created
[Required] Gets the time_created of this BastionSummary. time_updated
Gets the time_updated of this BastionSummary. Methods
__init__
(**kwargs)Initializes a new BastionSummary object with values from keyword arguments. -
DNS_PROXY_STATUS_DISABLED
= 'DISABLED'¶ A constant which can be used with the dns_proxy_status property of a BastionSummary. This constant has a value of “DISABLED”
-
DNS_PROXY_STATUS_ENABLED
= 'ENABLED'¶ A constant which can be used with the dns_proxy_status property of a BastionSummary. This constant has a value of “ENABLED”
-
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a BastionSummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a BastionSummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a BastionSummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a BastionSummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a BastionSummary. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a BastionSummary. This constant has a value of “UPDATING”
-
__init__
(**kwargs)¶ Initializes a new BastionSummary 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 BastionSummary.
- id (str) – The value to assign to the id property of this BastionSummary.
- name (str) – The value to assign to the name property of this BastionSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this BastionSummary.
- target_vcn_id (str) – The value to assign to the target_vcn_id property of this BastionSummary.
- target_subnet_id (str) – The value to assign to the target_subnet_id property of this BastionSummary.
- dns_proxy_status (str) – The value to assign to the dns_proxy_status property of this BastionSummary. Allowed values for this property are: “DISABLED”, “ENABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- time_created (datetime) – The value to assign to the time_created property of this BastionSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this BastionSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this BastionSummary. 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 BastionSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BastionSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BastionSummary.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BastionSummary.
-
bastion_type
¶ [Required] Gets the bastion_type of this BastionSummary. The type of bastion.
Returns: The bastion_type of this BastionSummary. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this BastionSummary. The unique identifier (OCID) of the compartment where the bastion is located.
Returns: The compartment_id of this BastionSummary. Return type: str
Gets the defined_tags of this BastionSummary. 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 BastionSummary. Return type: dict(str, dict(str, object))
-
dns_proxy_status
¶ Gets the dns_proxy_status of this BastionSummary. The current dns proxy status of the bastion.
Allowed values for this property are: “DISABLED”, “ENABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The dns_proxy_status of this BastionSummary. Return type: str
Gets the freeform_tags of this BastionSummary. 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 BastionSummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this BastionSummary. The unique identifier (OCID) of the bastion, which can’t be changed after creation.
Returns: The id of this BastionSummary. Return type: str
-
lifecycle_details
¶ Gets the lifecycle_details of this BastionSummary. A message describing the current state in more detail.
Returns: The lifecycle_details of this BastionSummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this BastionSummary. 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 BastionSummary. Return type: str
-
name
¶ [Required] Gets the name of this BastionSummary. The name of the bastion, which can’t be changed after creation.
Returns: The name of this BastionSummary. Return type: str
Gets the system_tags of this BastionSummary. 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 BastionSummary. Return type: dict(str, dict(str, object))
-
target_subnet_id
¶ [Required] Gets the target_subnet_id of this BastionSummary. The unique identifier (OCID) of the subnet that the bastion connects to.
Returns: The target_subnet_id of this BastionSummary. Return type: str
-
target_vcn_id
¶ [Required] Gets the target_vcn_id of this BastionSummary. The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
Returns: The target_vcn_id of this BastionSummary. Return type: str
-