Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

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

getAnalyticsInstance

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

Info for a specific Analytics instance.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testAnalyticsInstance = Output.Create(Oci.Analytics.GetAnalyticsInstance.InvokeAsync(new Oci.Analytics.GetAnalyticsInstanceArgs
        {
            AnalyticsInstanceId = oci_analytics_analytics_instance.Test_analytics_instance.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.GetAnalyticsInstance(ctx, &analytics.GetAnalyticsInstanceArgs{
			AnalyticsInstanceId: oci_analytics_analytics_instance.Test_analytics_instance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_analytics_instance = oci.Analytics.get_analytics_instance(analytics_instance_id=oci_analytics_analytics_instance["test_analytics_instance"]["id"])

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

const testAnalyticsInstance = oci.Analytics.getAnalyticsInstance({
    analyticsInstanceId: oci_analytics_analytics_instance.test_analytics_instance.id,
});

Coming soon!

Using getAnalyticsInstance

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 getAnalyticsInstance(args: GetAnalyticsInstanceArgs, opts?: InvokeOptions): Promise<GetAnalyticsInstanceResult>
function getAnalyticsInstanceOutput(args: GetAnalyticsInstanceOutputArgs, opts?: InvokeOptions): Output<GetAnalyticsInstanceResult>

def get_analytics_instance(analytics_instance_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAnalyticsInstanceResult
def get_analytics_instance_output(analytics_instance_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetAnalyticsInstanceResult]

func GetAnalyticsInstance(ctx *Context, args *GetAnalyticsInstanceArgs, opts ...InvokeOption) (*GetAnalyticsInstanceResult, error)
func GetAnalyticsInstanceOutput(ctx *Context, args *GetAnalyticsInstanceOutputArgs, opts ...InvokeOption) GetAnalyticsInstanceResultOutput

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

public static class GetAnalyticsInstance 
{
    public static Task<GetAnalyticsInstanceResult> InvokeAsync(GetAnalyticsInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalyticsInstanceResult> Invoke(GetAnalyticsInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAnalyticsInstanceResult> getAnalyticsInstance(GetAnalyticsInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:Analytics/getAnalyticsInstance:getAnalyticsInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AnalyticsInstanceId string: The OCID of the AnalyticsInstance.

AnalyticsInstanceId string: The OCID of the AnalyticsInstance.

analyticsInstanceId String: The OCID of the AnalyticsInstance.

analyticsInstanceId string: The OCID of the AnalyticsInstance.

analytics_instance_id str: The OCID of the AnalyticsInstance.

analyticsInstanceId String: The OCID of the AnalyticsInstance.

getAnalyticsInstance Result

The following output properties are available:

AnalyticsInstanceId string
Capacities List<GetAnalyticsInstanceCapacity>: Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Description of the vanity url.
EmailNotification string: Email address receiving notifications.
FeatureSet string: Analytics feature set.
FreeformTags Dictionary<string, object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The Virtual Cloud Network OCID.
IdcsAccessToken string
LicenseType string: The license used for the service.
Name string: The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
NetworkEndpointDetails List<GetAnalyticsInstanceNetworkEndpointDetail>: Base representation of a network endpoint.
PrivateAccessChannels Dictionary<string, object>: Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
ServiceUrl string: URL of the Analytics service.
State string: The current state of an instance.
TimeCreated string: The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
VanityUrlDetails Dictionary<string, object>: Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

AnalyticsInstanceId string
Capacities []GetAnalyticsInstanceCapacity: Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
CompartmentId string: The OCID of the compartment.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Description of the vanity url.
EmailNotification string: Email address receiving notifications.
FeatureSet string: Analytics feature set.
FreeformTags map[string]interface{}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The Virtual Cloud Network OCID.
IdcsAccessToken string
LicenseType string: The license used for the service.
Name string: The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
NetworkEndpointDetails []GetAnalyticsInstanceNetworkEndpointDetail: Base representation of a network endpoint.
PrivateAccessChannels map[string]interface{}: Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
ServiceUrl string: URL of the Analytics service.
State string: The current state of an instance.
TimeCreated string: The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
VanityUrlDetails map[string]interface{}: Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

analyticsInstanceId String
capacities List<GetInstanceCapacity>: Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
compartmentId String: The OCID of the compartment.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Description of the vanity url.
emailNotification String: Email address receiving notifications.
featureSet String: Analytics feature set.
freeformTags Map<String,Object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The Virtual Cloud Network OCID.
idcsAccessToken String
licenseType String: The license used for the service.
name String: The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
networkEndpointDetails List<GetInstanceNetworkEndpointDetail>: Base representation of a network endpoint.
privateAccessChannels Map<String,Object>: Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
serviceUrl String: URL of the Analytics service.
state String: The current state of an instance.
timeCreated String: The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
vanityUrlDetails Map<String,Object>: Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

analyticsInstanceId string
capacities GetAnalyticsInstanceCapacity[]: Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
compartmentId string: The OCID of the compartment.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: Description of the vanity url.
emailNotification string: Email address receiving notifications.
featureSet string: Analytics feature set.
freeformTags {[key: string]: any}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The Virtual Cloud Network OCID.
idcsAccessToken string
licenseType string: The license used for the service.
name string: The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
networkEndpointDetails GetAnalyticsInstanceNetworkEndpointDetail[]: Base representation of a network endpoint.
privateAccessChannels {[key: string]: any}: Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
serviceUrl string: URL of the Analytics service.
state string: The current state of an instance.
timeCreated string: The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string: The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
vanityUrlDetails {[key: string]: any}: Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

analytics_instance_id str
capacities GetAnalyticsInstanceCapacity]: Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
compartment_id str: The OCID of the compartment.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: Description of the vanity url.
email_notification str: Email address receiving notifications.
feature_set str: Analytics feature set.
freeform_tags Mapping[str, Any]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The Virtual Cloud Network OCID.
idcs_access_token str
license_type str: The license used for the service.
name str: The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
network_endpoint_details GetAnalyticsInstanceNetworkEndpointDetail]: Base representation of a network endpoint.
private_access_channels Mapping[str, Any]: Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
service_url str: URL of the Analytics service.
state str: The current state of an instance.
time_created str: The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
time_updated str: The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
vanity_url_details Mapping[str, Any]: Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

analyticsInstanceId String
capacities List<Property Map>: Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
compartmentId String: The OCID of the compartment.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Description of the vanity url.
emailNotification String: Email address receiving notifications.
featureSet String: Analytics feature set.
freeformTags Map<Any>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The Virtual Cloud Network OCID.
idcsAccessToken String
licenseType String: The license used for the service.
name String: The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
networkEndpointDetails List<Property Map>: Base representation of a network endpoint.
privateAccessChannels Map<Any>: Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
serviceUrl String: URL of the Analytics service.
state String: The current state of an instance.
timeCreated String: The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
vanityUrlDetails Map<Any>: Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

Supporting Types

GetAnalyticsInstanceCapacity

CapacityType string: The capacity model to use.
CapacityValue int: The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

CapacityType string: The capacity model to use.
CapacityValue int: The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

capacityType String: The capacity model to use.
capacityValue Integer: The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

capacityType string: The capacity model to use.
capacityValue number: The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

capacity_type str: The capacity model to use.
capacity_value int: The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

capacityType String: The capacity model to use.
capacityValue Number: The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.

GetAnalyticsInstanceNetworkEndpointDetail

NetworkEndpointType string: The type of network endpoint.
SubnetId string: OCID of the customer subnet connected to private access channel.
VcnId string: OCID of the customer VCN peered with private access channel.
WhitelistedIps List<string>: Source IP addresses or IP address ranges igress rules.
WhitelistedVcns List<GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn>: Virtual Cloud Networks allowed to access this network endpoint.

NetworkEndpointType string: The type of network endpoint.
SubnetId string: OCID of the customer subnet connected to private access channel.
VcnId string: OCID of the customer VCN peered with private access channel.
WhitelistedIps []string: Source IP addresses or IP address ranges igress rules.
WhitelistedVcns []GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn: Virtual Cloud Networks allowed to access this network endpoint.

networkEndpointType String: The type of network endpoint.
subnetId String: OCID of the customer subnet connected to private access channel.
vcnId String: OCID of the customer VCN peered with private access channel.
whitelistedIps List<String>: Source IP addresses or IP address ranges igress rules.
whitelistedVcns List<GetInstanceNetworkEndpointDetailWhitelistedVcn>: Virtual Cloud Networks allowed to access this network endpoint.

networkEndpointType string: The type of network endpoint.
subnetId string: OCID of the customer subnet connected to private access channel.
vcnId string: OCID of the customer VCN peered with private access channel.
whitelistedIps string[]: Source IP addresses or IP address ranges igress rules.
whitelistedVcns GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn[]: Virtual Cloud Networks allowed to access this network endpoint.

network_endpoint_type str: The type of network endpoint.
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.
whitelisted_ips Sequence[str]: Source IP addresses or IP address ranges igress rules.
whitelisted_vcns GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn]: Virtual Cloud Networks allowed to access this network endpoint.

networkEndpointType String: The type of network endpoint.
subnetId String: OCID of the customer subnet connected to private access channel.
vcnId String: OCID of the customer VCN peered with private access channel.
whitelistedIps List<String>: Source IP addresses or IP address ranges igress rules.
whitelistedVcns List<Property Map>: Virtual Cloud Networks allowed to access this network endpoint.

GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn

Id string: The Virtual Cloud Network OCID.
WhitelistedIps List<string>: Source IP addresses or IP address ranges igress rules.

Id string: The Virtual Cloud Network OCID.
WhitelistedIps []string: Source IP addresses or IP address ranges igress rules.

id String: The Virtual Cloud Network OCID.
whitelistedIps List<String>: Source IP addresses or IP address ranges igress rules.

id string: The Virtual Cloud Network OCID.
whitelistedIps string[]: Source IP addresses or IP address ranges igress rules.

id str: The Virtual Cloud Network OCID.
whitelisted_ips Sequence[str]: Source IP addresses or IP address ranges igress rules.

id String: The Virtual Cloud Network OCID.
whitelistedIps List<String>: Source IP addresses or IP address ranges igress rules.

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.