Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

AnalyticsInstancePrivateAccessChannel

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

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testAnalyticsInstancePrivateAccessChannel = new Oci.Analytics.AnalyticsInstancePrivateAccessChannel("testAnalyticsInstancePrivateAccessChannel", new Oci.Analytics.AnalyticsInstancePrivateAccessChannelArgs
        {
            AnalyticsInstanceId = oci_analytics_analytics_instance.Test_analytics_instance.Id,
            DisplayName = @var.Analytics_instance_private_access_channel_display_name,
            PrivateSourceDnsZones = 
            {
                new Oci.Analytics.Inputs.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs
                {
                    DnsZone = @var.Analytics_instance_private_access_channel_private_source_dns_zones_dns_zone,
                    Description = @var.Analytics_instance_private_access_channel_private_source_dns_zones_description,
                },
            },
            SubnetId = oci_core_subnet.Test_subnet.Id,
            VcnId = oci_core_vcn.Test_vcn.Id,
        });
    }

}
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, "testAnalyticsInstancePrivateAccessChannel", &Analytics.AnalyticsInstancePrivateAccessChannelArgs{
			AnalyticsInstanceId: pulumi.Any(oci_analytics_analytics_instance.Test_analytics_instance.Id),
			DisplayName:         pulumi.Any(_var.Analytics_instance_private_access_channel_display_name),
			PrivateSourceDnsZones: analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArray{
				&analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs{
					DnsZone:     pulumi.Any(_var.Analytics_instance_private_access_channel_private_source_dns_zones_dns_zone),
					Description: pulumi.Any(_var.Analytics_instance_private_access_channel_private_source_dns_zones_description),
				},
			},
			SubnetId: pulumi.Any(oci_core_subnet.Test_subnet.Id),
			VcnId:    pulumi.Any(oci_core_vcn.Test_vcn.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_analytics_instance_private_access_channel = oci.analytics.AnalyticsInstancePrivateAccessChannel("testAnalyticsInstancePrivateAccessChannel",
    analytics_instance_id=oci_analytics_analytics_instance["test_analytics_instance"]["id"],
    display_name=var["analytics_instance_private_access_channel_display_name"],
    private_source_dns_zones=[oci.analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs(
        dns_zone=var["analytics_instance_private_access_channel_private_source_dns_zones_dns_zone"],
        description=var["analytics_instance_private_access_channel_private_source_dns_zones_description"],
    )],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    vcn_id=oci_core_vcn["test_vcn"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAnalyticsInstancePrivateAccessChannel = new oci.analytics.AnalyticsInstancePrivateAccessChannel("testAnalyticsInstancePrivateAccessChannel", {
    analyticsInstanceId: oci_analytics_analytics_instance.test_analytics_instance.id,
    displayName: _var.analytics_instance_private_access_channel_display_name,
    privateSourceDnsZones: [{
        dnsZone: _var.analytics_instance_private_access_channel_private_source_dns_zones_dns_zone,
        description: _var.analytics_instance_private_access_channel_private_source_dns_zones_description,
    }],
    subnetId: oci_core_subnet.test_subnet.id,
    vcnId: oci_core_vcn.test_vcn.id,
});

Coming soon!

Create a AnalyticsInstancePrivateAccessChannel Resource

new AnalyticsInstancePrivateAccessChannel(name: string, args: AnalyticsInstancePrivateAccessChannelArgs, opts?: CustomResourceOptions);
@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)
@overload
def AnalyticsInstancePrivateAccessChannel(resource_name: str,
                                          args: AnalyticsInstancePrivateAccessChannelArgs,
                                          opts: Optional[ResourceOptions] = 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.

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.

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<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.

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.

analyticsInstanceId String

The OCID of the AnalyticsInstance.

displayName String

(Updatable) Display Name of the Private Access Channel.

privateSourceDnsZones List<InstancePrivateAccessChannelPrivateSourceDnsZoneArgs>

(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.

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.

analytics_instance_id str

The OCID of the AnalyticsInstance.

display_name str

(Updatable) Display Name of the Private Access Channel.

private_source_dns_zones 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.

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.

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 an 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,
        private_source_dns_zones: Optional[Sequence[_analytics.AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZoneArgs]] = 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.

PrivateSourceDnsZones List<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.

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.

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.

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.

privateSourceDnsZones List<InstancePrivateAccessChannelPrivateSourceDnsZoneArgs>

(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.

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.

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.

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.

private_source_dns_zones 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.

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.

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.

Supporting Types

AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone

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.

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}"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.