oci_analytics_analytics_instance

This resource provides the Analytics Instance resource in Oracle Cloud Infrastructure Analytics service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/analytics/latest/AnalyticsInstance

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/analytics

Create a new Analytics instance in the specified compartment. The operation is long-running and creates a new work request.

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
	admin_user = var.analytics_instance_admin_user
	defined_tags = {"Operations.CostCenter"= "42"}
	description = var.analytics_instance_description
	domain_id = oci_identity_domain.test_domain.id
	email_notification = var.analytics_instance_email_notification
	feature_bundle = var.analytics_instance_feature_bundle
	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
		}
	}
	update_channel = var.analytics_instance_update_channel
}

Argument Reference

The following arguments are supported:

• admin_user - (Optional) The Analytics instance administrator user. This must be the user name (not OCID) of a user in the nominated identity domain. For example: john.smith@example.com.
• capacity - (Required) Service instance capacity metadata (for example, OLPU count, number of users, and so on).
  • capacity_type - (Required) The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
  • capacity_value - (Required) (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 Analytics 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.
• domain_id - (Optional) The OCID of the identity domain to use for the new Analytics instance. For example: ocid1.domain.oc1..ocid1.domain.oc1..aaaaaa111111bbbbbb222222cccccc333333dddddd444444eeeeee5555.
• email_notification - (Optional) (Updatable) Email address receiving notifications.
• feature_bundle - (Optional) The feature set of an Analytics instance.
• feature_set - (Required) The feature set. Either SELF_SERVICE_ANALYTICS (Professional Edition) or ENTERPRISE_ANALYTICS (Enterprise Edition).
• 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) OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates that the default Oracle-managed encryption is used.
• 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 can’t be changed. The name must start with a letter and can contain only letters, numbers and dash (-).
• 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 the 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.
• update_channel - (Optional) (Updatable) Analytics instance update channel.
• 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 (for example, OLPU count, number of users, and so on).
  • capacity_type - The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT
  • capacity_value - 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 Analytics 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.
• domain_id - Identity domain OCID.
• email_notification - Email address receiving notifications.
• feature_bundle - The feature set of an Analytics instance.
• feature_set - The feature set. Either SELF_SERVICE_ANALYTICS (Professional Edition) or ENTERPRISE_ANALYTICS (Enterprise Edition).
• 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 - OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates that the default Oracle-managed encryption is used.
• license_type - The license used for the service.
• name - The name of the Analytics instance. This name must be unique in the tenancy and can’t be changed. The name must start with a letter and can contain only letters, numbers and dash (-).
• 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 the 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 - List of IP addresses from the customer subnet connected to the private access channel, used as a source IP by the private access channel for network traffic from the Analytics instance to the 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 the Analytics instance.
  • private_source_dns_zones - List of private source DNS zones registered with the private access channel. The datasource hostnames from these DNS zones / domains will be resolved in the peered VCN for access from the Analytics instance. Minimum 1 private source is required. Maximum 30 private source DNS zones can be registered.
    • description - Description of the private source DNS zone.
    • dns_zone - Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com.
  • private_source_scan_hosts - List of private source database SCAN hosts registered with the private access channel for access from the Analytics instance.
    • description - Description of private source SCAN host zone.
    • scan_hostname - Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
    • scan_port - Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521).
  • subnet_id - OCID of the customer subnet connected to the private access channel.
  • vcn_id - OCID of the customer VCN peered with the private access channel.
• resource_groups - List of resource groups for this Analytics instance. The resource group id must be unique within the instance.
  • capacity - The capacity (in OCPU’s) to be allocated for this resource.
  • description - Optional description of the resource group
  • display_name - Meaningful name of resource group for end user
  • id - Unique identifier and name of resource group. Must be unique within the instance
  • resource_name - Meaningful name of resource group for end user
• service_url - URL of the Analytics instance.
• state - The current state of the Analytics instance.
• system_tags - System tags for this resource. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.key": "value"}
• time_created - The date and time the Analytics instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• time_updated - The date and time the Analytics instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events don’t affect it.
• update_channel - The Analytics instance update cycle.
• 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 (maximum 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 (maximum 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"