oci.BigDataService.getBdsInstanceApiKey

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testBdsInstanceApiKey = oci.BigDataService.getBdsInstanceApiKey({
    apiKeyId: testApiKey.id,
    bdsInstanceId: testBdsInstance.id,
});

import pulumi
import pulumi_oci as oci

test_bds_instance_api_key = oci.BigDataService.get_bds_instance_api_key(api_key_id=test_api_key["id"],
    bds_instance_id=test_bds_instance["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/bigdataservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigdataservice.GetBdsInstanceApiKey(ctx, &bigdataservice.GetBdsInstanceApiKeyArgs{
			ApiKeyId:      testApiKey.Id,
			BdsInstanceId: testBdsInstance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testBdsInstanceApiKey = Oci.BigDataService.GetBdsInstanceApiKey.Invoke(new()
    {
        ApiKeyId = testApiKey.Id,
        BdsInstanceId = testBdsInstance.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.BigDataService.BigDataServiceFunctions;
import com.pulumi.oci.BigDataService.inputs.GetBdsInstanceApiKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testBdsInstanceApiKey = BigDataServiceFunctions.getBdsInstanceApiKey(GetBdsInstanceApiKeyArgs.builder()
            .apiKeyId(testApiKey.id())
            .bdsInstanceId(testBdsInstance.id())
            .build());

    }
}

variables:
  testBdsInstanceApiKey:
    fn::invoke:
      function: oci:BigDataService:getBdsInstanceApiKey
      arguments:
        apiKeyId: ${testApiKey.id}
        bdsInstanceId: ${testBdsInstance.id}

Using getBdsInstanceApiKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBdsInstanceApiKey(args: GetBdsInstanceApiKeyArgs, opts?: InvokeOptions): Promise<GetBdsInstanceApiKeyResult>
function getBdsInstanceApiKeyOutput(args: GetBdsInstanceApiKeyOutputArgs, opts?: InvokeOptions): Output<GetBdsInstanceApiKeyResult>

def get_bds_instance_api_key(api_key_id: Optional[str] = None,
                             bds_instance_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetBdsInstanceApiKeyResult
def get_bds_instance_api_key_output(api_key_id: Optional[pulumi.Input[str]] = None,
                             bds_instance_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetBdsInstanceApiKeyResult]

func LookupBdsInstanceApiKey(ctx *Context, args *LookupBdsInstanceApiKeyArgs, opts ...InvokeOption) (*LookupBdsInstanceApiKeyResult, error)
func LookupBdsInstanceApiKeyOutput(ctx *Context, args *LookupBdsInstanceApiKeyOutputArgs, opts ...InvokeOption) LookupBdsInstanceApiKeyResultOutput

> Note: This function is named LookupBdsInstanceApiKey in the Go SDK.

public static class GetBdsInstanceApiKey 
{
    public static Task<GetBdsInstanceApiKeyResult> InvokeAsync(GetBdsInstanceApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetBdsInstanceApiKeyResult> Invoke(GetBdsInstanceApiKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBdsInstanceApiKeyResult> getBdsInstanceApiKey(GetBdsInstanceApiKeyArgs args, InvokeOptions options)
public static Output<GetBdsInstanceApiKeyResult> getBdsInstanceApiKey(GetBdsInstanceApiKeyArgs args, InvokeOptions options)

fn::invoke:
  function: oci:BigDataService/getBdsInstanceApiKey:getBdsInstanceApiKey
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiKeyId string: The API key identifier.
BdsInstanceId string: The OCID of the cluster.

ApiKeyId string: The API key identifier.
BdsInstanceId string: The OCID of the cluster.

apiKeyId String: The API key identifier.
bdsInstanceId String: The OCID of the cluster.

apiKeyId string: The API key identifier.
bdsInstanceId string: The OCID of the cluster.

api_key_id str: The API key identifier.
bds_instance_id str: The OCID of the cluster.

apiKeyId String: The API key identifier.
bdsInstanceId String: The OCID of the cluster.

getBdsInstanceApiKey Result

The following output properties are available:

ApiKeyId string
BdsInstanceId string
DefaultRegion string: The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
DomainOcid string: Identity domain OCID ,where user is present. For default domain ,this field will be optional.
Fingerprint string: The fingerprint that corresponds to the public API key requested.
Id string: Identifier of the user's API key.
KeyAlias string: User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
Passphrase string
Pemfilepath string: 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.
State string: The current status of the API key.
TenantId string: The OCID of your tenancy.
TimeCreated string: The time the API key was created, shown as an RFC 3339 formatted datetime string.
UserId string: The user OCID for which this API key was created.

ApiKeyId string
BdsInstanceId string
DefaultRegion string: The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
DomainOcid string: Identity domain OCID ,where user is present. For default domain ,this field will be optional.
Fingerprint string: The fingerprint that corresponds to the public API key requested.
Id string: Identifier of the user's API key.
KeyAlias string: User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
Passphrase string
Pemfilepath string: 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.
State string: The current status of the API key.
TenantId string: The OCID of your tenancy.
TimeCreated string: The time the API key was created, shown as an RFC 3339 formatted datetime string.
UserId string: The user OCID for which this API key was created.

apiKeyId String
bdsInstanceId String
defaultRegion String: The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
domainOcid String: Identity domain OCID ,where user is present. For default domain ,this field will be optional.
fingerprint String: The fingerprint that corresponds to the public API key requested.
id String: Identifier of the user's API key.
keyAlias String: User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
passphrase String
pemfilepath String: 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.
state String: The current status of the API key.
tenantId String: The OCID of your tenancy.
timeCreated String: The time the API key was created, shown as an RFC 3339 formatted datetime string.
userId String: The user OCID for which this API key was created.

apiKeyId string
bdsInstanceId string
defaultRegion string: The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
domainOcid string: Identity domain OCID ,where user is present. For default domain ,this field will be optional.
fingerprint string: The fingerprint that corresponds to the public API key requested.
id string: Identifier of the user's API key.
keyAlias string: User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
passphrase string
pemfilepath string: 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.
state string: The current status of the API key.
tenantId string: The OCID of your tenancy.
timeCreated string: The time the API key was created, shown as an RFC 3339 formatted datetime string.
userId string: The user OCID for which this API key was created.

api_key_id str
bds_instance_id str
default_region str: The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
domain_ocid str: Identity domain OCID ,where user is present. For default domain ,this field will be optional.
fingerprint str: The fingerprint that corresponds to the public API key requested.
id str: Identifier of the user's API key.
key_alias str: User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
passphrase str
pemfilepath str: 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.
state str: The current status of the API key.
tenant_id str: The OCID of your tenancy.
time_created str: The time the API key was created, shown as an RFC 3339 formatted datetime string.
user_id str: The user OCID for which this API key was created.

apiKeyId String
bdsInstanceId String
defaultRegion String: The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .
domainOcid String: Identity domain OCID ,where user is present. For default domain ,this field will be optional.
fingerprint String: The fingerprint that corresponds to the public API key requested.
id String: Identifier of the user's API key.
keyAlias String: User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
passphrase String
pemfilepath String: 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.
state String: The current status of the API key.
tenantId String: The OCID of your tenancy.
timeCreated String: The time the API key was created, shown as an RFC 3339 formatted datetime string.
userId String: The user OCID for which this API key was created.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.BigDataService.getBdsInstanceApiKey

On this page

On this page

Example Usage

Using getBdsInstanceApiKey

getBdsInstanceApiKey Result

Package Details

On this page

On this page