1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Analytics
  5. AnalyticsInstance
Oracle Cloud Infrastructure v2.13.0 published on Tuesday, Oct 22, 2024 by Pulumi

oci.Analytics.AnalyticsInstance

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.13.0 published on Tuesday, Oct 22, 2024 by Pulumi

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAnalyticsInstance = new oci.analytics.AnalyticsInstance("test_analytics_instance", {
        capacity: {
            capacityType: analyticsInstanceCapacityCapacityType,
            capacityValue: analyticsInstanceCapacityCapacityValue,
        },
        compartmentId: compartmentId,
        featureSet: analyticsInstanceFeatureSet,
        idcsAccessToken: analyticsInstanceIdcsAccessToken,
        licenseType: analyticsInstanceLicenseType,
        name: analyticsInstanceName,
        adminUser: analyticsInstanceAdminUser,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: analyticsInstanceDescription,
        domainId: testDomain.id,
        emailNotification: analyticsInstanceEmailNotification,
        featureBundle: analyticsInstanceFeatureBundle,
        freeformTags: {
            Department: "Finance",
        },
        kmsKeyId: testKey.id,
        networkEndpointDetails: {
            networkEndpointType: analyticsInstanceNetworkEndpointDetailsNetworkEndpointType,
            networkSecurityGroupIds: analyticsInstanceNetworkEndpointDetailsNetworkSecurityGroupIds,
            subnetId: testSubnet.id,
            vcnId: testVcn.id,
            whitelistedIps: analyticsInstanceNetworkEndpointDetailsWhitelistedIps,
            whitelistedServices: analyticsInstanceNetworkEndpointDetailsWhitelistedServices,
            whitelistedVcns: [{
                id: analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsId,
                whitelistedIps: analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsWhitelistedIps,
            }],
        },
        updateChannel: analyticsInstanceUpdateChannel,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_analytics_instance = oci.analytics.AnalyticsInstance("test_analytics_instance",
        capacity={
            "capacity_type": analytics_instance_capacity_capacity_type,
            "capacity_value": analytics_instance_capacity_capacity_value,
        },
        compartment_id=compartment_id,
        feature_set=analytics_instance_feature_set,
        idcs_access_token=analytics_instance_idcs_access_token,
        license_type=analytics_instance_license_type,
        name=analytics_instance_name,
        admin_user=analytics_instance_admin_user,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=analytics_instance_description,
        domain_id=test_domain["id"],
        email_notification=analytics_instance_email_notification,
        feature_bundle=analytics_instance_feature_bundle,
        freeform_tags={
            "Department": "Finance",
        },
        kms_key_id=test_key["id"],
        network_endpoint_details={
            "network_endpoint_type": analytics_instance_network_endpoint_details_network_endpoint_type,
            "network_security_group_ids": analytics_instance_network_endpoint_details_network_security_group_ids,
            "subnet_id": test_subnet["id"],
            "vcn_id": test_vcn["id"],
            "whitelisted_ips": analytics_instance_network_endpoint_details_whitelisted_ips,
            "whitelisted_services": analytics_instance_network_endpoint_details_whitelisted_services,
            "whitelisted_vcns": [{
                "id": analytics_instance_network_endpoint_details_whitelisted_vcns_id,
                "whitelisted_ips": analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips,
            }],
        },
        update_channel=analytics_instance_update_channel)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Analytics"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Analytics.NewAnalyticsInstance(ctx, "test_analytics_instance", &Analytics.AnalyticsInstanceArgs{
    			Capacity: &analytics.AnalyticsInstanceCapacityArgs{
    				CapacityType:  pulumi.Any(analyticsInstanceCapacityCapacityType),
    				CapacityValue: pulumi.Any(analyticsInstanceCapacityCapacityValue),
    			},
    			CompartmentId:   pulumi.Any(compartmentId),
    			FeatureSet:      pulumi.Any(analyticsInstanceFeatureSet),
    			IdcsAccessToken: pulumi.Any(analyticsInstanceIdcsAccessToken),
    			LicenseType:     pulumi.Any(analyticsInstanceLicenseType),
    			Name:            pulumi.Any(analyticsInstanceName),
    			AdminUser:       pulumi.Any(analyticsInstanceAdminUser),
    			DefinedTags: pulumi.StringMap{
    				"Operations.CostCenter": pulumi.String("42"),
    			},
    			Description:       pulumi.Any(analyticsInstanceDescription),
    			DomainId:          pulumi.Any(testDomain.Id),
    			EmailNotification: pulumi.Any(analyticsInstanceEmailNotification),
    			FeatureBundle:     pulumi.Any(analyticsInstanceFeatureBundle),
    			FreeformTags: pulumi.StringMap{
    				"Department": pulumi.String("Finance"),
    			},
    			KmsKeyId: pulumi.Any(testKey.Id),
    			NetworkEndpointDetails: &analytics.AnalyticsInstanceNetworkEndpointDetailsArgs{
    				NetworkEndpointType:     pulumi.Any(analyticsInstanceNetworkEndpointDetailsNetworkEndpointType),
    				NetworkSecurityGroupIds: pulumi.Any(analyticsInstanceNetworkEndpointDetailsNetworkSecurityGroupIds),
    				SubnetId:                pulumi.Any(testSubnet.Id),
    				VcnId:                   pulumi.Any(testVcn.Id),
    				WhitelistedIps:          pulumi.Any(analyticsInstanceNetworkEndpointDetailsWhitelistedIps),
    				WhitelistedServices:     pulumi.Any(analyticsInstanceNetworkEndpointDetailsWhitelistedServices),
    				WhitelistedVcns: analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArray{
    					&analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs{
    						Id:             pulumi.Any(analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsId),
    						WhitelistedIps: pulumi.Any(analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsWhitelistedIps),
    					},
    				},
    			},
    			UpdateChannel: pulumi.Any(analyticsInstanceUpdateChannel),
    		})
    		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 = new Oci.Analytics.AnalyticsInstance("test_analytics_instance", new()
        {
            Capacity = new Oci.Analytics.Inputs.AnalyticsInstanceCapacityArgs
            {
                CapacityType = analyticsInstanceCapacityCapacityType,
                CapacityValue = analyticsInstanceCapacityCapacityValue,
            },
            CompartmentId = compartmentId,
            FeatureSet = analyticsInstanceFeatureSet,
            IdcsAccessToken = analyticsInstanceIdcsAccessToken,
            LicenseType = analyticsInstanceLicenseType,
            Name = analyticsInstanceName,
            AdminUser = analyticsInstanceAdminUser,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = analyticsInstanceDescription,
            DomainId = testDomain.Id,
            EmailNotification = analyticsInstanceEmailNotification,
            FeatureBundle = analyticsInstanceFeatureBundle,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            KmsKeyId = testKey.Id,
            NetworkEndpointDetails = new Oci.Analytics.Inputs.AnalyticsInstanceNetworkEndpointDetailsArgs
            {
                NetworkEndpointType = analyticsInstanceNetworkEndpointDetailsNetworkEndpointType,
                NetworkSecurityGroupIds = analyticsInstanceNetworkEndpointDetailsNetworkSecurityGroupIds,
                SubnetId = testSubnet.Id,
                VcnId = testVcn.Id,
                WhitelistedIps = analyticsInstanceNetworkEndpointDetailsWhitelistedIps,
                WhitelistedServices = analyticsInstanceNetworkEndpointDetailsWhitelistedServices,
                WhitelistedVcns = new[]
                {
                    new Oci.Analytics.Inputs.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs
                    {
                        Id = analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsId,
                        WhitelistedIps = analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsWhitelistedIps,
                    },
                },
            },
            UpdateChannel = analyticsInstanceUpdateChannel,
        });
    
    });
    
    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(analyticsInstanceCapacityCapacityType)
                    .capacityValue(analyticsInstanceCapacityCapacityValue)
                    .build())
                .compartmentId(compartmentId)
                .featureSet(analyticsInstanceFeatureSet)
                .idcsAccessToken(analyticsInstanceIdcsAccessToken)
                .licenseType(analyticsInstanceLicenseType)
                .name(analyticsInstanceName)
                .adminUser(analyticsInstanceAdminUser)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(analyticsInstanceDescription)
                .domainId(testDomain.id())
                .emailNotification(analyticsInstanceEmailNotification)
                .featureBundle(analyticsInstanceFeatureBundle)
                .freeformTags(Map.of("Department", "Finance"))
                .kmsKeyId(testKey.id())
                .networkEndpointDetails(AnalyticsInstanceNetworkEndpointDetailsArgs.builder()
                    .networkEndpointType(analyticsInstanceNetworkEndpointDetailsNetworkEndpointType)
                    .networkSecurityGroupIds(analyticsInstanceNetworkEndpointDetailsNetworkSecurityGroupIds)
                    .subnetId(testSubnet.id())
                    .vcnId(testVcn.id())
                    .whitelistedIps(analyticsInstanceNetworkEndpointDetailsWhitelistedIps)
                    .whitelistedServices(analyticsInstanceNetworkEndpointDetailsWhitelistedServices)
                    .whitelistedVcns(AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs.builder()
                        .id(analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsId)
                        .whitelistedIps(analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsWhitelistedIps)
                        .build())
                    .build())
                .updateChannel(analyticsInstanceUpdateChannel)
                .build());
    
        }
    }
    
    resources:
      testAnalyticsInstance:
        type: oci:Analytics:AnalyticsInstance
        name: test_analytics_instance
        properties:
          capacity:
            capacityType: ${analyticsInstanceCapacityCapacityType}
            capacityValue: ${analyticsInstanceCapacityCapacityValue}
          compartmentId: ${compartmentId}
          featureSet: ${analyticsInstanceFeatureSet}
          idcsAccessToken: ${analyticsInstanceIdcsAccessToken}
          licenseType: ${analyticsInstanceLicenseType}
          name: ${analyticsInstanceName}
          adminUser: ${analyticsInstanceAdminUser}
          definedTags:
            Operations.CostCenter: '42'
          description: ${analyticsInstanceDescription}
          domainId: ${testDomain.id}
          emailNotification: ${analyticsInstanceEmailNotification}
          featureBundle: ${analyticsInstanceFeatureBundle}
          freeformTags:
            Department: Finance
          kmsKeyId: ${testKey.id}
          networkEndpointDetails:
            networkEndpointType: ${analyticsInstanceNetworkEndpointDetailsNetworkEndpointType}
            networkSecurityGroupIds: ${analyticsInstanceNetworkEndpointDetailsNetworkSecurityGroupIds}
            subnetId: ${testSubnet.id}
            vcnId: ${testVcn.id}
            whitelistedIps: ${analyticsInstanceNetworkEndpointDetailsWhitelistedIps}
            whitelistedServices: ${analyticsInstanceNetworkEndpointDetailsWhitelistedServices}
            whitelistedVcns:
              - id: ${analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsId}
                whitelistedIps: ${analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsWhitelistedIps}
          updateChannel: ${analyticsInstanceUpdateChannel}
    

    Create AnalyticsInstance Resource

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

    Constructor syntax

    new AnalyticsInstance(name: string, args: AnalyticsInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def AnalyticsInstance(resource_name: str,
                          args: AnalyticsInstanceArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def AnalyticsInstance(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          license_type: Optional[str] = None,
                          compartment_id: Optional[str] = None,
                          feature_set: Optional[str] = None,
                          capacity: Optional[_analytics.AnalyticsInstanceCapacityArgs] = None,
                          description: Optional[str] = None,
                          domain_id: Optional[str] = None,
                          email_notification: Optional[str] = None,
                          idcs_access_token: Optional[str] = None,
                          freeform_tags: Optional[Mapping[str, str]] = None,
                          defined_tags: Optional[Mapping[str, str]] = None,
                          feature_bundle: Optional[str] = None,
                          kms_key_id: Optional[str] = None,
                          admin_user: Optional[str] = None,
                          name: Optional[str] = None,
                          network_endpoint_details: Optional[_analytics.AnalyticsInstanceNetworkEndpointDetailsArgs] = None,
                          state: Optional[str] = None,
                          update_channel: Optional[str] = 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.
    
    

    Parameters

    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.

    Constructor example

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

    var analyticsInstanceResource = new Oci.Analytics.AnalyticsInstance("analyticsInstanceResource", new()
    {
        LicenseType = "string",
        CompartmentId = "string",
        FeatureSet = "string",
        Capacity = new Oci.Analytics.Inputs.AnalyticsInstanceCapacityArgs
        {
            CapacityType = "string",
            CapacityValue = 0,
        },
        Description = "string",
        DomainId = "string",
        EmailNotification = "string",
        IdcsAccessToken = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        DefinedTags = 
        {
            { "string", "string" },
        },
        FeatureBundle = "string",
        KmsKeyId = "string",
        AdminUser = "string",
        Name = "string",
        NetworkEndpointDetails = new Oci.Analytics.Inputs.AnalyticsInstanceNetworkEndpointDetailsArgs
        {
            NetworkEndpointType = "string",
            NetworkSecurityGroupIds = new[]
            {
                "string",
            },
            SubnetId = "string",
            VcnId = "string",
            WhitelistedIps = new[]
            {
                "string",
            },
            WhitelistedServices = new[]
            {
                "string",
            },
            WhitelistedVcns = new[]
            {
                new Oci.Analytics.Inputs.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs
                {
                    Id = "string",
                    WhitelistedIps = new[]
                    {
                        "string",
                    },
                },
            },
        },
        State = "string",
        UpdateChannel = "string",
    });
    
    example, err := Analytics.NewAnalyticsInstance(ctx, "analyticsInstanceResource", &Analytics.AnalyticsInstanceArgs{
    	LicenseType:   pulumi.String("string"),
    	CompartmentId: pulumi.String("string"),
    	FeatureSet:    pulumi.String("string"),
    	Capacity: &analytics.AnalyticsInstanceCapacityArgs{
    		CapacityType:  pulumi.String("string"),
    		CapacityValue: pulumi.Int(0),
    	},
    	Description:       pulumi.String("string"),
    	DomainId:          pulumi.String("string"),
    	EmailNotification: pulumi.String("string"),
    	IdcsAccessToken:   pulumi.String("string"),
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	FeatureBundle: pulumi.String("string"),
    	KmsKeyId:      pulumi.String("string"),
    	AdminUser:     pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	NetworkEndpointDetails: &analytics.AnalyticsInstanceNetworkEndpointDetailsArgs{
    		NetworkEndpointType: pulumi.String("string"),
    		NetworkSecurityGroupIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SubnetId: pulumi.String("string"),
    		VcnId:    pulumi.String("string"),
    		WhitelistedIps: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		WhitelistedServices: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		WhitelistedVcns: analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArray{
    			&analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs{
    				Id: pulumi.String("string"),
    				WhitelistedIps: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    			},
    		},
    	},
    	State:         pulumi.String("string"),
    	UpdateChannel: pulumi.String("string"),
    })
    
    var analyticsInstanceResource = new AnalyticsInstance("analyticsInstanceResource", AnalyticsInstanceArgs.builder()
        .licenseType("string")
        .compartmentId("string")
        .featureSet("string")
        .capacity(AnalyticsInstanceCapacityArgs.builder()
            .capacityType("string")
            .capacityValue(0)
            .build())
        .description("string")
        .domainId("string")
        .emailNotification("string")
        .idcsAccessToken("string")
        .freeformTags(Map.of("string", "string"))
        .definedTags(Map.of("string", "string"))
        .featureBundle("string")
        .kmsKeyId("string")
        .adminUser("string")
        .name("string")
        .networkEndpointDetails(AnalyticsInstanceNetworkEndpointDetailsArgs.builder()
            .networkEndpointType("string")
            .networkSecurityGroupIds("string")
            .subnetId("string")
            .vcnId("string")
            .whitelistedIps("string")
            .whitelistedServices("string")
            .whitelistedVcns(AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs.builder()
                .id("string")
                .whitelistedIps("string")
                .build())
            .build())
        .state("string")
        .updateChannel("string")
        .build());
    
    analytics_instance_resource = oci.analytics.AnalyticsInstance("analyticsInstanceResource",
        license_type="string",
        compartment_id="string",
        feature_set="string",
        capacity=oci.analytics.AnalyticsInstanceCapacityArgs(
            capacity_type="string",
            capacity_value=0,
        ),
        description="string",
        domain_id="string",
        email_notification="string",
        idcs_access_token="string",
        freeform_tags={
            "string": "string",
        },
        defined_tags={
            "string": "string",
        },
        feature_bundle="string",
        kms_key_id="string",
        admin_user="string",
        name="string",
        network_endpoint_details=oci.analytics.AnalyticsInstanceNetworkEndpointDetailsArgs(
            network_endpoint_type="string",
            network_security_group_ids=["string"],
            subnet_id="string",
            vcn_id="string",
            whitelisted_ips=["string"],
            whitelisted_services=["string"],
            whitelisted_vcns=[oci.analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs(
                id="string",
                whitelisted_ips=["string"],
            )],
        ),
        state="string",
        update_channel="string")
    
    const analyticsInstanceResource = new oci.analytics.AnalyticsInstance("analyticsInstanceResource", {
        licenseType: "string",
        compartmentId: "string",
        featureSet: "string",
        capacity: {
            capacityType: "string",
            capacityValue: 0,
        },
        description: "string",
        domainId: "string",
        emailNotification: "string",
        idcsAccessToken: "string",
        freeformTags: {
            string: "string",
        },
        definedTags: {
            string: "string",
        },
        featureBundle: "string",
        kmsKeyId: "string",
        adminUser: "string",
        name: "string",
        networkEndpointDetails: {
            networkEndpointType: "string",
            networkSecurityGroupIds: ["string"],
            subnetId: "string",
            vcnId: "string",
            whitelistedIps: ["string"],
            whitelistedServices: ["string"],
            whitelistedVcns: [{
                id: "string",
                whitelistedIps: ["string"],
            }],
        },
        state: "string",
        updateChannel: "string",
    });
    
    type: oci:Analytics:AnalyticsInstance
    properties:
        adminUser: string
        capacity:
            capacityType: string
            capacityValue: 0
        compartmentId: string
        definedTags:
            string: string
        description: string
        domainId: string
        emailNotification: string
        featureBundle: string
        featureSet: string
        freeformTags:
            string: string
        idcsAccessToken: string
        kmsKeyId: string
        licenseType: string
        name: string
        networkEndpointDetails:
            networkEndpointType: string
            networkSecurityGroupIds:
                - string
            subnetId: string
            vcnId: string
            whitelistedIps:
                - string
            whitelistedServices:
                - string
            whitelistedVcns:
                - id: string
                  whitelistedIps:
                    - string
        state: string
        updateChannel: string
    

    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 AnalyticsInstanceCapacity
    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.
    LicenseType string
    (Updatable) The license used for the service.
    AdminUser string
    user name of the authorized user.
    DefinedTags Dictionary<string, string>
    (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.
    DomainId string
    domain id for which the user is authorized.
    EmailNotification string
    (Updatable) Email address receiving notifications.
    FeatureBundle string
    The feature set of an Analytics instance.
    FreeformTags Dictionary<string, string>
    (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
    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.
    Name string
    The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
    NetworkEndpointDetails AnalyticsInstanceNetworkEndpointDetails
    Base representation of a network endpoint.
    State string

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

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

    UpdateChannel string
    (Updatable) Analytics instance update channel.
    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.
    LicenseType string
    (Updatable) The license used for the service.
    AdminUser string
    user name of the authorized user.
    DefinedTags map[string]string
    (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.
    DomainId string
    domain id for which the user is authorized.
    EmailNotification string
    (Updatable) Email address receiving notifications.
    FeatureBundle string
    The feature set of an Analytics instance.
    FreeformTags map[string]string
    (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
    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.
    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.

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

    UpdateChannel string
    (Updatable) Analytics instance update channel.
    capacity InstanceCapacity
    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.
    licenseType String
    (Updatable) The license used for the service.
    adminUser String
    user name of the authorized user.
    definedTags Map<String,String>
    (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.
    domainId String
    domain id for which the user is authorized.
    emailNotification String
    (Updatable) Email address receiving notifications.
    featureBundle String
    The feature set of an Analytics instance.
    freeformTags Map<String,String>
    (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
    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.
    name String
    The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
    networkEndpointDetails InstanceNetworkEndpointDetails
    Base representation of a network endpoint.
    state String

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

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

    updateChannel String
    (Updatable) Analytics instance update channel.
    capacity AnalyticsInstanceCapacity
    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.
    licenseType string
    (Updatable) The license used for the service.
    adminUser string
    user name of the authorized user.
    definedTags {[key: string]: string}
    (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.
    domainId string
    domain id for which the user is authorized.
    emailNotification string
    (Updatable) Email address receiving notifications.
    featureBundle string
    The feature set of an Analytics instance.
    freeformTags {[key: string]: string}
    (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
    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.
    name string
    The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
    networkEndpointDetails AnalyticsInstanceNetworkEndpointDetails
    Base representation of a network endpoint.
    state string

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

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

    updateChannel string
    (Updatable) Analytics instance update channel.
    capacity analytics.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.
    license_type str
    (Updatable) The license used for the service.
    admin_user str
    user name of the authorized user.
    defined_tags Mapping[str, str]
    (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.
    domain_id str
    domain id for which the user is authorized.
    email_notification str
    (Updatable) Email address receiving notifications.
    feature_bundle str
    The feature set of an Analytics instance.
    freeform_tags Mapping[str, str]
    (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
    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.
    name str
    The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
    network_endpoint_details analytics.AnalyticsInstanceNetworkEndpointDetailsArgs
    Base representation of a network endpoint.
    state str

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

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

    update_channel str
    (Updatable) Analytics instance update channel.
    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.
    licenseType String
    (Updatable) The license used for the service.
    adminUser String
    user name of the authorized user.
    definedTags Map<String>
    (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.
    domainId String
    domain id for which the user is authorized.
    emailNotification String
    (Updatable) Email address receiving notifications.
    featureBundle String
    The feature set of an Analytics instance.
    freeformTags Map<String>
    (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
    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.
    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.

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

    updateChannel String
    (Updatable) Analytics instance update channel.

    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.
    SystemTags Dictionary<string, string>
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    SystemTags map[string]string
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    systemTags Map<String,String>
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    systemTags {[key: string]: string}
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    system_tags Mapping[str, str]
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    systemTags Map<String>
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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,
            admin_user: Optional[str] = None,
            capacity: Optional[_analytics.AnalyticsInstanceCapacityArgs] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            domain_id: Optional[str] = None,
            email_notification: Optional[str] = None,
            feature_bundle: Optional[str] = None,
            feature_set: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = 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,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            update_channel: 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:
    AdminUser string
    user name of the authorized user.
    Capacity AnalyticsInstanceCapacity
    Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (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.
    DomainId string
    domain id for which the user is authorized.
    EmailNotification string
    (Updatable) Email address receiving notifications.
    FeatureBundle string
    The feature set of an Analytics instance.
    FeatureSet string
    Analytics feature set.
    FreeformTags Dictionary<string, string>
    (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
    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
    (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 AnalyticsInstanceNetworkEndpointDetails
    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.

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

    SystemTags Dictionary<string, string>
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    UpdateChannel string
    (Updatable) Analytics instance update channel.
    AdminUser string
    user name of the authorized user.
    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]string
    (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.
    DomainId string
    domain id for which the user is authorized.
    EmailNotification string
    (Updatable) Email address receiving notifications.
    FeatureBundle string
    The feature set of an Analytics instance.
    FeatureSet string
    Analytics feature set.
    FreeformTags map[string]string
    (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
    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
    (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.

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

    SystemTags map[string]string
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    UpdateChannel string
    (Updatable) Analytics instance update channel.
    adminUser String
    user name of the authorized user.
    capacity InstanceCapacity
    Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String,String>
    (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.
    domainId String
    domain id for which the user is authorized.
    emailNotification String
    (Updatable) Email address receiving notifications.
    featureBundle String
    The feature set of an Analytics instance.
    featureSet String
    Analytics feature set.
    freeformTags Map<String,String>
    (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
    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
    (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 InstanceNetworkEndpointDetails
    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.

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

    systemTags Map<String,String>
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    updateChannel String
    (Updatable) Analytics instance update channel.
    adminUser string
    user name of the authorized user.
    capacity AnalyticsInstanceCapacity
    Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
    compartmentId string
    (Updatable) The OCID of the compartment.
    definedTags {[key: string]: string}
    (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.
    domainId string
    domain id for which the user is authorized.
    emailNotification string
    (Updatable) Email address receiving notifications.
    featureBundle string
    The feature set of an Analytics instance.
    featureSet string
    Analytics feature set.
    freeformTags {[key: string]: string}
    (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
    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
    (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 AnalyticsInstanceNetworkEndpointDetails
    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.

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

    systemTags {[key: string]: string}
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    updateChannel string
    (Updatable) Analytics instance update channel.
    admin_user str
    user name of the authorized user.
    capacity analytics.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, str]
    (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.
    domain_id str
    domain id for which the user is authorized.
    email_notification str
    (Updatable) Email address receiving notifications.
    feature_bundle str
    The feature set of an Analytics instance.
    feature_set str
    Analytics feature set.
    freeform_tags Mapping[str, str]
    (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
    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
    (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 analytics.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.

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

    system_tags Mapping[str, str]
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    update_channel str
    (Updatable) Analytics instance update channel.
    adminUser String
    user name of the authorized user.
    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<String>
    (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.
    domainId String
    domain id for which the user is authorized.
    emailNotification String
    (Updatable) Email address receiving notifications.
    featureBundle String
    The feature set of an Analytics instance.
    featureSet String
    Analytics feature set.
    freeformTags Map<String>
    (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
    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
    (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.

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

    systemTags Map<String>
    System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
    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.
    updateChannel String
    (Updatable) Analytics instance update channel.

    Supporting Types

    AnalyticsInstanceCapacity, AnalyticsInstanceCapacityArgs

    CapacityType string
    The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
    CapacityValue int
    (Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.
    CapacityType string
    The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
    CapacityValue int
    (Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.
    capacityType String
    The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
    capacityValue Integer
    (Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.
    capacityType string
    The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
    capacityValue number
    (Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.
    capacity_type str
    The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
    capacity_value int
    (Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.
    capacityType String
    The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
    capacityValue Number
    (Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.

    AnalyticsInstanceNetworkEndpointDetails, AnalyticsInstanceNetworkEndpointDetailsArgs

    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 Sequence[analytics.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, AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcnArgs

    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"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.13.0 published on Tuesday, Oct 22, 2024 by Pulumi