analytics.oracle.com/v1beta1¶
APIVersion: analytics.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes analytics.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| AnalyticsInstance | Namespaced | Sample | - |
AnalyticsInstance¶
Manage OCI Analytics instances.
Plural:analyticsinstancesScope:NamespacedAPIVersion:analytics.oracle.com/v1beta1Sample: Sample (config/samples/analytics_v1beta1_analyticsinstance.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
AnalyticsInstanceSpec defines the desired state of AnalyticsInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
Spec.capacity¶
Back to AnalyticsInstance spec
AnalyticsInstanceCapacity defines nested fields for AnalyticsInstance.Capacity.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
capacityType |
The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT | string |
Yes | - | - |
capacityValue |
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. | integer |
Yes | - | - |
Spec.networkEndpointDetails¶
Back to AnalyticsInstance spec
AnalyticsInstanceNetworkEndpointDetails defines nested fields for AnalyticsInstance.NetworkEndpointDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
networkEndpointType |
- | string |
No | - | - |
networkSecurityGroupIds |
Network Security Group OCIDs for an Analytics instance. | list[string] |
No | - | - |
subnetId |
The subnet OCID for the private endpoint. | string |
No | - | - |
vcnId |
The VCN OCID for the private endpoint. | string |
No | - | - |
whitelistedIps |
Source IP addresses or IP address ranges in ingress rules. | list[string] |
No | - | - |
whitelistedServices |
Oracle Cloud Services that are allowed to access this Analytics instance. | list[string] |
No | - | - |
whitelistedVcns |
Virtual Cloud Networks allowed to access this network endpoint. | list[object] |
No | - | - |
Spec.networkEndpointDetails.whitelistedVcns[]¶
Back to AnalyticsInstance spec
AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn defines nested fields for AnalyticsInstance.NetworkEndpointDetails.WhitelistedVcn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
The Virtual Cloud Network OCID. | string |
Yes | - | - |
whitelistedIps |
Source IP addresses or IP address ranges in ingress rules. | list[string] |
No | - | - |
Status¶
AnalyticsInstanceStatus defines the observed state of AnalyticsInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
Status.capacity¶
Back to AnalyticsInstance status
AnalyticsInstanceCapacity defines nested fields for AnalyticsInstance.Capacity.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
capacityType |
The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT | string |
Yes | - | - |
capacityValue |
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. | integer |
Yes | - | - |
Status.networkEndpointDetails¶
Back to AnalyticsInstance status
AnalyticsInstanceNetworkEndpointDetails defines nested fields for AnalyticsInstance.NetworkEndpointDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
networkEndpointType |
- | string |
No | - | - |
networkSecurityGroupIds |
Network Security Group OCIDs for an Analytics instance. | list[string] |
No | - | - |
subnetId |
The subnet OCID for the private endpoint. | string |
No | - | - |
vcnId |
The VCN OCID for the private endpoint. | string |
No | - | - |
whitelistedIps |
Source IP addresses or IP address ranges in ingress rules. | list[string] |
No | - | - |
whitelistedServices |
Oracle Cloud Services that are allowed to access this Analytics instance. | list[string] |
No | - | - |
whitelistedVcns |
Virtual Cloud Networks allowed to access this network endpoint. | list[object] |
No | - | - |
Status.networkEndpointDetails.whitelistedVcns[]¶
Back to AnalyticsInstance status
AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn defines nested fields for AnalyticsInstance.NetworkEndpointDetails.WhitelistedVcn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
id |
The Virtual Cloud Network OCID. | string |
Yes | - | - |
whitelistedIps |
Source IP addresses or IP address ranges in ingress rules. | list[string] |
No | - | - |
Status.privateAccessChannels{}¶
Back to AnalyticsInstance status
AnalyticsInstancePrivateAccessChannels defines nested fields for AnalyticsInstance.PrivateAccessChannels.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
displayName |
Display Name of the Private Access Channel. | string |
No | - | - |
egressSourceIpAddresses |
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources. | list[string] |
No | - | - |
ipAddress |
IP Address of the Private Access channel. | string |
No | - | - |
key |
Private Access Channel unique identifier key. | string |
No | - | - |
networkSecurityGroupIds |
Network Security Group OCIDs for an Analytics instance. | list[string] |
No | - | - |
privateSourceDnsZones |
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered. | list[object] |
No | - | - |
privateSourceScanHosts |
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance. | list[object] |
No | - | - |
subnetId |
OCID of the customer subnet connected to private access channel. | string |
No | - | - |
vcnId |
OCID of the customer VCN peered with private access channel. | string |
No | - | - |
Status.privateAccessChannels{}.privateSourceDnsZones[]¶
Back to AnalyticsInstance status
AnalyticsInstancePrivateAccessChannelsPrivateSourceDnsZone defines nested fields for AnalyticsInstance.PrivateAccessChannels.PrivateSourceDnsZone.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description of private source dns zone. | string |
No | - | - |
dnsZone |
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com. | string |
No | - | - |
Status.privateAccessChannels{}.privateSourceScanHosts[]¶
Back to AnalyticsInstance status
AnalyticsInstancePrivateAccessChannelsPrivateSourceScanHost defines nested fields for AnalyticsInstance.PrivateAccessChannels.PrivateSourceScanHost.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description of private source scan host zone. | string |
No | - | - |
scanHostname |
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com. | string |
No | - | - |
scanPort |
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521). | integer |
No | - | - |
Status.status¶
Back to AnalyticsInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to AnalyticsInstance status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to AnalyticsInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to AnalyticsInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.vanityUrlDetails{}¶
Back to AnalyticsInstance status
AnalyticsInstanceVanityUrlDetails defines nested fields for AnalyticsInstance.VanityUrlDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description of the vanity url. | string |
No | - | - |
hosts |
List of fully qualified hostnames supported by this vanity URL definition (max of 3). | list[string] |
No | - | - |
key |
The vanity url unique identifier key. | string |
No | - | - |
publicCertificate |
PEM certificate for HTTPS connections. | string |
No | - | - |
urls |
List of urls supported by this vanity URL definition (max of 3). | list[string] |
No | - | - |