oci_analytics_analytics_instance

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

resource "oci_analytics_analytics_instance" "test_analytics_instance" {
	#Required
	capacity {
		#Required
		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
	name = var.analytics_instance_name

	#Optional
	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 {
		#Required
		network_endpoint_type = var.analytics_instance_network_endpoint_details_network_endpoint_type

		#Optional
		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 {

			#Optional
			id = var.analytics_instance_network_endpoint_details_whitelisted_vcns_id
			whitelisted_ips = var.analytics_instance_network_endpoint_details_whitelisted_vcns_whitelisted_ips
		}
	}
}

Argument Reference

The following arguments are supported:

• capacity - (Required) Service instance capacity metadata (e.g.: OLPU count, number of users, …etc…).
  • capacity_type - (Required) The capacity model to use.
  • capacity_value - (Required) (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.
• compartment_id - (Required) (Updatable) The OCID of the compartment.
• defined_tags - (Optional) (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 - (Optional) (Updatable) Optional description.
• email_notification - (Optional) (Updatable) Email address receiving notifications.
• feature_set - (Required) Analytics feature set.
• freeform_tags - (Optional) (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 - (Required) IDCS access token identifying a stripe and service administrator user.
• kms_key_id - (Optional) 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 - (Required) (Updatable) The license used for the service.
• name - (Required) The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
• network_endpoint_details - (Optional) Base representation of a network endpoint.
  • network_endpoint_type - (Required) The type of network endpoint.
  • network_security_group_ids - (Applicable when network_endpoint_type=PRIVATE) Network Security Group OCIDs for an Analytics instance.
  • subnet_id - (Required when network_endpoint_type=PRIVATE) The subnet OCID for the private endpoint.
  • vcn_id - (Required when network_endpoint_type=PRIVATE) The VCN OCID for the private endpoint.
  • whitelisted_ips - (Applicable when network_endpoint_type=PUBLIC) Source IP addresses or IP address ranges in ingress rules.
  • whitelisted_services - (Applicable when network_endpoint_type=PUBLIC) Oracle Cloud Services that are allowed to access this Analytics instance.
  • whitelisted_vcns - (Applicable when network_endpoint_type=PUBLIC) Virtual Cloud Networks allowed to access this network endpoint.
    • id - (Required when network_endpoint_type=PUBLIC) The Virtual Cloud Network OCID.
    • whitelisted_ips - (Applicable when network_endpoint_type=PUBLIC) Source IP addresses or IP address ranges in ingress rules.
• state - (Optional) (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

Attributes Reference

The following attributes are exported:

• capacity - Service instance capacity metadata (e.g.: OLPU count, number of users, …etc…).
  • capacity_type - The capacity model to use.
  • capacity_value - 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.
• compartment_id - The OCID of the compartment.
• defined_tags - 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 - Optional description.
• email_notification - Email address receiving notifications.
• feature_set - Analytics feature set.
• freeform_tags - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
• id - The resource OCID.
• kms_key_id - 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 - The license used for the service.
• name - The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
• network_endpoint_details - Base representation of a network endpoint.
  • network_endpoint_type - The type of network endpoint.
  • network_security_group_ids - Network Security Group OCIDs for an Analytics instance.
  • subnet_id - The subnet OCID for the private endpoint.
  • vcn_id - The VCN OCID for the private endpoint.
  • whitelisted_ips - Source IP addresses or IP address ranges in ingress rules.
  • whitelisted_services - Oracle Cloud Services that are allowed to access this Analytics instance.
  • whitelisted_vcns - Virtual Cloud Networks allowed to access this network endpoint.
    • id - The Virtual Cloud Network OCID.
    • whitelisted_ips - Source IP addresses or IP address ranges in ingress rules.
• private_access_channels - Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
  • display_name - Display Name of the Private Access Channel.
  • egress_source_ip_addresses - 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.
  • ip_address - IP Address of the Private Access channel.
  • key - Private Access Channel unique identifier key.
  • network_security_group_ids - Network Security Group OCIDs for an Analytics instance.
  • private_source_dns_zones - 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.
    • description - Description of private source dns zone.
    • dns_zone - Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
  • private_source_scan_hosts - List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
    • description - Description of private source scan host zone.
    • scan_hostname - Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    • scan_port - Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
  • subnet_id - OCID of the customer subnet connected to private access channel.
  • vcn_id - OCID of the customer VCN peered with private access channel.
• service_url - URL of the Analytics service.
• state - The current state of an instance.
• time_created - The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• time_updated - 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.
• vanity_url_details - Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.
  • description - Description of the vanity url.
  • hosts - List of fully qualified hostnames supported by this vanity URL definition (max of 3).
  • key - The vanity url unique identifier key.
  • public_certificate - PEM certificate for HTTPS connections.
  • urls - List of urls supported by this vanity URL definition (max of 3).

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 1 hours), when creating the Analytics Instance * update - (Defaults to 1 hours), when updating the Analytics Instance * delete - (Defaults to 1 hours), when destroying the Analytics Instance

Import

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

$ terraform import oci_analytics_analytics_instance.test_analytics_instance "id"