import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Bds Instance resource in Oracle Cloud Infrastructure Big Data Service service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/bigdata/latest/BdsInstance * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/big_data_service * * Creates a new BDS instance. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBdsInstance = new oci.bigdataservice.BdsInstance("test_bds_instance", { * clusterPublicKey: bdsInstanceClusterPublicKey, * clusterVersion: bdsInstanceClusterVersion, * compartmentId: compartmentId, * displayName: bdsInstanceDisplayName, * isHighAvailability: bdsInstanceIsHighAvailability === "true", * isSecure: bdsInstanceIsSecure === "true", * masterNode: { * shape: bdsInstanceNodesShape, * subnetId: testSubnet.id, * numberOfNodes: Number(bdsInstanceNumberOfNodes), * blockVolumeSizeInGbs: bdsInstanceNodesBlockVolumeSizeInGbs, * shapeConfig: { * memoryInGbs: Number(bdsInstanceNodesShapeConfigMemoryInGbs), * nvmes: Number(bdsInstanceNodesShapeConfigNvmes), * ocpus: Number(bdsInstanceNodesShapeConfigOcpus), * }, * }, * utilNode: { * shape: bdsInstanceNodesShape, * subnetId: testSubnet.id, * numberOfNodes: Number(bdsInstanceNumberOfNodes), * blockVolumeSizeInGbs: bdsInstanceNodesBlockVolumeSizeInGbs, * shapeConfig: { * memoryInGbs: Number(bdsInstanceNodesShapeConfigMemoryInGbs), * nvmes: Number(bdsInstanceNodesShapeConfigNvmes), * ocpus: Number(bdsInstanceNodesShapeConfigOcpus), * }, * }, * workerNode: { * shape: bdsInstanceNodesShape, * subnetId: testSubnet.id, * numberOfNodes: Number(bdsInstanceNumberOfNodes), * blockVolumeSizeInGbs: bdsInstanceNodesBlockVolumeSizeInGbs, * shapeConfig: { * memoryInGbs: Number(bdsInstanceNodesShapeConfigMemoryInGbs), * nvmes: Number(bdsInstanceNodesShapeConfigNvmes), * ocpus: Number(bdsInstanceNodesShapeConfigOcpus), * }, * }, * computeOnlyWorkerNode: { * shape: bdsInstanceNodesShape, * subnetId: testSubnet.id, * numberOfNodes: Number(bdsInstanceNumberOfNodes), * blockVolumeSizeInGbs: bdsInstanceNodesBlockVolumeSizeInGbs, * shapeConfig: { * memoryInGbs: Number(bdsInstanceNodesShapeConfigMemoryInGbs), * nvmes: Number(bdsInstanceNodesShapeConfigNvmes), * ocpus: Number(bdsInstanceNodesShapeConfigOcpus), * }, * }, * edgeNode: { * shape: bdsInstanceNodesShape, * subnetId: testSubnet.id, * numberOfNodes: Number(bdsInstanceNumberOfNodes), * blockVolumeSizeInGbs: bdsInstanceNodesBlockVolumeSizeInGbs, * shapeConfig: { * memoryInGbs: Number(bdsInstanceNodesShapeConfigMemoryInGbs), * nvmes: Number(bdsInstanceNodesShapeConfigNvmes), * ocpus: Number(bdsInstanceNodesShapeConfigOcpus), * }, * }, * kafkaBrokerNode: { * shape: bdsInstanceNodesShape, * subnetId: testSubnet.id, * numberOfNodes: bdsInstanceNumberOfNodes, * blockVolumeSizeInGbs: bdsInstanceNodesBlockVolumeSizeInGbs, * shapeConfig: { * memoryInGbs: Number(bdsInstanceNodesShapeConfigMemoryInGbs), * nvmes: Number(bdsInstanceNodesShapeConfigNvmes), * ocpus: Number(bdsInstanceNodesShapeConfigOcpus), * }, * }, * bdsClusterVersionSummary: { * bdsVersion: bdsInstanceBdsClusterVersionSummaryBdsVersion, * odhVersion: bdsInstanceBdsClusterVersionSummaryOdhVersion, * }, * bootstrapScriptUrl: bdsInstanceBootstrapScriptUrl, * clusterAdminPassword: bdsInstanceClusterAdminPassword, * clusterProfile: bdsInstanceClusterProfile, * definedTags: bdsInstanceDefinedTags, * freeformTags: bdsInstanceFreeformTags, * isSecretReused: bdsInstanceIsSecretReused === "true", * kerberosRealmName: bdsInstanceKerberosRealmName, * kmsKeyId: bdsInstanceKmsKeyId, * ignoreExistingNodesShapes: ignoreExistingNodesShape, * networkConfig: { * cidrBlock: bdsInstanceNetworkConfigCidrBlock, * isNatGatewayRequired: bdsInstanceNetworkConfigIsNatGatewayRequired === "true", * }, * secretId: testSecret.id, * }); * ``` * * ## Import * * BdsInstances can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:BigDataService/bdsInstance:BdsInstance test_bds_instance "id" * ``` */ export declare class BdsInstance extends pulumi.CustomResource { /** * Get an existing BdsInstance 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?: BdsInstanceState, opts?: pulumi.CustomResourceOptions): BdsInstance; /** * Returns true if the given object is an instance of BdsInstance. 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 BdsInstance; /** * Cluster version details including bds and odh version information. */ readonly bdsClusterVersionSummary: pulumi.Output; /** * (Updatable) Pre-authenticated URL of the script in Object Store that is downloaded and executed. */ readonly bootstrapScriptUrl: pulumi.Output; /** * The information about added Cloud SQL capability */ readonly cloudSqlDetails: pulumi.Output; /** * (Updatable) Base-64 encoded password for the cluster (and Cloudera Manager) admin user. Not required if the secretId is specified. */ readonly clusterAdminPassword: pulumi.Output; /** * Specific info about a Hadoop cluster */ readonly clusterDetails: pulumi.Output; /** * Profile of the Big Data Service cluster. */ readonly clusterProfile: pulumi.Output; /** * The SSH public key used to authenticate the cluster connection. */ readonly clusterPublicKey: pulumi.Output; /** * Version of the Hadoop distribution */ readonly clusterVersion: pulumi.Output; /** * (Updatable) The OCID of the compartment */ readonly compartmentId: pulumi.Output; readonly computeOnlyWorkerNode: pulumi.Output; /** * The user who created the cluster. */ readonly createdBy: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Name of the BDS instance */ readonly displayName: pulumi.Output; readonly edgeNode: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * Tag to ignore changing the shape of existing worker, master, utility, compute_only_worker, edge, kafkaBroker nodes, in a list format, when new nodes are added with a different shape. */ readonly ignoreExistingNodesShapes: pulumi.Output; /** * (Updatable) Boolean flag specifying whether we configure Cloud SQL or not */ readonly isCloudSqlConfigured: pulumi.Output; readonly isForceRemoveEnabled: pulumi.Output; /** * (Updatable) When setting state as `INACTIVE` for stopping a cluster, setting this flag to true forcefully stops the bds instance. */ readonly isForceStopJobs: pulumi.Output; /** * Boolean flag specifying whether or not the cluster is HA */ readonly isHighAvailability: pulumi.Output; /** * Boolean flag specifying whether or not Kafka should be configured. */ readonly isKafkaConfigured: pulumi.Output; /** * Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. */ readonly isSecretReused: pulumi.Output; /** * Boolean flag specifying whether or not the cluster should be setup as secure. */ readonly isSecure: pulumi.Output; /** * The kafka broker node in the BDS instance */ readonly kafkaBrokerNode: pulumi.Output; /** * The user-defined kerberos realm name. */ readonly kerberosRealmName: pulumi.Output; /** * (Updatable) The OCID of the Key Management master encryption key. */ readonly kmsKeyId: pulumi.Output; /** * The master node in the BDS instance */ readonly masterNode: pulumi.Output; /** * (Updatable) Additional configuration of the user's network. */ readonly networkConfig: pulumi.Output; /** * The list of nodes in the Big Data Service cluster. */ readonly nodes: pulumi.Output; /** * Number of nodes that forming the cluster */ readonly numberOfNodes: pulumi.Output; /** * Number of nodes that require a maintenance reboot */ readonly numberOfNodesRequiringMaintenanceReboot: pulumi.Output; /** * (Updatable) The version of the patch to be upated. */ readonly osPatchVersion: pulumi.Output; /** * (Updatable) An optional property when used triggers Remove Node from an Active Cluster. Takes the node ocid as input */ readonly removeNode: pulumi.Output; readonly removeNodes: pulumi.Output; /** * The secretId for the clusterAdminPassword. */ readonly secretId: pulumi.Output; readonly startClusterShapeConfigs: pulumi.Output; /** * (Updatable) The target state for the Bds Instance. Could be set to `ACTIVE` or `INACTIVE` to start/stop the bds instance. */ readonly state: pulumi.Output; /** * The time the BDS instance was created. An RFC3339 formatted datetime string */ readonly timeCreated: pulumi.Output; /** * The earliest time of certificate expiration date across the certificates of all current nodes under this cluster. */ readonly timeEarliestCertificateExpiration: pulumi.Output; /** * The time the BDS instance was updated. An RFC3339 formatted datetime string */ readonly timeUpdated: pulumi.Output; /** * The utility node in the BDS instance */ readonly utilNode: pulumi.Output; readonly workerNode: pulumi.Output; /** * Create a BdsInstance 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: BdsInstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering BdsInstance resources. */ export interface BdsInstanceState { /** * Cluster version details including bds and odh version information. */ bdsClusterVersionSummary?: pulumi.Input; /** * (Updatable) Pre-authenticated URL of the script in Object Store that is downloaded and executed. */ bootstrapScriptUrl?: pulumi.Input; /** * The information about added Cloud SQL capability */ cloudSqlDetails?: pulumi.Input[] | undefined>; /** * (Updatable) Base-64 encoded password for the cluster (and Cloudera Manager) admin user. Not required if the secretId is specified. */ clusterAdminPassword?: pulumi.Input; /** * Specific info about a Hadoop cluster */ clusterDetails?: pulumi.Input[] | undefined>; /** * Profile of the Big Data Service cluster. */ clusterProfile?: pulumi.Input; /** * The SSH public key used to authenticate the cluster connection. */ clusterPublicKey?: pulumi.Input; /** * Version of the Hadoop distribution */ clusterVersion?: pulumi.Input; /** * (Updatable) The OCID of the compartment */ compartmentId?: pulumi.Input; computeOnlyWorkerNode?: pulumi.Input; /** * The user who created the cluster. */ createdBy?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Name of the BDS instance */ displayName?: pulumi.Input; edgeNode?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Tag to ignore changing the shape of existing worker, master, utility, compute_only_worker, edge, kafkaBroker nodes, in a list format, when new nodes are added with a different shape. */ ignoreExistingNodesShapes?: pulumi.Input[] | undefined>; /** * (Updatable) Boolean flag specifying whether we configure Cloud SQL or not */ isCloudSqlConfigured?: pulumi.Input; isForceRemoveEnabled?: pulumi.Input; /** * (Updatable) When setting state as `INACTIVE` for stopping a cluster, setting this flag to true forcefully stops the bds instance. */ isForceStopJobs?: pulumi.Input; /** * Boolean flag specifying whether or not the cluster is HA */ isHighAvailability?: pulumi.Input; /** * Boolean flag specifying whether or not Kafka should be configured. */ isKafkaConfigured?: pulumi.Input; /** * Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. */ isSecretReused?: pulumi.Input; /** * Boolean flag specifying whether or not the cluster should be setup as secure. */ isSecure?: pulumi.Input; /** * The kafka broker node in the BDS instance */ kafkaBrokerNode?: pulumi.Input; /** * The user-defined kerberos realm name. */ kerberosRealmName?: pulumi.Input; /** * (Updatable) The OCID of the Key Management master encryption key. */ kmsKeyId?: pulumi.Input; /** * The master node in the BDS instance */ masterNode?: pulumi.Input; /** * (Updatable) Additional configuration of the user's network. */ networkConfig?: pulumi.Input; /** * The list of nodes in the Big Data Service cluster. */ nodes?: pulumi.Input[] | undefined>; /** * Number of nodes that forming the cluster */ numberOfNodes?: pulumi.Input; /** * Number of nodes that require a maintenance reboot */ numberOfNodesRequiringMaintenanceReboot?: pulumi.Input; /** * (Updatable) The version of the patch to be upated. */ osPatchVersion?: pulumi.Input; /** * (Updatable) An optional property when used triggers Remove Node from an Active Cluster. Takes the node ocid as input */ removeNode?: pulumi.Input; removeNodes?: pulumi.Input[] | undefined>; /** * The secretId for the clusterAdminPassword. */ secretId?: pulumi.Input; startClusterShapeConfigs?: pulumi.Input[] | undefined>; /** * (Updatable) The target state for the Bds Instance. Could be set to `ACTIVE` or `INACTIVE` to start/stop the bds instance. */ state?: pulumi.Input; /** * The time the BDS instance was created. An RFC3339 formatted datetime string */ timeCreated?: pulumi.Input; /** * The earliest time of certificate expiration date across the certificates of all current nodes under this cluster. */ timeEarliestCertificateExpiration?: pulumi.Input; /** * The time the BDS instance was updated. An RFC3339 formatted datetime string */ timeUpdated?: pulumi.Input; /** * The utility node in the BDS instance */ utilNode?: pulumi.Input; workerNode?: pulumi.Input; } /** * The set of arguments for constructing a BdsInstance resource. */ export interface BdsInstanceArgs { /** * Cluster version details including bds and odh version information. */ bdsClusterVersionSummary?: pulumi.Input; /** * (Updatable) Pre-authenticated URL of the script in Object Store that is downloaded and executed. */ bootstrapScriptUrl?: pulumi.Input; /** * The information about added Cloud SQL capability */ cloudSqlDetails?: pulumi.Input[] | undefined>; /** * (Updatable) Base-64 encoded password for the cluster (and Cloudera Manager) admin user. Not required if the secretId is specified. */ clusterAdminPassword?: pulumi.Input; /** * Profile of the Big Data Service cluster. */ clusterProfile?: pulumi.Input; /** * The SSH public key used to authenticate the cluster connection. */ clusterPublicKey: pulumi.Input; /** * Version of the Hadoop distribution */ clusterVersion: pulumi.Input; /** * (Updatable) The OCID of the compartment */ compartmentId: pulumi.Input; computeOnlyWorkerNode?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Name of the BDS instance */ displayName: pulumi.Input; edgeNode?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Tag to ignore changing the shape of existing worker, master, utility, compute_only_worker, edge, kafkaBroker nodes, in a list format, when new nodes are added with a different shape. */ ignoreExistingNodesShapes?: pulumi.Input[] | undefined>; /** * (Updatable) Boolean flag specifying whether we configure Cloud SQL or not */ isCloudSqlConfigured?: pulumi.Input; isForceRemoveEnabled?: pulumi.Input; /** * (Updatable) When setting state as `INACTIVE` for stopping a cluster, setting this flag to true forcefully stops the bds instance. */ isForceStopJobs?: pulumi.Input; /** * Boolean flag specifying whether or not the cluster is HA */ isHighAvailability: pulumi.Input; /** * Boolean flag specifying whether or not Kafka should be configured. */ isKafkaConfigured?: pulumi.Input; /** * Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. */ isSecretReused?: pulumi.Input; /** * Boolean flag specifying whether or not the cluster should be setup as secure. */ isSecure: pulumi.Input; /** * The kafka broker node in the BDS instance */ kafkaBrokerNode?: pulumi.Input; /** * The user-defined kerberos realm name. */ kerberosRealmName?: pulumi.Input; /** * (Updatable) The OCID of the Key Management master encryption key. */ kmsKeyId?: pulumi.Input; /** * The master node in the BDS instance */ masterNode: pulumi.Input; /** * (Updatable) Additional configuration of the user's network. */ networkConfig?: pulumi.Input; /** * (Updatable) The version of the patch to be upated. */ osPatchVersion?: pulumi.Input; /** * (Updatable) An optional property when used triggers Remove Node from an Active Cluster. Takes the node ocid as input */ removeNode?: pulumi.Input; removeNodes?: pulumi.Input[] | undefined>; /** * The secretId for the clusterAdminPassword. */ secretId?: pulumi.Input; startClusterShapeConfigs?: pulumi.Input[] | undefined>; /** * (Updatable) The target state for the Bds Instance. Could be set to `ACTIVE` or `INACTIVE` to start/stop the bds instance. */ state?: pulumi.Input; /** * The utility node in the BDS instance */ utilNode: pulumi.Input; workerNode: pulumi.Input; } //# sourceMappingURL=bdsInstance.d.ts.map