1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. BigDataService
  5. BdsInstanceApiKey
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.BigDataService.BdsInstanceApiKey

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This resource provides the Bds Instance Api Key resource in Oracle Cloud Infrastructure Big Data Service service.

    Create an API key on behalf of the specified user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBdsInstanceApiKey = new oci.bigdataservice.BdsInstanceApiKey("testBdsInstanceApiKey", {
        bdsInstanceId: oci_bds_bds_instance.test_bds_instance.id,
        keyAlias: _var.bds_instance_api_key_key_alias,
        passphrase: _var.bds_instance_api_key_passphrase,
        userId: oci_identity_user.test_user.id,
        defaultRegion: _var.bds_instance_api_key_default_region,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_bds_instance_api_key = oci.big_data_service.BdsInstanceApiKey("testBdsInstanceApiKey",
        bds_instance_id=oci_bds_bds_instance["test_bds_instance"]["id"],
        key_alias=var["bds_instance_api_key_key_alias"],
        passphrase=var["bds_instance_api_key_passphrase"],
        user_id=oci_identity_user["test_user"]["id"],
        default_region=var["bds_instance_api_key_default_region"])
    
    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.NewBdsInstanceApiKey(ctx, "testBdsInstanceApiKey", &BigDataService.BdsInstanceApiKeyArgs{
    			BdsInstanceId: pulumi.Any(oci_bds_bds_instance.Test_bds_instance.Id),
    			KeyAlias:      pulumi.Any(_var.Bds_instance_api_key_key_alias),
    			Passphrase:    pulumi.Any(_var.Bds_instance_api_key_passphrase),
    			UserId:        pulumi.Any(oci_identity_user.Test_user.Id),
    			DefaultRegion: pulumi.Any(_var.Bds_instance_api_key_default_region),
    		})
    		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 = new Oci.BigDataService.BdsInstanceApiKey("testBdsInstanceApiKey", new()
        {
            BdsInstanceId = oci_bds_bds_instance.Test_bds_instance.Id,
            KeyAlias = @var.Bds_instance_api_key_key_alias,
            Passphrase = @var.Bds_instance_api_key_passphrase,
            UserId = oci_identity_user.Test_user.Id,
            DefaultRegion = @var.Bds_instance_api_key_default_region,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.BigDataService.BdsInstanceApiKey;
    import com.pulumi.oci.BigDataService.BdsInstanceApiKeyArgs;
    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) {
            var testBdsInstanceApiKey = new BdsInstanceApiKey("testBdsInstanceApiKey", BdsInstanceApiKeyArgs.builder()        
                .bdsInstanceId(oci_bds_bds_instance.test_bds_instance().id())
                .keyAlias(var_.bds_instance_api_key_key_alias())
                .passphrase(var_.bds_instance_api_key_passphrase())
                .userId(oci_identity_user.test_user().id())
                .defaultRegion(var_.bds_instance_api_key_default_region())
                .build());
    
        }
    }
    
    resources:
      testBdsInstanceApiKey:
        type: oci:BigDataService:BdsInstanceApiKey
        properties:
          #Required
          bdsInstanceId: ${oci_bds_bds_instance.test_bds_instance.id}
          keyAlias: ${var.bds_instance_api_key_key_alias}
          passphrase: ${var.bds_instance_api_key_passphrase}
          userId: ${oci_identity_user.test_user.id}
          #Optional
          defaultRegion: ${var.bds_instance_api_key_default_region}
    

    Create BdsInstanceApiKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BdsInstanceApiKey(name: string, args: BdsInstanceApiKeyArgs, opts?: CustomResourceOptions);
    @overload
    def BdsInstanceApiKey(resource_name: str,
                          args: BdsInstanceApiKeyArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def BdsInstanceApiKey(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          bds_instance_id: Optional[str] = None,
                          key_alias: Optional[str] = None,
                          passphrase: Optional[str] = None,
                          user_id: Optional[str] = None,
                          default_region: Optional[str] = None)
    func NewBdsInstanceApiKey(ctx *Context, name string, args BdsInstanceApiKeyArgs, opts ...ResourceOption) (*BdsInstanceApiKey, error)
    public BdsInstanceApiKey(string name, BdsInstanceApiKeyArgs args, CustomResourceOptions? opts = null)
    public BdsInstanceApiKey(String name, BdsInstanceApiKeyArgs args)
    public BdsInstanceApiKey(String name, BdsInstanceApiKeyArgs args, CustomResourceOptions options)
    
    type: oci:BigDataService:BdsInstanceApiKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BdsInstanceApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BdsInstanceApiKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BdsInstanceApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BdsInstanceApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BdsInstanceApiKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var bdsInstanceApiKeyResource = new Oci.BigDataService.BdsInstanceApiKey("bdsInstanceApiKeyResource", new()
    {
        BdsInstanceId = "string",
        KeyAlias = "string",
        Passphrase = "string",
        UserId = "string",
        DefaultRegion = "string",
    });
    
    example, err := BigDataService.NewBdsInstanceApiKey(ctx, "bdsInstanceApiKeyResource", &BigDataService.BdsInstanceApiKeyArgs{
    	BdsInstanceId: pulumi.String("string"),
    	KeyAlias:      pulumi.String("string"),
    	Passphrase:    pulumi.String("string"),
    	UserId:        pulumi.String("string"),
    	DefaultRegion: pulumi.String("string"),
    })
    
    var bdsInstanceApiKeyResource = new BdsInstanceApiKey("bdsInstanceApiKeyResource", BdsInstanceApiKeyArgs.builder()        
        .bdsInstanceId("string")
        .keyAlias("string")
        .passphrase("string")
        .userId("string")
        .defaultRegion("string")
        .build());
    
    bds_instance_api_key_resource = oci.big_data_service.BdsInstanceApiKey("bdsInstanceApiKeyResource",
        bds_instance_id="string",
        key_alias="string",
        passphrase="string",
        user_id="string",
        default_region="string")
    
    const bdsInstanceApiKeyResource = new oci.bigdataservice.BdsInstanceApiKey("bdsInstanceApiKeyResource", {
        bdsInstanceId: "string",
        keyAlias: "string",
        passphrase: "string",
        userId: "string",
        defaultRegion: "string",
    });
    
    type: oci:BigDataService:BdsInstanceApiKey
    properties:
        bdsInstanceId: string
        defaultRegion: string
        keyAlias: string
        passphrase: string
        userId: string
    

    BdsInstanceApiKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BdsInstanceApiKey resource accepts the following input properties:

    BdsInstanceId string
    The OCID of the cluster.
    KeyAlias string
    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.
    Passphrase string
    Base64 passphrase used to secure the private key which will be created on user behalf.
    UserId string

    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

    DefaultRegion string
    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.
    BdsInstanceId string
    The OCID of the cluster.
    KeyAlias string
    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.
    Passphrase string
    Base64 passphrase used to secure the private key which will be created on user behalf.
    UserId string

    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

    DefaultRegion string
    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.
    bdsInstanceId String
    The OCID of the cluster.
    keyAlias String
    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.
    passphrase String
    Base64 passphrase used to secure the private key which will be created on user behalf.
    userId String

    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

    defaultRegion String
    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.
    bdsInstanceId string
    The OCID of the cluster.
    keyAlias string
    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.
    passphrase string
    Base64 passphrase used to secure the private key which will be created on user behalf.
    userId string

    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

    defaultRegion string
    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.
    bds_instance_id str
    The OCID of the cluster.
    key_alias str
    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.
    passphrase str
    Base64 passphrase used to secure the private key which will be created on user behalf.
    user_id str

    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

    default_region str
    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.
    bdsInstanceId String
    The OCID of the cluster.
    keyAlias String
    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.
    passphrase String
    Base64 passphrase used to secure the private key which will be created on user behalf.
    userId String

    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

    defaultRegion String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BdsInstanceApiKey resource produces the following output properties:

    Fingerprint string
    The fingerprint that corresponds to the public API key requested.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Fingerprint string
    The fingerprint that corresponds to the public API key requested.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    fingerprint String
    The fingerprint that corresponds to the public API key requested.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    fingerprint string
    The fingerprint that corresponds to the public API key requested.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    fingerprint str
    The fingerprint that corresponds to the public API key requested.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    fingerprint String
    The fingerprint that corresponds to the public API key requested.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing BdsInstanceApiKey Resource

    Get an existing BdsInstanceApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BdsInstanceApiKeyState, opts?: CustomResourceOptions): BdsInstanceApiKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bds_instance_id: Optional[str] = None,
            default_region: Optional[str] = None,
            fingerprint: Optional[str] = None,
            key_alias: Optional[str] = None,
            passphrase: Optional[str] = None,
            pemfilepath: Optional[str] = None,
            state: Optional[str] = None,
            tenant_id: Optional[str] = None,
            time_created: Optional[str] = None,
            user_id: Optional[str] = None) -> BdsInstanceApiKey
    func GetBdsInstanceApiKey(ctx *Context, name string, id IDInput, state *BdsInstanceApiKeyState, opts ...ResourceOption) (*BdsInstanceApiKey, error)
    public static BdsInstanceApiKey Get(string name, Input<string> id, BdsInstanceApiKeyState? state, CustomResourceOptions? opts = null)
    public static BdsInstanceApiKey get(String name, Output<String> id, BdsInstanceApiKeyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BdsInstanceId string
    The OCID of the cluster.
    DefaultRegion string
    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.
    Fingerprint string
    The fingerprint that corresponds to the public API key requested.
    KeyAlias string
    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.
    Passphrase string
    Base64 passphrase used to secure the private key which will be created on user behalf.
    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 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

    BdsInstanceId string
    The OCID of the cluster.
    DefaultRegion string
    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.
    Fingerprint string
    The fingerprint that corresponds to the public API key requested.
    KeyAlias string
    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.
    Passphrase string
    Base64 passphrase used to secure the private key which will be created on user behalf.
    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 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

    bdsInstanceId String
    The OCID of the cluster.
    defaultRegion String
    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.
    fingerprint String
    The fingerprint that corresponds to the public API key requested.
    keyAlias String
    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.
    passphrase String
    Base64 passphrase used to secure the private key which will be created on user behalf.
    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 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

    bdsInstanceId string
    The OCID of the cluster.
    defaultRegion string
    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.
    fingerprint string
    The fingerprint that corresponds to the public API key requested.
    keyAlias string
    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.
    passphrase string
    Base64 passphrase used to secure the private key which will be created on user behalf.
    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 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

    bds_instance_id str
    The OCID of the cluster.
    default_region str
    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.
    fingerprint str
    The fingerprint that corresponds to the public API key requested.
    key_alias str
    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.
    passphrase str
    Base64 passphrase used to secure the private key which will be created on user behalf.
    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 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

    bdsInstanceId String
    The OCID of the cluster.
    defaultRegion String
    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.
    fingerprint String
    The fingerprint that corresponds to the public API key requested.
    keyAlias String
    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.
    passphrase String
    Base64 passphrase used to secure the private key which will be created on user behalf.
    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 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

    Import

    BdsInstanceApiKeys can be imported using the id, e.g.

    $ pulumi import oci:BigDataService/bdsInstanceApiKey:BdsInstanceApiKey test_bds_instance_api_key "bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi