PrivateServiceAccess¶
- class oci.psa.models.PrivateServiceAccess(**kwargs)¶
Bases:
objectPrivate Service Access (PSA) is a new way to create private accesss for a service.
Attributes:
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess.
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess.
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess.
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess.
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess.
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess.
[Required] Gets the compartment_id of this PrivateServiceAccess.
Gets the defined_tags of this PrivateServiceAccess.
Gets the description of this PrivateServiceAccess.
[Required] Gets the display_name of this PrivateServiceAccess.
[Required] Gets the fqdns of this PrivateServiceAccess.
Gets the freeform_tags of this PrivateServiceAccess.
[Required] Gets the id of this PrivateServiceAccess.
Gets the ipv4_ip of this PrivateServiceAccess.
[Required] Gets the lifecycle_state of this PrivateServiceAccess.
Gets the nsg_ids of this PrivateServiceAccess.
Gets the security_attributes of this PrivateServiceAccess.
[Required] Gets the service_id of this PrivateServiceAccess.
[Required] Gets the subnet_id of this PrivateServiceAccess.
Gets the system_tags of this PrivateServiceAccess.
Gets the time_created of this PrivateServiceAccess.
Gets the time_updated of this PrivateServiceAccess.
[Required] Gets the vcn_id of this PrivateServiceAccess.
[Required] Gets the vnic_id of this PrivateServiceAccess.
Methods:
__init__(**kwargs)Initializes a new PrivateServiceAccess object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a PrivateServiceAccess. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new PrivateServiceAccess object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this PrivateServiceAccess.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateServiceAccess.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateServiceAccess.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivateServiceAccess.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this PrivateServiceAccess.
display_name (str) – The value to assign to the display_name property of this PrivateServiceAccess.
description (str) – The value to assign to the description property of this PrivateServiceAccess.
id (str) – The value to assign to the id property of this PrivateServiceAccess.
time_created (datetime) – The value to assign to the time_created property of this PrivateServiceAccess.
time_updated (datetime) – The value to assign to the time_updated property of this PrivateServiceAccess.
vcn_id (str) – The value to assign to the vcn_id property of this PrivateServiceAccess.
subnet_id (str) – The value to assign to the subnet_id property of this PrivateServiceAccess.
vnic_id (str) – The value to assign to the vnic_id property of this PrivateServiceAccess.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateServiceAccess. 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’.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PrivateServiceAccess.
service_id (str) – The value to assign to the service_id property of this PrivateServiceAccess.
fqdns (list[str]) – The value to assign to the fqdns property of this PrivateServiceAccess.
ipv4_ip (str) – The value to assign to the ipv4_ip property of this PrivateServiceAccess.
- property compartment_id¶
[Required] Gets the compartment_id of this PrivateServiceAccess. The OCID of the compartment that contains the private service access.
- Returns
The compartment_id of this PrivateServiceAccess.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this PrivateServiceAccess. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this PrivateServiceAccess.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this PrivateServiceAccess. A description of this private service access.
- Returns
The description of this PrivateServiceAccess.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this PrivateServiceAccess. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this PrivateServiceAccess.
- Return type
str
- property fqdns¶
[Required] Gets the fqdns of this PrivateServiceAccess. The private service access FQDNs, which are going to be used to access the service.
Example: xyz.oraclecloud.com
- Returns
The fqdns of this PrivateServiceAccess.
- Return type
list[str]
- property freeform_tags¶
Gets the freeform_tags of this PrivateServiceAccess. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this PrivateServiceAccess.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this PrivateServiceAccess. The OCID of the private service access.
- Returns
The id of this PrivateServiceAccess.
- Return type
str
- property ipv4_ip¶
Gets the ipv4_ip of this PrivateServiceAccess. The private IPv4 address (in the consumer’s VCN) that represents the access point for the associated service.
- Returns
The ipv4_ip of this PrivateServiceAccess.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this PrivateServiceAccess. The private service access’s current lifecycle state.
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 PrivateServiceAccess.
- Return type
str
- property nsg_ids¶
Gets the nsg_ids of this PrivateServiceAccess. A list of the OCIDs of the network security groups that the private service access’s VNIC belongs to. For more information about NSGs, see
NetworkSecurityGroup.- Returns
The nsg_ids of this PrivateServiceAccess.
- Return type
list[str]
- property security_attributes¶
Gets the security_attributes of this PrivateServiceAccess. Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.
Example: {“Oracle-DataSecurity-ZPR”: {“MaxEgressCount”: {“value”:”42”,”mode”:”audit”}}}
- Returns
The security_attributes of this PrivateServiceAccess.
- Return type
dict(str, dict(str, object))
- property service_id¶
[Required] Gets the service_id of this PrivateServiceAccess. A unique service identifier for which the private service access was created.
- Returns
The service_id of this PrivateServiceAccess.
- Return type
str
- property subnet_id¶
[Required] Gets the subnet_id of this PrivateServiceAccess. The OCID of the subnet that the private service access belongs to.
- Returns
The subnet_id of this PrivateServiceAccess.
- Return type
str
- property system_tags¶
Gets the system_tags of this PrivateServiceAccess. System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this PrivateServiceAccess.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this PrivateServiceAccess. The date and time the private service access was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this PrivateServiceAccess.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this PrivateServiceAccess. The date and time the PrivateServiceAccess was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_updated of this PrivateServiceAccess.
- Return type
datetime