Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getBdsInstanceApiKey

This data source provides details about a specific Bds Instance Api Key resource in Oracle Cloud Infrastructure Big Data Service service.

Returns the user’s API key information for the given ID.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testBdsInstanceApiKey = Oci.BigDataService.GetBdsInstanceApiKey.Invoke(new()
    {
        ApiKeyId = oci_identity_api_key.Test_api_key.Id,
        BdsInstanceId = oci_bds_bds_instance.Test_bds_instance.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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:      oci_identity_api_key.Test_api_key.Id,
			BdsInstanceId: oci_bds_bds_instance.Test_bds_instance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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(oci_identity_api_key.test_api_key().id())
            .bdsInstanceId(oci_bds_bds_instance.test_bds_instance().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_bds_instance_api_key = oci.BigDataService.get_bds_instance_api_key(api_key_id=oci_identity_api_key["test_api_key"]["id"],
    bds_instance_id=oci_bds_bds_instance["test_bds_instance"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testBdsInstanceApiKey = oci.BigDataService.getBdsInstanceApiKey({
    apiKeyId: oci_identity_api_key.test_api_key.id,
    bdsInstanceId: oci_bds_bds_instance.test_bds_instance.id,
});
variables:
  testBdsInstanceApiKey:
    Fn::Invoke:
      Function: oci:BigDataService:getBdsInstanceApiKey
      Arguments:
        apiKeyId: ${oci_identity_api_key.test_api_key.id}
        bdsInstanceId: ${oci_bds_bds_instance.test_bds_instance.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 GetBdsInstanceApiKey(ctx *Context, args *GetBdsInstanceApiKeyArgs, opts ...InvokeOption) (*GetBdsInstanceApiKeyResult, error)
func GetBdsInstanceApiKeyOutput(ctx *Context, args *GetBdsInstanceApiKeyOutputArgs, opts ...InvokeOption) GetBdsInstanceApiKeyResultOutput

> Note: This function is named GetBdsInstanceApiKey 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)
// Output-based functions aren't available in Java yet
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 .

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 .

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 .

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 .

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 .

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 .

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.