Private Service Access: PrivateServiceAccess¶
Manage OCI Private Service Access resources. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | psa |
| Resource | PrivateServiceAccess |
| API Version | psa.oracle.com/v1beta1 |
| Package | Private Service Access |
| Support Status | Preview |
| Latest Released Version | Not yet released |
| Install Namespace | oci-service-operator-psa-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/psa_v1beta1_privateserviceaccess.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the private service access. | string |
Yes |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
description |
A description of this private service accesss. | string |
No |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
ipv4Ip |
The private IPv4 address (in the consumer's VCN) that represents the access point for the associated service. | string |
No |
nsgIds |
A list of the OCIDs of the network security groups (NSGs) to add the private service access's VNIC to. For more information about NSGs, see NetworkSecurityGroup. | list[string] |
No |
securityAttributes |
Security attributes (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a Zero Trust Packet Routing (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}} |
map[string, map[string, string]] |
No |
serviceId |
A unique service identifier for which the private service access was created. | string |
Yes |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN's subnet where the private service access's VNIC will reside. | string |
Yes |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the private service access. | string |
No |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
description |
A description of this private service access. | string |
No |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No |
fqdns |
The private service access FQDNs, which are going to be used to access the service. Example: xyz.oraclecloud.com |
list[string] |
No |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private service access. | string |
No |
ipv4Ip |
The private IPv4 address (in the consumer's VCN) that represents the access point for the associated service. | string |
No |
lifecycleState |
The private service access's current lifecycle state. | string |
No |
nsgIds |
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. | list[string] |
No |
securityAttributes |
Security attributes (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a Zero Trust Packet Routing (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}} |
map[string, map[string, string]] |
No |
serviceId |
A unique service identifier for which the private service access was created. | string |
No |
status |
- | object |
Yes |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private service access belongs to. | string |
No |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
timeCreated |
The date and time the private service access was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
timeUpdated |
The date and time the PrivateServiceAccess was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
vcnId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN that the private service access belongs to. | string |
No |
vnicId |
An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private service access's VNIC, which resides in the private service access's VCN . | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/psa_v1beta1_privateserviceaccess.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
#
# Replace the OCI identifiers below before running e2e.
# Update metadata.name or spec.displayName if you want to force a fresh create instead of
# binding to an existing PrivateServiceAccess with the same compartmentId, serviceId,
# subnetId, and displayName.
#
apiVersion: psa.oracle.com/v1beta1
kind: PrivateServiceAccess
metadata:
name: privateserviceaccess-sample
spec:
compartmentId: ocid1.compartment.oc1..exampleuniqueID
subnetId: ocid1.subnet.oc1..exampleuniqueID
serviceId: ocid1.psaservice.oc1..exampleuniqueID
displayName: privateserviceaccess-sample
description: Sample PrivateServiceAccess managed by OCI Service Operator
freeformTags:
managed-by: oci-service-operator