Analytics: AnalyticsInstance¶
Manage OCI Analytics instances. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | analytics |
| Resource | AnalyticsInstance |
| API Version | analytics.oracle.com/v1beta1 |
| Package | Analytics |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-analytics-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/analytics_v1beta1_analyticsinstance.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
adminUser |
user name of the authorized user. | string |
No |
capacity |
AnalyticsInstanceCapacity defines nested fields for AnalyticsInstance.Capacity. | object |
Yes |
compartmentId |
The OCID of the compartment. | string |
Yes |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
description |
Optional description. | string |
No |
domainId |
domain id for which the user is authorized. | string |
No |
emailNotification |
Email address receiving notifications. | string |
No |
featureBundle |
The feature set of an Analytics instance. | string |
No |
featureSet |
Analytics feature set. | string |
Yes |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
idcsAccessToken |
IDCS access token identifying a stripe and service administrator user. | string |
No |
kmsKeyId |
OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. | string |
No |
licenseType |
The license used for the service. | string |
Yes |
name |
The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed. | string |
Yes |
networkEndpointDetails |
AnalyticsInstanceNetworkEndpointDetails defines nested fields for AnalyticsInstance.NetworkEndpointDetails. | object |
No |
updateChannel |
Analytics instance update channel. | string |
No |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
capacity |
AnalyticsInstanceCapacity defines nested fields for AnalyticsInstance.Capacity. | object |
No |
compartmentId |
The OCID of the compartment. | string |
No |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
description |
Optional description. | string |
No |
domainId |
Identity domain OCID. | string |
No |
emailNotification |
Email address receiving notifications. | string |
No |
featureBundle |
The feature set of an Analytics instance. | string |
No |
featureSet |
Analytics feature set. | string |
No |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
id |
The resource OCID. | string |
No |
kmsKeyId |
OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. | string |
No |
licenseType |
The license used for the service. | string |
No |
lifecycleState |
The current state of an instance. | string |
No |
name |
The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed. | string |
No |
networkEndpointDetails |
AnalyticsInstanceNetworkEndpointDetails defines nested fields for AnalyticsInstance.NetworkEndpointDetails. | object |
No |
privateAccessChannels |
Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE. | map[string, object] |
No |
serviceUrl |
URL of the Analytics service. | string |
No |
status |
- | object |
Yes |
systemTags |
System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"key": "value"}} |
map[string, map[string, string]] |
No |
timeCreated |
The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
string |
No |
timeUpdated |
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. | string |
No |
updateChannel |
Analytics instance update channel. | string |
No |
vanityUrlDetails |
Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE. | map[string, object] |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/analytics_v1beta1_analyticsinstance.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: analytics.oracle.com/v1beta1
kind: AnalyticsInstance
metadata:
name: analyticsinstance-sample
spec: {}