Oracle Cloud Infrastructure v2.28.0, Mar 27 25

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

oci.BigDataService.getBdsInstanceApiKeys

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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 getBdsInstanceApiKeys

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.

TypeScript
Python
Go
C#
Java
YAML

function getBdsInstanceApiKeys(args: GetBdsInstanceApiKeysArgs, opts?: InvokeOptions): Promise<GetBdsInstanceApiKeysResult>
function getBdsInstanceApiKeysOutput(args: GetBdsInstanceApiKeysOutputArgs, opts?: InvokeOptions): Output<GetBdsInstanceApiKeysResult>

def get_bds_instance_api_keys(bds_instance_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              filters: Optional[Sequence[_bigdataservice.GetBdsInstanceApiKeysFilter]] = None,
                              state: Optional[str] = None,
                              user_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBdsInstanceApiKeysResult
def get_bds_instance_api_keys_output(bds_instance_id: Optional[pulumi.Input[str]] = None,
                              display_name: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[_bigdataservice.GetBdsInstanceApiKeysFilterArgs]]]] = None,
                              state: Optional[pulumi.Input[str]] = None,
                              user_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBdsInstanceApiKeysResult]

func GetBdsInstanceApiKeys(ctx *Context, args *GetBdsInstanceApiKeysArgs, opts ...InvokeOption) (*GetBdsInstanceApiKeysResult, error)
func GetBdsInstanceApiKeysOutput(ctx *Context, args *GetBdsInstanceApiKeysOutputArgs, opts ...InvokeOption) GetBdsInstanceApiKeysResultOutput

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

public static class GetBdsInstanceApiKeys 
{
    public static Task<GetBdsInstanceApiKeysResult> InvokeAsync(GetBdsInstanceApiKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetBdsInstanceApiKeysResult> Invoke(GetBdsInstanceApiKeysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBdsInstanceApiKeysResult> getBdsInstanceApiKeys(GetBdsInstanceApiKeysArgs args, InvokeOptions options)
public static Output<GetBdsInstanceApiKeysResult> getBdsInstanceApiKeys(GetBdsInstanceApiKeysArgs args, InvokeOptions options)

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

The following arguments are supported:

BdsInstanceId string: The OCID of the cluster.
DisplayName string
Filters List<GetBdsInstanceApiKeysFilter>
State string: The current status of the API key.
UserId string: The user OCID for which this API key was created.

BdsInstanceId string: The OCID of the cluster.
DisplayName string
Filters []GetBdsInstanceApiKeysFilter
State string: The current status of the API key.
UserId string: The user OCID for which this API key was created.

bdsInstanceId String: The OCID of the cluster.
displayName String
filters List<GetBdsInstanceApiKeysFilter>
state String: The current status of the API key.
userId String: The user OCID for which this API key was created.

bdsInstanceId string: The OCID of the cluster.
displayName string
filters GetBdsInstanceApiKeysFilter[]
state string: The current status of the API key.
userId string: The user OCID for which this API key was created.

bds_instance_id str: The OCID of the cluster.
display_name str
filters Sequence[bigdataservice.GetBdsInstanceApiKeysFilter]
state str: The current status of the API key.
user_id str: The user OCID for which this API key was created.

bdsInstanceId String: The OCID of the cluster.
displayName String
filters List<Property Map>
state String: The current status of the API key.
userId String: The user OCID for which this API key was created.

getBdsInstanceApiKeys Result

The following output properties are available:

BdsApiKeys List<GetBdsInstanceApiKeysBdsApiKey>: The list of bds_api_keys.
BdsInstanceId string
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string
Filters List<GetBdsInstanceApiKeysFilter>
State string: The current status of the API key.
UserId string: The user OCID for which this API key was created.

BdsApiKeys []GetBdsInstanceApiKeysBdsApiKey: The list of bds_api_keys.
BdsInstanceId string
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string
Filters []GetBdsInstanceApiKeysFilter
State string: The current status of the API key.
UserId string: The user OCID for which this API key was created.

bdsApiKeys List<GetBdsInstanceApiKeysBdsApiKey>: The list of bds_api_keys.
bdsInstanceId String
id String: The provider-assigned unique ID for this managed resource.
displayName String
filters List<GetBdsInstanceApiKeysFilter>
state String: The current status of the API key.
userId String: The user OCID for which this API key was created.

bdsApiKeys GetBdsInstanceApiKeysBdsApiKey[]: The list of bds_api_keys.
bdsInstanceId string
id string: The provider-assigned unique ID for this managed resource.
displayName string
filters GetBdsInstanceApiKeysFilter[]
state string: The current status of the API key.
userId string: The user OCID for which this API key was created.

bds_api_keys Sequence[bigdataservice.GetBdsInstanceApiKeysBdsApiKey]: The list of bds_api_keys.
bds_instance_id str
id str: The provider-assigned unique ID for this managed resource.
display_name str
filters Sequence[bigdataservice.GetBdsInstanceApiKeysFilter]
state str: The current status of the API key.
user_id str: The user OCID for which this API key was created.

bdsApiKeys List<Property Map>: The list of bds_api_keys.
bdsInstanceId String
id String: The provider-assigned unique ID for this managed resource.
displayName String
filters List<Property Map>
state String: The current status of the API key.
userId String: The user OCID for which this API key was created.

Supporting Types

GetBdsInstanceApiKeysBdsApiKey

BdsInstanceId string: The OCID of the cluster.
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.

BdsInstanceId string: The OCID of the cluster.
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.

bdsInstanceId String: The OCID of the cluster.
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.

bdsInstanceId string: The OCID of the cluster.
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.

bds_instance_id str: The OCID of the cluster.
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.

bdsInstanceId String: The OCID of the cluster.
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.

GetBdsInstanceApiKeysFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

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.28.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-oci

oci.BigDataService.getBdsInstanceApiKeys

On this page

On this page

Example Usage

Using getBdsInstanceApiKeys

getBdsInstanceApiKeys Result

Supporting Types

GetBdsInstanceApiKeysBdsApiKey

GetBdsInstanceApiKeysFilter

Package Details

On this page

On this page