Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Analytics
  5. AnalyticsInstancePrivateAccessChannel
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Analytics.AnalyticsInstancePrivateAccessChannel

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Analytics Instance Private Access Channel resource in Oracle Cloud Infrastructure Analytics service.

    Create a Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.

    Example Usage

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

const testAnalyticsInstancePrivateAccessChannel = new oci.analytics.AnalyticsInstancePrivateAccessChannel("test_analytics_instance_private_access_channel", {
    analyticsInstanceId: testAnalyticsInstance.id,
    displayName: analyticsInstancePrivateAccessChannelDisplayName,
    privateSourceDnsZones: [{
        dnsZone: analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDnsZone,
        description: analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDescription,
    }],
    subnetId: testSubnet.id,
    vcnId: testVcn.id,
    networkSecurityGroupIds: analyticsInstancePrivateAccessChannelNetworkSecurityGroupIds,
    privateSourceScanHosts: [{
        scanHostname: analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanHostname,
        scanPort: analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanPort,
        description: analyticsInstancePrivateAccessChannelPrivateSourceScanHostsDescription,
    }],
});

    import pulumi
import pulumi_oci as oci

test_analytics_instance_private_access_channel = oci.analytics.AnalyticsInstancePrivateAccessChannel("test_analytics_instance_private_access_channel",
    analytics_instance_id=test_analytics_instance["id"],
    display_name=analytics_instance_private_access_channel_display_name,
    private_source_dns_zones=[oci.analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs(
        dns_zone=analytics_instance_private_access_channel_private_source_dns_zones_dns_zone,
        description=analytics_instance_private_access_channel_private_source_dns_zones_description,
    )],
    subnet_id=test_subnet["id"],
    vcn_id=test_vcn["id"],
    network_security_group_ids=analytics_instance_private_access_channel_network_security_group_ids,
    private_source_scan_hosts=[oci.analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs(
        scan_hostname=analytics_instance_private_access_channel_private_source_scan_hosts_scan_hostname,
        scan_port=analytics_instance_private_access_channel_private_source_scan_hosts_scan_port,
        description=analytics_instance_private_access_channel_private_source_scan_hosts_description,
    )])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Analytics.NewAnalyticsInstancePrivateAccessChannel(ctx, "test_analytics_instance_private_access_channel", &Analytics.AnalyticsInstancePrivateAccessChannelArgs{
			AnalyticsInstanceId: pulumi.Any(testAnalyticsInstance.Id),
			DisplayName:         pulumi.Any(analyticsInstancePrivateAccessChannelDisplayName),
			PrivateSourceDnsZones: analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArray{
				&analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs{
					DnsZone:     pulumi.Any(analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDnsZone),
					Description: pulumi.Any(analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDescription),
				},
			},
			SubnetId:                pulumi.Any(testSubnet.Id),
			VcnId:                   pulumi.Any(testVcn.Id),
			NetworkSecurityGroupIds: pulumi.Any(analyticsInstancePrivateAccessChannelNetworkSecurityGroupIds),
			PrivateSourceScanHosts: analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArray{
				&analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs{
					ScanHostname: pulumi.Any(analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanHostname),
					ScanPort:     pulumi.Any(analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanPort),
					Description:  pulumi.Any(analyticsInstancePrivateAccessChannelPrivateSourceScanHostsDescription),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAnalyticsInstancePrivateAccessChannel = new Oci.Analytics.AnalyticsInstancePrivateAccessChannel("test_analytics_instance_private_access_channel", new()
    {
        AnalyticsInstanceId = testAnalyticsInstance.Id,
        DisplayName = analyticsInstancePrivateAccessChannelDisplayName,
        PrivateSourceDnsZones = new[]
        {
            new Oci.Analytics.Inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs
            {
                DnsZone = analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDnsZone,
                Description = analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDescription,
            },
        },
        SubnetId = testSubnet.Id,
        VcnId = testVcn.Id,
        NetworkSecurityGroupIds = analyticsInstancePrivateAccessChannelNetworkSecurityGroupIds,
        PrivateSourceScanHosts = new[]
        {
            new Oci.Analytics.Inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs
            {
                ScanHostname = analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanHostname,
                ScanPort = analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanPort,
                Description = analyticsInstancePrivateAccessChannelPrivateSourceScanHostsDescription,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Analytics.AnalyticsInstancePrivateAccessChannel;
import com.pulumi.oci.Analytics.AnalyticsInstancePrivateAccessChannelArgs;
import com.pulumi.oci.Analytics.inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs;
import com.pulumi.oci.Analytics.inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs;
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) {
        var testAnalyticsInstancePrivateAccessChannel = new AnalyticsInstancePrivateAccessChannel("testAnalyticsInstancePrivateAccessChannel", AnalyticsInstancePrivateAccessChannelArgs.builder()
            .analyticsInstanceId(testAnalyticsInstance.id())
            .displayName(analyticsInstancePrivateAccessChannelDisplayName)
            .privateSourceDnsZones(AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs.builder()
                .dnsZone(analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDnsZone)
                .description(analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDescription)
                .build())
            .subnetId(testSubnet.id())
            .vcnId(testVcn.id())
            .networkSecurityGroupIds(analyticsInstancePrivateAccessChannelNetworkSecurityGroupIds)
            .privateSourceScanHosts(AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs.builder()
                .scanHostname(analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanHostname)
                .scanPort(analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanPort)
                .description(analyticsInstancePrivateAccessChannelPrivateSourceScanHostsDescription)
                .build())
            .build());

    }
}

    resources:
  testAnalyticsInstancePrivateAccessChannel:
    type: oci:Analytics:AnalyticsInstancePrivateAccessChannel
    name: test_analytics_instance_private_access_channel
    properties:
      analyticsInstanceId: ${testAnalyticsInstance.id}
      displayName: ${analyticsInstancePrivateAccessChannelDisplayName}
      privateSourceDnsZones:
        - dnsZone: ${analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDnsZone}
          description: ${analyticsInstancePrivateAccessChannelPrivateSourceDnsZonesDescription}
      subnetId: ${testSubnet.id}
      vcnId: ${testVcn.id}
      networkSecurityGroupIds: ${analyticsInstancePrivateAccessChannelNetworkSecurityGroupIds}
      privateSourceScanHosts:
        - scanHostname: ${analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanHostname}
          scanPort: ${analyticsInstancePrivateAccessChannelPrivateSourceScanHostsScanPort}
          description: ${analyticsInstancePrivateAccessChannelPrivateSourceScanHostsDescription}

    Create AnalyticsInstancePrivateAccessChannel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AnalyticsInstancePrivateAccessChannel(name: string, args: AnalyticsInstancePrivateAccessChannelArgs, opts?: CustomResourceOptions);
    @overload
def AnalyticsInstancePrivateAccessChannel(resource_name: str,
                                          args: AnalyticsInstancePrivateAccessChannelArgs,
                                          opts: Optional[ResourceOptions] = None)

@overload
def AnalyticsInstancePrivateAccessChannel(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          analytics_instance_id: Optional[str] = None,
                                          display_name: Optional[str] = None,
                                          private_source_dns_zones: Optional[Sequence[_analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs]] = None,
                                          subnet_id: Optional[str] = None,
                                          vcn_id: Optional[str] = None,
                                          network_security_group_ids: Optional[Sequence[str]] = None,
                                          private_source_scan_hosts: Optional[Sequence[_analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs]] = None)
    func NewAnalyticsInstancePrivateAccessChannel(ctx *Context, name string, args AnalyticsInstancePrivateAccessChannelArgs, opts ...ResourceOption) (*AnalyticsInstancePrivateAccessChannel, error)
    public AnalyticsInstancePrivateAccessChannel(string name, AnalyticsInstancePrivateAccessChannelArgs args, CustomResourceOptions? opts = null)
    public AnalyticsInstancePrivateAccessChannel(String name, AnalyticsInstancePrivateAccessChannelArgs args)
public AnalyticsInstancePrivateAccessChannel(String name, AnalyticsInstancePrivateAccessChannelArgs args, CustomResourceOptions options)

    type: oci:Analytics:AnalyticsInstancePrivateAccessChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AnalyticsInstancePrivateAccessChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AnalyticsInstancePrivateAccessChannelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AnalyticsInstancePrivateAccessChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnalyticsInstancePrivateAccessChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnalyticsInstancePrivateAccessChannelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var analyticsInstancePrivateAccessChannelResource = new Oci.Analytics.AnalyticsInstancePrivateAccessChannel("analyticsInstancePrivateAccessChannelResource", new()
{
    AnalyticsInstanceId = "string",
    DisplayName = "string",
    PrivateSourceDnsZones = new[]
    {
        new Oci.Analytics.Inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs
        {
            DnsZone = "string",
            Description = "string",
        },
    },
    SubnetId = "string",
    VcnId = "string",
    NetworkSecurityGroupIds = new[]
    {
        "string",
    },
    PrivateSourceScanHosts = new[]
    {
        new Oci.Analytics.Inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs
        {
            ScanHostname = "string",
            ScanPort = 0,
            Description = "string",
        },
    },
});

    example, err := Analytics.NewAnalyticsInstancePrivateAccessChannel(ctx, "analyticsInstancePrivateAccessChannelResource", &Analytics.AnalyticsInstancePrivateAccessChannelArgs{
	AnalyticsInstanceId: pulumi.String("string"),
	DisplayName:         pulumi.String("string"),
	PrivateSourceDnsZones: analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArray{
		&analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs{
			DnsZone:     pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	SubnetId: pulumi.String("string"),
	VcnId:    pulumi.String("string"),
	NetworkSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateSourceScanHosts: analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArray{
		&analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs{
			ScanHostname: pulumi.String("string"),
			ScanPort:     pulumi.Int(0),
			Description:  pulumi.String("string"),
		},
	},
})

    var analyticsInstancePrivateAccessChannelResource = new AnalyticsInstancePrivateAccessChannel("analyticsInstancePrivateAccessChannelResource", AnalyticsInstancePrivateAccessChannelArgs.builder()
    .analyticsInstanceId("string")
    .displayName("string")
    .privateSourceDnsZones(AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs.builder()
        .dnsZone("string")
        .description("string")
        .build())
    .subnetId("string")
    .vcnId("string")
    .networkSecurityGroupIds("string")
    .privateSourceScanHosts(AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs.builder()
        .scanHostname("string")
        .scanPort(0)
        .description("string")
        .build())
    .build());

    analytics_instance_private_access_channel_resource = oci.analytics.AnalyticsInstancePrivateAccessChannel("analyticsInstancePrivateAccessChannelResource",
    analytics_instance_id="string",
    display_name="string",
    private_source_dns_zones=[oci.analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs(
        dns_zone="string",
        description="string",
    )],
    subnet_id="string",
    vcn_id="string",
    network_security_group_ids=["string"],
    private_source_scan_hosts=[oci.analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs(
        scan_hostname="string",
        scan_port=0,
        description="string",
    )])

    const analyticsInstancePrivateAccessChannelResource = new oci.analytics.AnalyticsInstancePrivateAccessChannel("analyticsInstancePrivateAccessChannelResource", {
    analyticsInstanceId: "string",
    displayName: "string",
    privateSourceDnsZones: [{
        dnsZone: "string",
        description: "string",
    }],
    subnetId: "string",
    vcnId: "string",
    networkSecurityGroupIds: ["string"],
    privateSourceScanHosts: [{
        scanHostname: "string",
        scanPort: 0,
        description: "string",
    }],
});

    type: oci:Analytics:AnalyticsInstancePrivateAccessChannel
properties:
    analyticsInstanceId: string
    displayName: string
    networkSecurityGroupIds:
        - string
    privateSourceDnsZones:
        - description: string
          dnsZone: string
    privateSourceScanHosts:
        - description: string
          scanHostname: string
          scanPort: 0
    subnetId: string
    vcnId: string

    AnalyticsInstancePrivateAccessChannel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AnalyticsInstancePrivateAccessChannel resource accepts the following input properties:

    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    DisplayName string
    (Updatable) Display Name of the Private Access Channel.
    PrivateSourceDnsZones List<AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone>
    (Updatable) 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.
    SubnetId string
    (Updatable) OCID of the customer subnet connected to private access channel.
    VcnId string

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    NetworkSecurityGroupIds List<string>
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    PrivateSourceScanHosts List<AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost>
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    DisplayName string
    (Updatable) Display Name of the Private Access Channel.
    PrivateSourceDnsZones []AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs
    (Updatable) 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.
    SubnetId string
    (Updatable) OCID of the customer subnet connected to private access channel.
    VcnId string

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    NetworkSecurityGroupIds []string
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    PrivateSourceScanHosts []AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    displayName String
    (Updatable) Display Name of the Private Access Channel.
    privateSourceDnsZones List<InstancePrivateAccessChannelPrivateSourceDnsZone>
    (Updatable) 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.
    subnetId String
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcnId String

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    networkSecurityGroupIds List<String>
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    privateSourceScanHosts List<InstancePrivateAccessChannelPrivateSourceScanHost>
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    analyticsInstanceId string
    The OCID of the AnalyticsInstance.
    displayName string
    (Updatable) Display Name of the Private Access Channel.
    privateSourceDnsZones AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone[]
    (Updatable) 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.
    subnetId string
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcnId string

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    networkSecurityGroupIds string[]
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    privateSourceScanHosts AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost[]
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    analytics_instance_id str
    The OCID of the AnalyticsInstance.
    display_name str
    (Updatable) Display Name of the Private Access Channel.
    private_source_dns_zones Sequence[analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs]
    (Updatable) 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.
    subnet_id str
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcn_id str

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    network_security_group_ids Sequence[str]
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    private_source_scan_hosts Sequence[analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs]
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    displayName String
    (Updatable) Display Name of the Private Access Channel.
    privateSourceDnsZones List<Property Map>
    (Updatable) 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.
    subnetId String
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcnId String

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    networkSecurityGroupIds List<String>
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    privateSourceScanHosts List<Property Map>
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AnalyticsInstancePrivateAccessChannel resource produces the following output properties:

    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
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    IP Address of the Private Access channel.
    Key string
    Private Access Channel unique identifier key.
    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
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    IP Address of the Private Access channel.
    Key string
    Private Access Channel unique identifier key.
    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
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    IP Address of the Private Access channel.
    key String
    Private Access Channel unique identifier key.
    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
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    IP Address of the Private Access channel.
    key string
    Private Access Channel unique identifier key.
    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
    The provider-assigned unique ID for this managed resource.
    ip_address str
    IP Address of the Private Access channel.
    key str
    Private Access Channel unique identifier key.
    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
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    IP Address of the Private Access channel.
    key String
    Private Access Channel unique identifier key.

    Look up Existing AnalyticsInstancePrivateAccessChannel Resource

    Get an existing AnalyticsInstancePrivateAccessChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AnalyticsInstancePrivateAccessChannelState, opts?: CustomResourceOptions): AnalyticsInstancePrivateAccessChannel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        analytics_instance_id: Optional[str] = None,
        display_name: Optional[str] = None,
        egress_source_ip_addresses: Optional[Sequence[str]] = None,
        ip_address: Optional[str] = None,
        key: Optional[str] = None,
        network_security_group_ids: Optional[Sequence[str]] = None,
        private_source_dns_zones: Optional[Sequence[_analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs]] = None,
        private_source_scan_hosts: Optional[Sequence[_analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs]] = None,
        subnet_id: Optional[str] = None,
        vcn_id: Optional[str] = None) -> AnalyticsInstancePrivateAccessChannel
    func GetAnalyticsInstancePrivateAccessChannel(ctx *Context, name string, id IDInput, state *AnalyticsInstancePrivateAccessChannelState, opts ...ResourceOption) (*AnalyticsInstancePrivateAccessChannel, error)
    public static AnalyticsInstancePrivateAccessChannel Get(string name, Input<string> id, AnalyticsInstancePrivateAccessChannelState? state, CustomResourceOptions? opts = null)
    public static AnalyticsInstancePrivateAccessChannel get(String name, Output<String> id, AnalyticsInstancePrivateAccessChannelState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    DisplayName string
    (Updatable) 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.
    IpAddress string
    IP Address of the Private Access channel.
    Key string
    Private Access Channel unique identifier key.
    NetworkSecurityGroupIds List<string>
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    PrivateSourceDnsZones List<AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone>
    (Updatable) 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<AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost>
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    SubnetId string
    (Updatable) OCID of the customer subnet connected to private access channel.
    VcnId string

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    DisplayName string
    (Updatable) 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.
    IpAddress string
    IP Address of the Private Access channel.
    Key string
    Private Access Channel unique identifier key.
    NetworkSecurityGroupIds []string
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    PrivateSourceDnsZones []AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs
    (Updatable) 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 []AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    SubnetId string
    (Updatable) OCID of the customer subnet connected to private access channel.
    VcnId string

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    displayName String
    (Updatable) 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.
    ipAddress String
    IP Address of the Private Access channel.
    key String
    Private Access Channel unique identifier key.
    networkSecurityGroupIds List<String>
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    privateSourceDnsZones List<InstancePrivateAccessChannelPrivateSourceDnsZone>
    (Updatable) 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<InstancePrivateAccessChannelPrivateSourceScanHost>
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    subnetId String
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcnId String

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analyticsInstanceId string
    The OCID of the AnalyticsInstance.
    displayName string
    (Updatable) 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.
    ipAddress string
    IP Address of the Private Access channel.
    key string
    Private Access Channel unique identifier key.
    networkSecurityGroupIds string[]
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    privateSourceDnsZones AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone[]
    (Updatable) 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 AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost[]
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    subnetId string
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcnId string

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analytics_instance_id str
    The OCID of the AnalyticsInstance.
    display_name str
    (Updatable) 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.
    ip_address str
    IP Address of the Private Access channel.
    key str
    Private Access Channel unique identifier key.
    network_security_group_ids Sequence[str]
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    private_source_dns_zones Sequence[analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs]
    (Updatable) 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.AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs]
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    subnet_id str
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcn_id str

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    displayName String
    (Updatable) 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.
    ipAddress String
    IP Address of the Private Access channel.
    key String
    Private Access Channel unique identifier key.
    networkSecurityGroupIds List<String>
    (Updatable) Network Security Group OCIDs for an Analytics instance.
    privateSourceDnsZones List<Property Map>
    (Updatable) 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>
    (Updatable) List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    subnetId String
    (Updatable) OCID of the customer subnet connected to private access channel.
    vcnId String

    (Updatable) OCID of the customer VCN peered with private access channel.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone, AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs

    DnsZone string
    (Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
    Description string
    (Updatable) Description of private source dns zone.
    DnsZone string
    (Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
    Description string
    (Updatable) Description of private source dns zone.
    dnsZone String
    (Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
    description String
    (Updatable) Description of private source dns zone.
    dnsZone string
    (Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
    description string
    (Updatable) Description of private source dns zone.
    dns_zone str
    (Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
    description str
    (Updatable) Description of private source dns zone.
    dnsZone String
    (Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
    description String
    (Updatable) Description of private source dns zone.

    AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost, AnalyticsInstancePrivateAccessChannelPrivateSourceScanHostArgs

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

    Import

    AnalyticsInstancePrivateAccessChannels can be imported using the id, e.g.

    $ pulumi import oci:Analytics/analyticsInstancePrivateAccessChannel:AnalyticsInstancePrivateAccessChannel test_analytics_instance_private_access_channel "analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci