import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testAnalyticsInstance = new oci.analytics.AnalyticsInstance("test_analytics_instance", { * capacity: { * capacityType: analyticsInstanceCapacityCapacityType, * capacityValue: Number(analyticsInstanceCapacityCapacityValue), * }, * compartmentId: compartmentId, * featureSet: analyticsInstanceFeatureSet, * idcsAccessToken: analyticsInstanceIdcsAccessToken, * licenseType: analyticsInstanceLicenseType, * name: analyticsInstanceName, * adminUser: analyticsInstanceAdminUser, * definedTags: { * "Operations.CostCenter": "42", * }, * description: analyticsInstanceDescription, * domainId: testDomain.id, * emailNotification: analyticsInstanceEmailNotification, * featureBundle: analyticsInstanceFeatureBundle, * freeformTags: { * Department: "Finance", * }, * kmsKeyId: testKey.id, * networkEndpointDetails: { * networkEndpointType: analyticsInstanceNetworkEndpointDetailsNetworkEndpointType, * networkSecurityGroupIds: analyticsInstanceNetworkEndpointDetailsNetworkSecurityGroupIds, * subnetId: testSubnet.id, * vcnId: testVcn.id, * whitelistedIps: analyticsInstanceNetworkEndpointDetailsWhitelistedIps, * whitelistedServices: analyticsInstanceNetworkEndpointDetailsWhitelistedServices, * whitelistedVcns: [{ * id: analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsId, * whitelistedIps: analyticsInstanceNetworkEndpointDetailsWhitelistedVcnsWhitelistedIps, * }], * }, * updateChannel: analyticsInstanceUpdateChannel, * }); * ``` * * ## Import * * AnalyticsInstances can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Analytics/analyticsInstance:AnalyticsInstance test_analytics_instance "id" * ``` */ export declare class AnalyticsInstance extends pulumi.CustomResource { /** * Get an existing AnalyticsInstance resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: AnalyticsInstanceState, opts?: pulumi.CustomResourceOptions): AnalyticsInstance; /** * Returns true if the given object is an instance of AnalyticsInstance. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is AnalyticsInstance; /** * 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. */ readonly adminUser: pulumi.Output; /** * Service instance capacity metadata (for example, OLPU count, number of users, and so on). */ readonly capacity: pulumi.Output; /** * (Updatable) The OCID of the compartment. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Optional description. */ readonly description: pulumi.Output; /** * The OCID of the identity domain to use for the new Analytics instance. For example: ocid1.domain.oc1..ocid1.domain.oc1..aaaaaa111111bbbbbb222222cccccc333333dddddd444444eeeeee5555. */ readonly domainId: pulumi.Output; /** * (Updatable) Email address receiving notifications. */ readonly emailNotification: pulumi.Output; /** * The feature set of an Analytics instance. */ readonly featureBundle: pulumi.Output; /** * The feature set. Either `SELF_SERVICE_ANALYTICS` (Professional Edition) or `ENTERPRISE_ANALYTICS` (Enterprise Edition). */ readonly featureSet: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * IDCS access token identifying a stripe and service administrator user. */ readonly idcsAccessToken: pulumi.Output; /** * 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. */ readonly kmsKeyId: pulumi.Output; /** * (Updatable) The license used for the service. */ readonly licenseType: pulumi.Output; /** * 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 (-). */ readonly name: pulumi.Output; /** * Base representation of a network endpoint. */ readonly networkEndpointDetails: pulumi.Output; /** * List of resource groups for this Analytics instance. The resource group id must be unique within the instance. */ readonly resourceGroups: pulumi.Output; /** * URL of the Analytics instance. */ readonly serviceUrl: pulumi.Output; /** * (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 */ readonly state: pulumi.Output; /** * System tags for this resource. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.key": "value"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the Analytics instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * 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. */ readonly timeUpdated: pulumi.Output; /** * (Updatable) Analytics instance update channel. */ readonly updateChannel: pulumi.Output; /** * Create a AnalyticsInstance resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: AnalyticsInstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AnalyticsInstance resources. */ export interface AnalyticsInstanceState { /** * 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. */ adminUser?: pulumi.Input; /** * Service instance capacity metadata (for example, OLPU count, number of users, and so on). */ capacity?: pulumi.Input; /** * (Updatable) The OCID of the compartment. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Optional description. */ description?: pulumi.Input; /** * The OCID of the identity domain to use for the new Analytics instance. For example: ocid1.domain.oc1..ocid1.domain.oc1..aaaaaa111111bbbbbb222222cccccc333333dddddd444444eeeeee5555. */ domainId?: pulumi.Input; /** * (Updatable) Email address receiving notifications. */ emailNotification?: pulumi.Input; /** * The feature set of an Analytics instance. */ featureBundle?: pulumi.Input; /** * The feature set. Either `SELF_SERVICE_ANALYTICS` (Professional Edition) or `ENTERPRISE_ANALYTICS` (Enterprise Edition). */ featureSet?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * IDCS access token identifying a stripe and service administrator user. */ idcsAccessToken?: pulumi.Input; /** * 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. */ kmsKeyId?: pulumi.Input; /** * (Updatable) The license used for the service. */ licenseType?: pulumi.Input; /** * 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 (-). */ name?: pulumi.Input; /** * Base representation of a network endpoint. */ networkEndpointDetails?: pulumi.Input; /** * List of resource groups for this Analytics instance. The resource group id must be unique within the instance. */ resourceGroups?: pulumi.Input[] | undefined>; /** * URL of the Analytics instance. */ serviceUrl?: pulumi.Input; /** * (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 */ state?: pulumi.Input; /** * System tags for this resource. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.key": "value"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the Analytics instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated?: pulumi.Input; /** * 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. */ timeUpdated?: pulumi.Input; /** * (Updatable) Analytics instance update channel. */ updateChannel?: pulumi.Input; } /** * The set of arguments for constructing a AnalyticsInstance resource. */ export interface AnalyticsInstanceArgs { /** * 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. */ adminUser?: pulumi.Input; /** * Service instance capacity metadata (for example, OLPU count, number of users, and so on). */ capacity: pulumi.Input; /** * (Updatable) The OCID of the compartment. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Optional description. */ description?: pulumi.Input; /** * The OCID of the identity domain to use for the new Analytics instance. For example: ocid1.domain.oc1..ocid1.domain.oc1..aaaaaa111111bbbbbb222222cccccc333333dddddd444444eeeeee5555. */ domainId?: pulumi.Input; /** * (Updatable) Email address receiving notifications. */ emailNotification?: pulumi.Input; /** * The feature set of an Analytics instance. */ featureBundle?: pulumi.Input; /** * The feature set. Either `SELF_SERVICE_ANALYTICS` (Professional Edition) or `ENTERPRISE_ANALYTICS` (Enterprise Edition). */ featureSet: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * IDCS access token identifying a stripe and service administrator user. */ idcsAccessToken?: pulumi.Input; /** * 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. */ kmsKeyId?: pulumi.Input; /** * (Updatable) The license used for the service. */ licenseType: pulumi.Input; /** * 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 (-). */ name?: pulumi.Input; /** * Base representation of a network endpoint. */ networkEndpointDetails?: pulumi.Input; /** * (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 */ state?: pulumi.Input; /** * (Updatable) Analytics instance update channel. */ updateChannel?: pulumi.Input; } //# sourceMappingURL=analyticsInstance.d.ts.map