CreateAnalyticsInstanceDetails

class oci.analytics.models.CreateAnalyticsInstanceDetails(**kwargs)

Bases: object

Input payload to create an Anaytics instance.

Attributes:

FEATURE_BUNDLE_EE_EMBEDDED

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails.

FEATURE_BUNDLE_FAW_FREE

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails.

FEATURE_BUNDLE_FAW_PAID

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails.

FEATURE_BUNDLE_FDI_BASE

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails.

FEATURE_BUNDLE_SE_EMBEDDED

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails.

FEATURE_SET_ENTERPRISE_ANALYTICS

A constant which can be used with the feature_set property of a CreateAnalyticsInstanceDetails.

FEATURE_SET_SELF_SERVICE_ANALYTICS

A constant which can be used with the feature_set property of a CreateAnalyticsInstanceDetails.

LICENSE_TYPE_BRING_YOUR_OWN_LICENSE

A constant which can be used with the license_type property of a CreateAnalyticsInstanceDetails.

LICENSE_TYPE_LICENSE_INCLUDED

A constant which can be used with the license_type property of a CreateAnalyticsInstanceDetails.

UPDATE_CHANNEL_EARLY

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails.

UPDATE_CHANNEL_PHASE_1

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails.

UPDATE_CHANNEL_PHASE_2

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails.

UPDATE_CHANNEL_REGULAR

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails.

admin_user

Gets the admin_user of this CreateAnalyticsInstanceDetails.

capacity

[Required] Gets the capacity of this CreateAnalyticsInstanceDetails.

compartment_id

[Required] Gets the compartment_id of this CreateAnalyticsInstanceDetails.

defined_tags

Gets the defined_tags of this CreateAnalyticsInstanceDetails.

description

Gets the description of this CreateAnalyticsInstanceDetails.

domain_id

Gets the domain_id of this CreateAnalyticsInstanceDetails.

email_notification

Gets the email_notification of this CreateAnalyticsInstanceDetails.

feature_bundle

Gets the feature_bundle of this CreateAnalyticsInstanceDetails.

feature_set

[Required] Gets the feature_set of this CreateAnalyticsInstanceDetails.

freeform_tags

Gets the freeform_tags of this CreateAnalyticsInstanceDetails.

idcs_access_token

Gets the idcs_access_token of this CreateAnalyticsInstanceDetails.

kms_key_id

Gets the kms_key_id of this CreateAnalyticsInstanceDetails.

license_type

[Required] Gets the license_type of this CreateAnalyticsInstanceDetails.

name

[Required] Gets the name of this CreateAnalyticsInstanceDetails.

network_endpoint_details

Gets the network_endpoint_details of this CreateAnalyticsInstanceDetails.

update_channel

Gets the update_channel of this CreateAnalyticsInstanceDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateAnalyticsInstanceDetails object with values from keyword arguments.

FEATURE_BUNDLE_EE_EMBEDDED = 'EE_EMBEDDED'

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails. This constant has a value of “EE_EMBEDDED”

FEATURE_BUNDLE_FAW_FREE = 'FAW_FREE'

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails. This constant has a value of “FAW_FREE”

FEATURE_BUNDLE_FAW_PAID = 'FAW_PAID'

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails. This constant has a value of “FAW_PAID”

FEATURE_BUNDLE_FDI_BASE = 'FDI_BASE'

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails. This constant has a value of “FDI_BASE”

FEATURE_BUNDLE_SE_EMBEDDED = 'SE_EMBEDDED'

A constant which can be used with the feature_bundle property of a CreateAnalyticsInstanceDetails. This constant has a value of “SE_EMBEDDED”

FEATURE_SET_ENTERPRISE_ANALYTICS = 'ENTERPRISE_ANALYTICS'

A constant which can be used with the feature_set property of a CreateAnalyticsInstanceDetails. This constant has a value of “ENTERPRISE_ANALYTICS”

FEATURE_SET_SELF_SERVICE_ANALYTICS = 'SELF_SERVICE_ANALYTICS'

A constant which can be used with the feature_set property of a CreateAnalyticsInstanceDetails. This constant has a value of “SELF_SERVICE_ANALYTICS”

LICENSE_TYPE_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'

A constant which can be used with the license_type property of a CreateAnalyticsInstanceDetails. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_TYPE_LICENSE_INCLUDED = 'LICENSE_INCLUDED'

A constant which can be used with the license_type property of a CreateAnalyticsInstanceDetails. This constant has a value of “LICENSE_INCLUDED”

UPDATE_CHANNEL_EARLY = 'EARLY'

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails. This constant has a value of “EARLY”

UPDATE_CHANNEL_PHASE_1 = 'PHASE_1'

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails. This constant has a value of “PHASE_1”

UPDATE_CHANNEL_PHASE_2 = 'PHASE_2'

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails. This constant has a value of “PHASE_2”

UPDATE_CHANNEL_REGULAR = 'REGULAR'

A constant which can be used with the update_channel property of a CreateAnalyticsInstanceDetails. This constant has a value of “REGULAR”

__init__(**kwargs)

Initializes a new CreateAnalyticsInstanceDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this CreateAnalyticsInstanceDetails.

  • description (str) – The value to assign to the description property of this CreateAnalyticsInstanceDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateAnalyticsInstanceDetails.

  • feature_set (str) – The value to assign to the feature_set property of this CreateAnalyticsInstanceDetails. Allowed values for this property are: “SELF_SERVICE_ANALYTICS”, “ENTERPRISE_ANALYTICS”

  • capacity (oci.analytics.models.Capacity) – The value to assign to the capacity property of this CreateAnalyticsInstanceDetails.

  • license_type (str) – The value to assign to the license_type property of this CreateAnalyticsInstanceDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

  • email_notification (str) – The value to assign to the email_notification property of this CreateAnalyticsInstanceDetails.

  • network_endpoint_details (oci.analytics.models.NetworkEndpointDetails) – The value to assign to the network_endpoint_details property of this CreateAnalyticsInstanceDetails.

  • idcs_access_token (str) – The value to assign to the idcs_access_token property of this CreateAnalyticsInstanceDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAnalyticsInstanceDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAnalyticsInstanceDetails.

  • update_channel (str) – The value to assign to the update_channel property of this CreateAnalyticsInstanceDetails. Allowed values for this property are: “REGULAR”, “EARLY”, “PHASE_2”, “PHASE_1”

  • kms_key_id (str) – The value to assign to the kms_key_id property of this CreateAnalyticsInstanceDetails.

  • domain_id (str) – The value to assign to the domain_id property of this CreateAnalyticsInstanceDetails.

  • admin_user (str) – The value to assign to the admin_user property of this CreateAnalyticsInstanceDetails.

  • feature_bundle (str) – The value to assign to the feature_bundle property of this CreateAnalyticsInstanceDetails. Allowed values for this property are: “FAW_PAID”, “FAW_FREE”, “FDI_BASE”, “EE_EMBEDDED”, “SE_EMBEDDED”

property admin_user

Gets the admin_user of this CreateAnalyticsInstanceDetails. 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.

Returns

The admin_user of this CreateAnalyticsInstanceDetails.

Return type

str

property capacity

[Required] Gets the capacity of this CreateAnalyticsInstanceDetails.

Returns

The capacity of this CreateAnalyticsInstanceDetails.

Return type

oci.analytics.models.Capacity

property compartment_id

[Required] Gets the compartment_id of this CreateAnalyticsInstanceDetails. The OCID of the compartment.

Returns

The compartment_id of this CreateAnalyticsInstanceDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateAnalyticsInstanceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateAnalyticsInstanceDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateAnalyticsInstanceDetails. Optional description.

Returns

The description of this CreateAnalyticsInstanceDetails.

Return type

str

property domain_id

Gets the domain_id of this CreateAnalyticsInstanceDetails. The OCID of the identity domain to use for the new Analytics instance. For example: ocid1.domain.oc1..ocid1.domain.oc1..aaaaaa111111bbbbbb222222cccccc333333dddddd444444eeeeee5555.

Returns

The domain_id of this CreateAnalyticsInstanceDetails.

Return type

str

property email_notification

Gets the email_notification of this CreateAnalyticsInstanceDetails. Email address receiving notifications.

Returns

The email_notification of this CreateAnalyticsInstanceDetails.

Return type

str

property feature_bundle

Gets the feature_bundle of this CreateAnalyticsInstanceDetails. The feature set of an Analytics instance.

Allowed values for this property are: “FAW_PAID”, “FAW_FREE”, “FDI_BASE”, “EE_EMBEDDED”, “SE_EMBEDDED”

Returns

The feature_bundle of this CreateAnalyticsInstanceDetails.

Return type

str

property feature_set

[Required] Gets the feature_set of this CreateAnalyticsInstanceDetails. The feature set. Either SELF_SERVICE_ANALYTICS (Professional Edition) or ENTERPRISE_ANALYTICS (Enterprise Edition).

Allowed values for this property are: “SELF_SERVICE_ANALYTICS”, “ENTERPRISE_ANALYTICS”

Returns

The feature_set of this CreateAnalyticsInstanceDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateAnalyticsInstanceDetails. 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”}

Returns

The freeform_tags of this CreateAnalyticsInstanceDetails.

Return type

dict(str, str)

property idcs_access_token

Gets the idcs_access_token of this CreateAnalyticsInstanceDetails. IDCS access token identifying a stripe and service administrator user.

Returns

The idcs_access_token of this CreateAnalyticsInstanceDetails.

Return type

str

property kms_key_id

Gets the kms_key_id of this CreateAnalyticsInstanceDetails. OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates that the default Oracle-managed encryption is used.

Returns

The kms_key_id of this CreateAnalyticsInstanceDetails.

Return type

str

property license_type

[Required] Gets the license_type of this CreateAnalyticsInstanceDetails. The license used for the service.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

Returns

The license_type of this CreateAnalyticsInstanceDetails.

Return type

str

property name

[Required] Gets the name of this CreateAnalyticsInstanceDetails. 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 (-).

Returns

The name of this CreateAnalyticsInstanceDetails.

Return type

str

property network_endpoint_details

Gets the network_endpoint_details of this CreateAnalyticsInstanceDetails.

Returns

The network_endpoint_details of this CreateAnalyticsInstanceDetails.

Return type

oci.analytics.models.NetworkEndpointDetails

property update_channel

Gets the update_channel of this CreateAnalyticsInstanceDetails. The Analytics instance update cycle.

Allowed values for this property are: “REGULAR”, “EARLY”, “PHASE_2”, “PHASE_1”

Returns

The update_channel of this CreateAnalyticsInstanceDetails.

Return type

str