1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Analytics
  5. getAnalyticsInstance
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.Analytics.getAnalyticsInstance

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAnalyticsInstance = oci.Analytics.getAnalyticsInstance({
        analyticsInstanceId: testAnalyticsInstanceOciAnalyticsAnalyticsInstance.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_analytics_instance = oci.Analytics.get_analytics_instance(analytics_instance_id=test_analytics_instance_oci_analytics_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: testAnalyticsInstanceOciAnalyticsAnalyticsInstance.Id,
    		}, nil)
    		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 testAnalyticsInstance = Oci.Analytics.GetAnalyticsInstance.Invoke(new()
        {
            AnalyticsInstanceId = testAnalyticsInstanceOciAnalyticsAnalyticsInstance.Id,
        });
    
    });
    
    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.GetAnalyticsInstanceArgs;
    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 testAnalyticsInstance = AnalyticsFunctions.getAnalyticsInstance(GetAnalyticsInstanceArgs.builder()
                .analyticsInstanceId(testAnalyticsInstanceOciAnalyticsAnalyticsInstance.id())
                .build());
    
        }
    }
    
    variables:
      testAnalyticsInstance:
        fn::invoke:
          Function: oci:Analytics:getAnalyticsInstance
          Arguments:
            analyticsInstanceId: ${testAnalyticsInstanceOciAnalyticsAnalyticsInstance.id}
    

    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
    KmsKeyId string
    The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
    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.
    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.
    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
    KmsKeyId string
    The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
    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.
    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.
    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
    kmsKeyId String
    The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
    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.
    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.
    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
    kmsKeyId string
    The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
    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.
    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.
    analytics_instance_id str
    capacities Sequence[analytics.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
    kms_key_id str
    The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
    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 Sequence[analytics.GetAnalyticsInstanceNetworkEndpointDetail]
    Base representation of a network endpoint.
    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.
    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
    kmsKeyId String
    The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
    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.
    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.

    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.
    NetworkSecurityGroupIds List<string>
    Network Security Group OCIDs for an 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.
    WhitelistedIps List<string>
    Source IP addresses or IP address ranges in ingress rules.
    WhitelistedServices List<string>
    Oracle Cloud Services that are allowed to access this Analytics instance.
    WhitelistedVcns List<GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn>
    Virtual Cloud Networks allowed to access this network endpoint.
    NetworkEndpointType string
    The type of network endpoint.
    NetworkSecurityGroupIds []string
    Network Security Group OCIDs for an 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.
    WhitelistedIps []string
    Source IP addresses or IP address ranges in ingress rules.
    WhitelistedServices []string
    Oracle Cloud Services that are allowed to access this Analytics instance.
    WhitelistedVcns []GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn
    Virtual Cloud Networks allowed to access this network endpoint.
    networkEndpointType String
    The type of network endpoint.
    networkSecurityGroupIds List<String>
    Network Security Group OCIDs for an 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.
    whitelistedIps List<String>
    Source IP addresses or IP address ranges in ingress rules.
    whitelistedServices List<String>
    Oracle Cloud Services that are allowed to access this Analytics instance.
    whitelistedVcns List<GetInstanceNetworkEndpointDetailWhitelistedVcn>
    Virtual Cloud Networks allowed to access this network endpoint.
    networkEndpointType string
    The type of network endpoint.
    networkSecurityGroupIds string[]
    Network Security Group OCIDs for an 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.
    whitelistedIps string[]
    Source IP addresses or IP address ranges in ingress rules.
    whitelistedServices string[]
    Oracle Cloud Services that are allowed to access this Analytics instance.
    whitelistedVcns GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn[]
    Virtual Cloud Networks allowed to access this network endpoint.
    network_endpoint_type str
    The type of network endpoint.
    network_security_group_ids Sequence[str]
    Network Security Group OCIDs for an 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.
    whitelisted_ips Sequence[str]
    Source IP addresses or IP address ranges in ingress rules.
    whitelisted_services Sequence[str]
    Oracle Cloud Services that are allowed to access this Analytics instance.
    whitelisted_vcns Sequence[analytics.GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn]
    Virtual Cloud Networks allowed to access this network endpoint.
    networkEndpointType String
    The type of network endpoint.
    networkSecurityGroupIds List<String>
    Network Security Group OCIDs for an 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.
    whitelistedIps List<String>
    Source IP addresses or IP address ranges in ingress rules.
    whitelistedServices List<String>
    Oracle Cloud Services that are allowed to access this Analytics instance.
    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 in ingress rules.
    Id string
    The Virtual Cloud Network OCID.
    WhitelistedIps []string
    Source IP addresses or IP address ranges in ingress rules.
    id String
    The Virtual Cloud Network OCID.
    whitelistedIps List<String>
    Source IP addresses or IP address ranges in ingress rules.
    id string
    The Virtual Cloud Network OCID.
    whitelistedIps string[]
    Source IP addresses or IP address ranges in ingress rules.
    id str
    The Virtual Cloud Network OCID.
    whitelisted_ips Sequence[str]
    Source IP addresses or IP address ranges in ingress rules.
    id String
    The Virtual Cloud Network OCID.
    whitelistedIps List<String>
    Source IP addresses or IP address ranges in ingress rules.

    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.40.0 published on Wednesday, Jun 12, 2024 by Pulumi