Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

AnalyticsInstance

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

Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testAnalyticsInstance = new Oci.Analytics.AnalyticsInstance("testAnalyticsInstance", new()
    {
        Capacity = new Oci.Analytics.Inputs.AnalyticsInstanceCapacityArgs
        {
            CapacityType = @var.Analytics_instance_capacity_capacity_type,
            CapacityValue = @var.Analytics_instance_capacity_capacity_value,
        },
        CompartmentId = @var.Compartment_id,
        FeatureSet = @var.Analytics_instance_feature_set,
        IdcsAccessToken = @var.Analytics_instance_idcs_access_token,
        LicenseType = @var.Analytics_instance_license_type,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = @var.Analytics_instance_description,
        EmailNotification = @var.Analytics_instance_email_notification,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        KmsKeyId = oci_kms_key.Test_key.Id,
        NetworkEndpointDetails = new Oci.Analytics.Inputs.AnalyticsInstanceNetworkEndpointDetailsArgs
        {
            NetworkEndpointType = @var.Analytics_instance_network_endpoint_details_network_endpoint_type,
            NetworkSecurityGroupIds = @var.Analytics_instance_network_endpoint_details_network_security_group_ids,
            SubnetId = oci_core_subnet.Test_subnet.Id,
            VcnId = oci_core_vcn.Test_vcn.Id,
            WhitelistedIps = @var.Analytics_instance_network_endpoint_details_whitelisted_ips,
            WhitelistedServices = @var.Analytics_instance_network_endpoint_details_whitelisted_services,
            WhitelistedVcns = new[]
            {
                new Oci.Analytics.Inputs.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs
                {
                    Id = @var.Analytics_instance_network_endpoint_details_whitelisted_vcns_id,
                    WhitelistedIps = @var.Analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips,
                },
            },
        },
    });

});
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.NewAnalyticsInstance(ctx, "testAnalyticsInstance", &Analytics.AnalyticsInstanceArgs{
			Capacity: &analytics.AnalyticsInstanceCapacityArgs{
				CapacityType:  pulumi.Any(_var.Analytics_instance_capacity_capacity_type),
				CapacityValue: pulumi.Any(_var.Analytics_instance_capacity_capacity_value),
			},
			CompartmentId:   pulumi.Any(_var.Compartment_id),
			FeatureSet:      pulumi.Any(_var.Analytics_instance_feature_set),
			IdcsAccessToken: pulumi.Any(_var.Analytics_instance_idcs_access_token),
			LicenseType:     pulumi.Any(_var.Analytics_instance_license_type),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			Description:       pulumi.Any(_var.Analytics_instance_description),
			EmailNotification: pulumi.Any(_var.Analytics_instance_email_notification),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			KmsKeyId: pulumi.Any(oci_kms_key.Test_key.Id),
			NetworkEndpointDetails: &analytics.AnalyticsInstanceNetworkEndpointDetailsArgs{
				NetworkEndpointType:     pulumi.Any(_var.Analytics_instance_network_endpoint_details_network_endpoint_type),
				NetworkSecurityGroupIds: pulumi.Any(_var.Analytics_instance_network_endpoint_details_network_security_group_ids),
				SubnetId:                pulumi.Any(oci_core_subnet.Test_subnet.Id),
				VcnId:                   pulumi.Any(oci_core_vcn.Test_vcn.Id),
				WhitelistedIps:          pulumi.Any(_var.Analytics_instance_network_endpoint_details_whitelisted_ips),
				WhitelistedServices:     pulumi.Any(_var.Analytics_instance_network_endpoint_details_whitelisted_services),
				WhitelistedVcns: analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArray{
					&analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs{
						Id:             pulumi.Any(_var.Analytics_instance_network_endpoint_details_whitelisted_vcns_id),
						WhitelistedIps: pulumi.Any(_var.Analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Analytics.AnalyticsInstance;
import com.pulumi.oci.Analytics.AnalyticsInstanceArgs;
import com.pulumi.oci.Analytics.inputs.AnalyticsInstanceCapacityArgs;
import com.pulumi.oci.Analytics.inputs.AnalyticsInstanceNetworkEndpointDetailsArgs;
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 testAnalyticsInstance = new AnalyticsInstance("testAnalyticsInstance", AnalyticsInstanceArgs.builder()        
            .capacity(AnalyticsInstanceCapacityArgs.builder()
                .capacityType(var_.analytics_instance_capacity_capacity_type())
                .capacityValue(var_.analytics_instance_capacity_capacity_value())
                .build())
            .compartmentId(var_.compartment_id())
            .featureSet(var_.analytics_instance_feature_set())
            .idcsAccessToken(var_.analytics_instance_idcs_access_token())
            .licenseType(var_.analytics_instance_license_type())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(var_.analytics_instance_description())
            .emailNotification(var_.analytics_instance_email_notification())
            .freeformTags(Map.of("Department", "Finance"))
            .kmsKeyId(oci_kms_key.test_key().id())
            .networkEndpointDetails(AnalyticsInstanceNetworkEndpointDetailsArgs.builder()
                .networkEndpointType(var_.analytics_instance_network_endpoint_details_network_endpoint_type())
                .networkSecurityGroupIds(var_.analytics_instance_network_endpoint_details_network_security_group_ids())
                .subnetId(oci_core_subnet.test_subnet().id())
                .vcnId(oci_core_vcn.test_vcn().id())
                .whitelistedIps(var_.analytics_instance_network_endpoint_details_whitelisted_ips())
                .whitelistedServices(var_.analytics_instance_network_endpoint_details_whitelisted_services())
                .whitelistedVcns(AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs.builder()
                    .id(var_.analytics_instance_network_endpoint_details_whitelisted_vcns_id())
                    .whitelistedIps(var_.analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips())
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_analytics_instance = oci.analytics.AnalyticsInstance("testAnalyticsInstance",
    capacity=oci.analytics.AnalyticsInstanceCapacityArgs(
        capacity_type=var["analytics_instance_capacity_capacity_type"],
        capacity_value=var["analytics_instance_capacity_capacity_value"],
    ),
    compartment_id=var["compartment_id"],
    feature_set=var["analytics_instance_feature_set"],
    idcs_access_token=var["analytics_instance_idcs_access_token"],
    license_type=var["analytics_instance_license_type"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=var["analytics_instance_description"],
    email_notification=var["analytics_instance_email_notification"],
    freeform_tags={
        "Department": "Finance",
    },
    kms_key_id=oci_kms_key["test_key"]["id"],
    network_endpoint_details=oci.analytics.AnalyticsInstanceNetworkEndpointDetailsArgs(
        network_endpoint_type=var["analytics_instance_network_endpoint_details_network_endpoint_type"],
        network_security_group_ids=var["analytics_instance_network_endpoint_details_network_security_group_ids"],
        subnet_id=oci_core_subnet["test_subnet"]["id"],
        vcn_id=oci_core_vcn["test_vcn"]["id"],
        whitelisted_ips=var["analytics_instance_network_endpoint_details_whitelisted_ips"],
        whitelisted_services=var["analytics_instance_network_endpoint_details_whitelisted_services"],
        whitelisted_vcns=[oci.analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs(
            id=var["analytics_instance_network_endpoint_details_whitelisted_vcns_id"],
            whitelisted_ips=var["analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips"],
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAnalyticsInstance = new oci.analytics.AnalyticsInstance("testAnalyticsInstance", {
    capacity: {
        capacityType: _var.analytics_instance_capacity_capacity_type,
        capacityValue: _var.analytics_instance_capacity_capacity_value,
    },
    compartmentId: _var.compartment_id,
    featureSet: _var.analytics_instance_feature_set,
    idcsAccessToken: _var.analytics_instance_idcs_access_token,
    licenseType: _var.analytics_instance_license_type,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: _var.analytics_instance_description,
    emailNotification: _var.analytics_instance_email_notification,
    freeformTags: {
        Department: "Finance",
    },
    kmsKeyId: oci_kms_key.test_key.id,
    networkEndpointDetails: {
        networkEndpointType: _var.analytics_instance_network_endpoint_details_network_endpoint_type,
        networkSecurityGroupIds: _var.analytics_instance_network_endpoint_details_network_security_group_ids,
        subnetId: oci_core_subnet.test_subnet.id,
        vcnId: oci_core_vcn.test_vcn.id,
        whitelistedIps: _var.analytics_instance_network_endpoint_details_whitelisted_ips,
        whitelistedServices: _var.analytics_instance_network_endpoint_details_whitelisted_services,
        whitelistedVcns: [{
            id: _var.analytics_instance_network_endpoint_details_whitelisted_vcns_id,
            whitelistedIps: _var.analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips,
        }],
    },
});
resources:
  testAnalyticsInstance:
    type: oci:Analytics:AnalyticsInstance
    properties:
      capacity:
        capacityType: ${var.analytics_instance_capacity_capacity_type}
        capacityValue: ${var.analytics_instance_capacity_capacity_value}
      compartmentId: ${var.compartment_id}
      featureSet: ${var.analytics_instance_feature_set}
      idcsAccessToken: ${var.analytics_instance_idcs_access_token}
      licenseType: ${var.analytics_instance_license_type}
      #Optional
      definedTags:
        Operations.CostCenter: 42
      description: ${var.analytics_instance_description}
      emailNotification: ${var.analytics_instance_email_notification}
      freeformTags:
        Department: Finance
      kmsKeyId: ${oci_kms_key.test_key.id}
      networkEndpointDetails:
        networkEndpointType: ${var.analytics_instance_network_endpoint_details_network_endpoint_type}
        networkSecurityGroupIds: ${var.analytics_instance_network_endpoint_details_network_security_group_ids}
        subnetId: ${oci_core_subnet.test_subnet.id}
        vcnId: ${oci_core_vcn.test_vcn.id}
        whitelistedIps: ${var.analytics_instance_network_endpoint_details_whitelisted_ips}
        whitelistedServices: ${var.analytics_instance_network_endpoint_details_whitelisted_services}
        whitelistedVcns:
          - id: ${var.analytics_instance_network_endpoint_details_whitelisted_vcns_id}
            whitelistedIps: ${var.analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips}

Create AnalyticsInstance Resource

new AnalyticsInstance(name: string, args: AnalyticsInstanceArgs, opts?: CustomResourceOptions);
@overload
def AnalyticsInstance(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      capacity: Optional[_analytics.AnalyticsInstanceCapacityArgs] = None,
                      compartment_id: Optional[str] = None,
                      defined_tags: Optional[Mapping[str, Any]] = None,
                      description: Optional[str] = None,
                      email_notification: Optional[str] = None,
                      feature_set: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, Any]] = None,
                      idcs_access_token: Optional[str] = None,
                      kms_key_id: Optional[str] = None,
                      license_type: Optional[str] = None,
                      name: Optional[str] = None,
                      network_endpoint_details: Optional[_analytics.AnalyticsInstanceNetworkEndpointDetailsArgs] = None,
                      state: Optional[str] = None)
@overload
def AnalyticsInstance(resource_name: str,
                      args: AnalyticsInstanceArgs,
                      opts: Optional[ResourceOptions] = None)
func NewAnalyticsInstance(ctx *Context, name string, args AnalyticsInstanceArgs, opts ...ResourceOption) (*AnalyticsInstance, error)
public AnalyticsInstance(string name, AnalyticsInstanceArgs args, CustomResourceOptions? opts = null)
public AnalyticsInstance(String name, AnalyticsInstanceArgs args)
public AnalyticsInstance(String name, AnalyticsInstanceArgs args, CustomResourceOptions options)
type: oci:Analytics:AnalyticsInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AnalyticsInstanceArgs
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 AnalyticsInstanceArgs
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 AnalyticsInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AnalyticsInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AnalyticsInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AnalyticsInstance 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 AnalyticsInstance resource accepts the following input properties:

Capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

CompartmentId string

(Updatable) The OCID of the compartment.

FeatureSet string

Analytics feature set.

IdcsAccessToken string

IDCS access token identifying a stripe and service administrator user.

LicenseType string

(Updatable) The license used for the service.

DefinedTags Dictionary<string, object>

(Updatable) 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

(Updatable) Optional description.

EmailNotification string

(Updatable) Email address receiving notifications.

FreeformTags Dictionary<string, object>

(Updatable) 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"}

KmsKeyId string

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

Name string

The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

NetworkEndpointDetails AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

State string

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

Capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

CompartmentId string

(Updatable) The OCID of the compartment.

FeatureSet string

Analytics feature set.

IdcsAccessToken string

IDCS access token identifying a stripe and service administrator user.

LicenseType string

(Updatable) The license used for the service.

DefinedTags map[string]interface{}

(Updatable) 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

(Updatable) Optional description.

EmailNotification string

(Updatable) Email address receiving notifications.

FreeformTags map[string]interface{}

(Updatable) 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"}

KmsKeyId string

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

Name string

The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

NetworkEndpointDetails AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

State string

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

capacity InstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartmentId String

(Updatable) The OCID of the compartment.

featureSet String

Analytics feature set.

idcsAccessToken String

IDCS access token identifying a stripe and service administrator user.

licenseType String

(Updatable) The license used for the service.

definedTags Map<String,Object>

(Updatable) 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

(Updatable) Optional description.

emailNotification String

(Updatable) Email address receiving notifications.

freeformTags Map<String,Object>

(Updatable) 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"}

kmsKeyId String

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

name String

The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

networkEndpointDetails InstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

state String

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartmentId string

(Updatable) The OCID of the compartment.

featureSet string

Analytics feature set.

idcsAccessToken string

IDCS access token identifying a stripe and service administrator user.

licenseType string

(Updatable) The license used for the service.

definedTags {[key: string]: any}

(Updatable) 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

(Updatable) Optional description.

emailNotification string

(Updatable) Email address receiving notifications.

freeformTags {[key: string]: any}

(Updatable) 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"}

kmsKeyId string

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

name string

The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

networkEndpointDetails AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

state string

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartment_id str

(Updatable) The OCID of the compartment.

feature_set str

Analytics feature set.

idcs_access_token str

IDCS access token identifying a stripe and service administrator user.

license_type str

(Updatable) The license used for the service.

defined_tags Mapping[str, Any]

(Updatable) 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

(Updatable) Optional description.

email_notification str

(Updatable) Email address receiving notifications.

freeform_tags Mapping[str, Any]

(Updatable) 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"}

kms_key_id str

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

name str

The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

network_endpoint_details AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

state str

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

capacity Property Map

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartmentId String

(Updatable) The OCID of the compartment.

featureSet String

Analytics feature set.

idcsAccessToken String

IDCS access token identifying a stripe and service administrator user.

licenseType String

(Updatable) The license used for the service.

definedTags Map<Any>

(Updatable) 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

(Updatable) Optional description.

emailNotification String

(Updatable) Email address receiving notifications.

freeformTags Map<Any>

(Updatable) 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"}

kmsKeyId String

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

name String

The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

networkEndpointDetails Property Map

Base representation of a network endpoint.

state String

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

ServiceUrl string

URL of the Analytics service.

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.

Id string

The provider-assigned unique ID for this managed resource.

ServiceUrl string

URL of the Analytics service.

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.

id String

The provider-assigned unique ID for this managed resource.

serviceUrl String

URL of the Analytics service.

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.

id string

The provider-assigned unique ID for this managed resource.

serviceUrl string

URL of the Analytics service.

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.

id str

The provider-assigned unique ID for this managed resource.

service_url str

URL of the Analytics service.

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.

id String

The provider-assigned unique ID for this managed resource.

serviceUrl String

URL of the Analytics service.

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.

Look up Existing AnalyticsInstance Resource

Get an existing AnalyticsInstance 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?: AnalyticsInstanceState, opts?: CustomResourceOptions): AnalyticsInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[_analytics.AnalyticsInstanceCapacityArgs] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        email_notification: Optional[str] = None,
        feature_set: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        idcs_access_token: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        license_type: Optional[str] = None,
        name: Optional[str] = None,
        network_endpoint_details: Optional[_analytics.AnalyticsInstanceNetworkEndpointDetailsArgs] = None,
        service_url: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> AnalyticsInstance
func GetAnalyticsInstance(ctx *Context, name string, id IDInput, state *AnalyticsInstanceState, opts ...ResourceOption) (*AnalyticsInstance, error)
public static AnalyticsInstance Get(string name, Input<string> id, AnalyticsInstanceState? state, CustomResourceOptions? opts = null)
public static AnalyticsInstance get(String name, Output<String> id, AnalyticsInstanceState 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:
Capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

CompartmentId string

(Updatable) The OCID of the compartment.

DefinedTags Dictionary<string, object>

(Updatable) 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

(Updatable) Optional description.

EmailNotification string

(Updatable) Email address receiving notifications.

FeatureSet string

Analytics feature set.

FreeformTags Dictionary<string, object>

(Updatable) 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"}

IdcsAccessToken string

IDCS access token identifying a stripe and service administrator user.

KmsKeyId string

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

LicenseType string

(Updatable) 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 AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

ServiceUrl string

URL of the Analytics service.

State string

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

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.

Capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

CompartmentId string

(Updatable) The OCID of the compartment.

DefinedTags map[string]interface{}

(Updatable) 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

(Updatable) Optional description.

EmailNotification string

(Updatable) Email address receiving notifications.

FeatureSet string

Analytics feature set.

FreeformTags map[string]interface{}

(Updatable) 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"}

IdcsAccessToken string

IDCS access token identifying a stripe and service administrator user.

KmsKeyId string

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

LicenseType string

(Updatable) 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 AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

ServiceUrl string

URL of the Analytics service.

State string

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

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.

capacity InstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartmentId String

(Updatable) The OCID of the compartment.

definedTags Map<String,Object>

(Updatable) 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

(Updatable) Optional description.

emailNotification String

(Updatable) Email address receiving notifications.

featureSet String

Analytics feature set.

freeformTags Map<String,Object>

(Updatable) 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"}

idcsAccessToken String

IDCS access token identifying a stripe and service administrator user.

kmsKeyId String

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

licenseType String

(Updatable) 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 InstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

serviceUrl String

URL of the Analytics service.

state String

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

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.

capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartmentId string

(Updatable) The OCID of the compartment.

definedTags {[key: string]: any}

(Updatable) 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

(Updatable) Optional description.

emailNotification string

(Updatable) Email address receiving notifications.

featureSet string

Analytics feature set.

freeformTags {[key: string]: any}

(Updatable) 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"}

idcsAccessToken string

IDCS access token identifying a stripe and service administrator user.

kmsKeyId string

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

licenseType string

(Updatable) 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 AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

serviceUrl string

URL of the Analytics service.

state string

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

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.

capacity AnalyticsInstanceCapacityArgs

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartment_id str

(Updatable) The OCID of the compartment.

defined_tags Mapping[str, Any]

(Updatable) 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

(Updatable) Optional description.

email_notification str

(Updatable) Email address receiving notifications.

feature_set str

Analytics feature set.

freeform_tags Mapping[str, Any]

(Updatable) 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"}

idcs_access_token str

IDCS access token identifying a stripe and service administrator user.

kms_key_id str

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

license_type str

(Updatable) 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 AnalyticsInstanceNetworkEndpointDetailsArgs

Base representation of a network endpoint.

service_url str

URL of the Analytics service.

state str

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

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.

capacity Property Map

Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

compartmentId String

(Updatable) The OCID of the compartment.

definedTags Map<Any>

(Updatable) 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

(Updatable) Optional description.

emailNotification String

(Updatable) Email address receiving notifications.

featureSet String

Analytics feature set.

freeformTags Map<Any>

(Updatable) 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"}

idcsAccessToken String

IDCS access token identifying a stripe and service administrator user.

kmsKeyId String

The OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. Omitting this value or specifying an empty string (i.e. "") indicates to use Oracle managed default encryption.

licenseType String

(Updatable) 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 Property Map

Base representation of a network endpoint.

serviceUrl String

URL of the Analytics service.

state String

(Updatable) The target state for the Analytics Instance. Could be set to ACTIVE or INACTIVE.

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

AnalyticsInstanceCapacity

CapacityType string

The capacity model to use.

CapacityValue int

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) 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

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

AnalyticsInstanceNetworkEndpointDetails

NetworkEndpointType string

The type of network endpoint.

NetworkSecurityGroupIds List<string>

Network Security Group OCIDs for an Analytics instance.

SubnetId string

The subnet OCID for the private endpoint.

VcnId string

The VCN OCID for the private endpoint.

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

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

The subnet OCID for the private endpoint.

VcnId string

The VCN OCID for the private endpoint.

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 []AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn

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

The subnet OCID for the private endpoint.

vcnId String

The VCN OCID for the private endpoint.

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

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

The subnet OCID for the private endpoint.

vcnId string

The VCN OCID for the private endpoint.

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 AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn[]

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

The subnet OCID for the private endpoint.

vcn_id str

The VCN OCID for the private endpoint.

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 AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn]

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

The subnet OCID for the private endpoint.

vcnId String

The VCN OCID for the private endpoint.

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.

AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn

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.

Import

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

 $ pulumi import oci:Analytics/analyticsInstance:AnalyticsInstance test_analytics_instance "id"

Package Details

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

This Pulumi package is based on the oci Terraform Provider.