PrivateServiceAccessSummary

class oci.psa.models.PrivateServiceAccessSummary(**kwargs)

Bases: object

A summary of private service access information. This object is returned when listing private service accesses.

Methods:

__init__(**kwargs)

Initializes a new PrivateServiceAccessSummary object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this PrivateServiceAccessSummary.

defined_tags

Gets the defined_tags of this PrivateServiceAccessSummary.

description

Gets the description of this PrivateServiceAccessSummary.

display_name

[Required] Gets the display_name of this PrivateServiceAccessSummary.

fqdns

[Required] Gets the fqdns of this PrivateServiceAccessSummary.

freeform_tags

Gets the freeform_tags of this PrivateServiceAccessSummary.

id

[Required] Gets the id of this PrivateServiceAccessSummary.

ipv4_ip

Gets the ipv4_ip of this PrivateServiceAccessSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this PrivateServiceAccessSummary.

nsg_ids

Gets the nsg_ids of this PrivateServiceAccessSummary.

security_attributes

Gets the security_attributes of this PrivateServiceAccessSummary.

service_id

[Required] Gets the service_id of this PrivateServiceAccessSummary.

subnet_id

[Required] Gets the subnet_id of this PrivateServiceAccessSummary.

system_tags

Gets the system_tags of this PrivateServiceAccessSummary.

time_created

Gets the time_created of this PrivateServiceAccessSummary.

time_updated

Gets the time_updated of this PrivateServiceAccessSummary.

vcn_id

[Required] Gets the vcn_id of this PrivateServiceAccessSummary.

vnic_id

[Required] Gets the vnic_id of this PrivateServiceAccessSummary.

__init__(**kwargs)

Initializes a new PrivateServiceAccessSummary 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 PrivateServiceAccessSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateServiceAccessSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateServiceAccessSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivateServiceAccessSummary.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this PrivateServiceAccessSummary.

  • display_name (str) – The value to assign to the display_name property of this PrivateServiceAccessSummary.

  • description (str) – The value to assign to the description property of this PrivateServiceAccessSummary.

  • id (str) – The value to assign to the id property of this PrivateServiceAccessSummary.

  • time_created (datetime) – The value to assign to the time_created property of this PrivateServiceAccessSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this PrivateServiceAccessSummary.

  • vcn_id (str) – The value to assign to the vcn_id property of this PrivateServiceAccessSummary.

  • subnet_id (str) – The value to assign to the subnet_id property of this PrivateServiceAccessSummary.

  • vnic_id (str) – The value to assign to the vnic_id property of this PrivateServiceAccessSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateServiceAccessSummary.

  • service_id (str) – The value to assign to the service_id property of this PrivateServiceAccessSummary.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PrivateServiceAccessSummary.

  • fqdns (list[str]) – The value to assign to the fqdns property of this PrivateServiceAccessSummary.

  • ipv4_ip (str) – The value to assign to the ipv4_ip property of this PrivateServiceAccessSummary.

property compartment_id

[Required] Gets the compartment_id of this PrivateServiceAccessSummary. The OCID of the compartment that contains the private service access.

Returns

The compartment_id of this PrivateServiceAccessSummary.

Return type

str

property defined_tags

Gets the defined_tags of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this PrivateServiceAccessSummary. A description of this private service access.

Returns

The description of this PrivateServiceAccessSummary.

Return type

str

property display_name

[Required] Gets the display_name of this PrivateServiceAccessSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this PrivateServiceAccessSummary.

Return type

str

property fqdns

[Required] Gets the fqdns of this PrivateServiceAccessSummary. The private service access IPv4 FQDNs, which are going to be used to access the service.

Example: xyz.oraclecloud.com

Returns

The fqdns of this PrivateServiceAccessSummary.

Return type

list[str]

property freeform_tags

Gets the freeform_tags of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this PrivateServiceAccessSummary. The OCID of the private service access.

Returns

The id of this PrivateServiceAccessSummary.

Return type

str

property ipv4_ip

Gets the ipv4_ip of this PrivateServiceAccessSummary. The private IP address (in the consumer’s VCN) that represents the access point for the associated service.

Returns

The ipv4_ip of this PrivateServiceAccessSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this PrivateServiceAccessSummary. The private service access’s current lifecycle state.

Returns

The lifecycle_state of this PrivateServiceAccessSummary.

Return type

str

property nsg_ids

Gets the nsg_ids of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

list[str]

property security_attributes

Gets the security_attributes of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

dict(str, dict(str, object))

property service_id

[Required] Gets the service_id of this PrivateServiceAccessSummary. A unique service identifier for which the private service access was created.

Returns

The service_id of this PrivateServiceAccessSummary.

Return type

str

property subnet_id

[Required] Gets the subnet_id of this PrivateServiceAccessSummary. The OCID of the subnet that the private service access belongs to.

Returns

The subnet_id of this PrivateServiceAccessSummary.

Return type

str

property system_tags

Gets the system_tags of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

datetime

property time_updated

Gets the time_updated of this PrivateServiceAccessSummary. 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 PrivateServiceAccessSummary.

Return type

datetime

property vcn_id

[Required] Gets the vcn_id of this PrivateServiceAccessSummary. The OCID of the VCN that the private service access belongs to.

Returns

The vcn_id of this PrivateServiceAccessSummary.

Return type

str

property vnic_id

[Required] Gets the vnic_id of this PrivateServiceAccessSummary. An OCID of the private service access’s VNIC, which resides in the private service access’s VCN .

Returns

The vnic_id of this PrivateServiceAccessSummary.

Return type

str