import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Bds Instance Api Key resource in Oracle Cloud Infrastructure Big Data Service service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/bigdata/latest/BdsInstanceApiKey * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/big_data_service * * Create an API key on behalf of the specified user. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBdsInstanceApiKey = new oci.bigdataservice.BdsInstanceApiKey("test_bds_instance_api_key", { * bdsInstanceId: testBdsInstance.id, * keyAlias: bdsInstanceApiKeyKeyAlias, * passphrase: bdsInstanceApiKeyPassphrase, * userId: testUser.id, * defaultRegion: bdsInstanceApiKeyDefaultRegion, * domainOcid: bdsInstanceApiKeyDomainOcid, * }); * ``` * * ## Import * * BdsInstanceApiKeys can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:BigDataService/bdsInstanceApiKey:BdsInstanceApiKey test_bds_instance_api_key "bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}" * ``` */ export declare class BdsInstanceApiKey extends pulumi.CustomResource { /** * Get an existing BdsInstanceApiKey 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?: BdsInstanceApiKeyState, opts?: pulumi.CustomResourceOptions): BdsInstanceApiKey; /** * Returns true if the given object is an instance of BdsInstanceApiKey. 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 BdsInstanceApiKey; /** * The OCID of the cluster. */ readonly bdsInstanceId: pulumi.Output; /** * The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information. */ readonly defaultRegion: pulumi.Output; /** * Identity domain OCID , where user is present. For default domain , this field will be optional. */ readonly domainOcid: pulumi.Output; /** * The fingerprint that corresponds to the public API key requested. */ readonly fingerprint: pulumi.Output; /** * User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed. */ readonly keyAlias: pulumi.Output; /** * Base64 passphrase used to secure the private key which will be created on user behalf. */ readonly passphrase: pulumi.Output; /** * The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system. */ readonly pemfilepath: pulumi.Output; /** * The current status of the API key. */ readonly state: pulumi.Output; /** * The OCID of your tenancy. */ readonly tenantId: pulumi.Output; /** * The time the API key was created, shown as an RFC 3339 formatted datetime string. */ readonly timeCreated: pulumi.Output; /** * The OCID of the user for whom this new generated API key pair will be created. * * ** 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 userId: pulumi.Output; /** * Create a BdsInstanceApiKey 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: BdsInstanceApiKeyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering BdsInstanceApiKey resources. */ export interface BdsInstanceApiKeyState { /** * The OCID of the cluster. */ bdsInstanceId?: pulumi.Input; /** * The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information. */ defaultRegion?: pulumi.Input; /** * Identity domain OCID , where user is present. For default domain , this field will be optional. */ domainOcid?: pulumi.Input; /** * The fingerprint that corresponds to the public API key requested. */ fingerprint?: pulumi.Input; /** * User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed. */ keyAlias?: pulumi.Input; /** * Base64 passphrase used to secure the private key which will be created on user behalf. */ passphrase?: pulumi.Input; /** * The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system. */ pemfilepath?: pulumi.Input; /** * The current status of the API key. */ state?: pulumi.Input; /** * The OCID of your tenancy. */ tenantId?: pulumi.Input; /** * The time the API key was created, shown as an RFC 3339 formatted datetime string. */ timeCreated?: pulumi.Input; /** * The OCID of the user for whom this new generated API key pair will be created. * * ** 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 */ userId?: pulumi.Input; } /** * The set of arguments for constructing a BdsInstanceApiKey resource. */ export interface BdsInstanceApiKeyArgs { /** * The OCID of the cluster. */ bdsInstanceId: pulumi.Input; /** * The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information. */ defaultRegion?: pulumi.Input; /** * Identity domain OCID , where user is present. For default domain , this field will be optional. */ domainOcid?: pulumi.Input; /** * User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed. */ keyAlias: pulumi.Input; /** * Base64 passphrase used to secure the private key which will be created on user behalf. */ passphrase: pulumi.Input; /** * The OCID of the user for whom this new generated API key pair will be created. * * ** 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 */ userId: pulumi.Input; } //# sourceMappingURL=bdsInstanceApiKey.d.ts.map