Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Analytics
  5. getAnalyticsInstancePrivateAccessChannel
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Analytics.getAnalyticsInstancePrivateAccessChannel

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Analytics Instance Private Access Channel resource in Oracle Cloud Infrastructure Analytics service.

Retrieve private access channel in the specified Analytics Instance.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAnalyticsInstancePrivateAccessChannel = oci.Analytics.getAnalyticsInstancePrivateAccessChannel({
    analyticsInstanceId: testAnalyticsInstance.id,
    privateAccessChannelKey: analyticsInstancePrivateAccessChannelPrivateAccessChannelKey,
});
Copy
import pulumi
import pulumi_oci as oci

test_analytics_instance_private_access_channel = oci.Analytics.get_analytics_instance_private_access_channel(analytics_instance_id=test_analytics_instance["id"],
    private_access_channel_key=analytics_instance_private_access_channel_private_access_channel_key)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/analytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := analytics.GetAnalyticsInstancePrivateAccessChannel(ctx, &analytics.GetAnalyticsInstancePrivateAccessChannelArgs{
			AnalyticsInstanceId:     testAnalyticsInstance.Id,
			PrivateAccessChannelKey: analyticsInstancePrivateAccessChannelPrivateAccessChannelKey,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAnalyticsInstancePrivateAccessChannel = Oci.Analytics.GetAnalyticsInstancePrivateAccessChannel.Invoke(new()
    {
        AnalyticsInstanceId = testAnalyticsInstance.Id,
        PrivateAccessChannelKey = analyticsInstancePrivateAccessChannelPrivateAccessChannelKey,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Analytics.AnalyticsFunctions;
import com.pulumi.oci.Analytics.inputs.GetAnalyticsInstancePrivateAccessChannelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testAnalyticsInstancePrivateAccessChannel = AnalyticsFunctions.getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs.builder()
            .analyticsInstanceId(testAnalyticsInstance.id())
            .privateAccessChannelKey(analyticsInstancePrivateAccessChannelPrivateAccessChannelKey)
            .build());

    }
}
Copy
variables:
  testAnalyticsInstancePrivateAccessChannel:
    fn::invoke:
      function: oci:Analytics:getAnalyticsInstancePrivateAccessChannel
      arguments:
        analyticsInstanceId: ${testAnalyticsInstance.id}
        privateAccessChannelKey: ${analyticsInstancePrivateAccessChannelPrivateAccessChannelKey}
Copy

Using getAnalyticsInstancePrivateAccessChannel

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAnalyticsInstancePrivateAccessChannel(args: GetAnalyticsInstancePrivateAccessChannelArgs, opts?: InvokeOptions): Promise<GetAnalyticsInstancePrivateAccessChannelResult>
function getAnalyticsInstancePrivateAccessChannelOutput(args: GetAnalyticsInstancePrivateAccessChannelOutputArgs, opts?: InvokeOptions): Output<GetAnalyticsInstancePrivateAccessChannelResult>
Copy
def get_analytics_instance_private_access_channel(analytics_instance_id: Optional[str] = None,
                                                  private_access_channel_key: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetAnalyticsInstancePrivateAccessChannelResult
def get_analytics_instance_private_access_channel_output(analytics_instance_id: Optional[pulumi.Input[str]] = None,
                                                  private_access_channel_key: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetAnalyticsInstancePrivateAccessChannelResult]
Copy
func GetAnalyticsInstancePrivateAccessChannel(ctx *Context, args *GetAnalyticsInstancePrivateAccessChannelArgs, opts ...InvokeOption) (*GetAnalyticsInstancePrivateAccessChannelResult, error)
func GetAnalyticsInstancePrivateAccessChannelOutput(ctx *Context, args *GetAnalyticsInstancePrivateAccessChannelOutputArgs, opts ...InvokeOption) GetAnalyticsInstancePrivateAccessChannelResultOutput
Copy

> Note: This function is named GetAnalyticsInstancePrivateAccessChannel in the Go SDK.

public static class GetAnalyticsInstancePrivateAccessChannel 
{
    public static Task<GetAnalyticsInstancePrivateAccessChannelResult> InvokeAsync(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalyticsInstancePrivateAccessChannelResult> Invoke(GetAnalyticsInstancePrivateAccessChannelInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAnalyticsInstancePrivateAccessChannelResult> getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOptions options)
public static Output<GetAnalyticsInstancePrivateAccessChannelResult> getAnalyticsInstancePrivateAccessChannel(GetAnalyticsInstancePrivateAccessChannelArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Analytics/getAnalyticsInstancePrivateAccessChannel:getAnalyticsInstancePrivateAccessChannel
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AnalyticsInstanceId This property is required. string
The OCID of the AnalyticsInstance.
PrivateAccessChannelKey This property is required. string
The unique identifier key of the Private Access Channel.
AnalyticsInstanceId This property is required. string
The OCID of the AnalyticsInstance.
PrivateAccessChannelKey This property is required. string
The unique identifier key of the Private Access Channel.
analyticsInstanceId This property is required. String
The OCID of the AnalyticsInstance.
privateAccessChannelKey This property is required. String
The unique identifier key of the Private Access Channel.
analyticsInstanceId This property is required. string
The OCID of the AnalyticsInstance.
privateAccessChannelKey This property is required. string
The unique identifier key of the Private Access Channel.
analytics_instance_id This property is required. str
The OCID of the AnalyticsInstance.
private_access_channel_key This property is required. str
The unique identifier key of the Private Access Channel.
analyticsInstanceId This property is required. String
The OCID of the AnalyticsInstance.
privateAccessChannelKey This property is required. String
The unique identifier key of the Private Access Channel.

getAnalyticsInstancePrivateAccessChannel Result

The following output properties are available:

AnalyticsInstanceId string
DisplayName string
Display Name of the Private Access Channel.
EgressSourceIpAddresses List<string>
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
Id string
IpAddress string
IP Address of the Private Access channel.
Key string
Private Access Channel unique identifier key.
NetworkSecurityGroupIds List<string>
Network Security Group OCIDs for an Analytics instance.
PrivateAccessChannelKey string
PrivateSourceDnsZones List<GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone>
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
PrivateSourceScanHosts List<GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost>
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
SubnetId string
OCID of the customer subnet connected to private access channel.
VcnId string
OCID of the customer VCN peered with private access channel.
AnalyticsInstanceId string
DisplayName string
Display Name of the Private Access Channel.
EgressSourceIpAddresses []string
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
Id string
IpAddress string
IP Address of the Private Access channel.
Key string
Private Access Channel unique identifier key.
NetworkSecurityGroupIds []string
Network Security Group OCIDs for an Analytics instance.
PrivateAccessChannelKey string
PrivateSourceDnsZones []GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
PrivateSourceScanHosts []GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
SubnetId string
OCID of the customer subnet connected to private access channel.
VcnId string
OCID of the customer VCN peered with private access channel.
analyticsInstanceId String
displayName String
Display Name of the Private Access Channel.
egressSourceIpAddresses List<String>
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
id String
ipAddress String
IP Address of the Private Access channel.
key String
Private Access Channel unique identifier key.
networkSecurityGroupIds List<String>
Network Security Group OCIDs for an Analytics instance.
privateAccessChannelKey String
privateSourceDnsZones List<GetInstancePrivateAccessChannelPrivateSourceDnsZone>
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
privateSourceScanHosts List<GetInstancePrivateAccessChannelPrivateSourceScanHost>
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
subnetId String
OCID of the customer subnet connected to private access channel.
vcnId String
OCID of the customer VCN peered with private access channel.
analyticsInstanceId string
displayName string
Display Name of the Private Access Channel.
egressSourceIpAddresses string[]
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
id string
ipAddress string
IP Address of the Private Access channel.
key string
Private Access Channel unique identifier key.
networkSecurityGroupIds string[]
Network Security Group OCIDs for an Analytics instance.
privateAccessChannelKey string
privateSourceDnsZones GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone[]
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
privateSourceScanHosts GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost[]
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
subnetId string
OCID of the customer subnet connected to private access channel.
vcnId string
OCID of the customer VCN peered with private access channel.
analytics_instance_id str
display_name str
Display Name of the Private Access Channel.
egress_source_ip_addresses Sequence[str]
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
id str
ip_address str
IP Address of the Private Access channel.
key str
Private Access Channel unique identifier key.
network_security_group_ids Sequence[str]
Network Security Group OCIDs for an Analytics instance.
private_access_channel_key str
private_source_dns_zones Sequence[analytics.GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone]
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
private_source_scan_hosts Sequence[analytics.GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost]
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
subnet_id str
OCID of the customer subnet connected to private access channel.
vcn_id str
OCID of the customer VCN peered with private access channel.
analyticsInstanceId String
displayName String
Display Name of the Private Access Channel.
egressSourceIpAddresses List<String>
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
id String
ipAddress String
IP Address of the Private Access channel.
key String
Private Access Channel unique identifier key.
networkSecurityGroupIds List<String>
Network Security Group OCIDs for an Analytics instance.
privateAccessChannelKey String
privateSourceDnsZones List<Property Map>
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
privateSourceScanHosts List<Property Map>
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
subnetId String
OCID of the customer subnet connected to private access channel.
vcnId String
OCID of the customer VCN peered with private access channel.

Supporting Types

GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone

Description This property is required. string
Description of private source scan host zone.
DnsZone This property is required. string
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
Description This property is required. string
Description of private source scan host zone.
DnsZone This property is required. string
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
description This property is required. String
Description of private source scan host zone.
dnsZone This property is required. String
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
description This property is required. string
Description of private source scan host zone.
dnsZone This property is required. string
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
description This property is required. str
Description of private source scan host zone.
dns_zone This property is required. str
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
description This property is required. String
Description of private source scan host zone.
dnsZone This property is required. String
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.

GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost

Description This property is required. string
Description of private source scan host zone.
ScanHostname This property is required. string
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
ScanPort This property is required. int
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
Description This property is required. string
Description of private source scan host zone.
ScanHostname This property is required. string
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
ScanPort This property is required. int
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
description This property is required. String
Description of private source scan host zone.
scanHostname This property is required. String
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
scanPort This property is required. Integer
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
description This property is required. string
Description of private source scan host zone.
scanHostname This property is required. string
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
scanPort This property is required. number
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
description This property is required. str
Description of private source scan host zone.
scan_hostname This property is required. str
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
scan_port This property is required. int
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
description This property is required. String
Description of private source scan host zone.
scanHostname This property is required. String
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
scanPort This property is required. Number
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci