Docs
Packagesoci.BigDataService.BdsInstanceApiKey
Explore with Pulumi AI
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
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 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
})
}
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());
}
}
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"])
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,
});
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
new BdsInstanceApiKey(name: string, args: BdsInstanceApiKeyArgs, opts?: CustomResourceOptions);@overload
def BdsInstanceApiKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
bds_instance_id: Optional[str] = None,
default_region: Optional[str] = None,
key_alias: Optional[str] = None,
passphrase: Optional[str] = None,
user_id: Optional[str] = None)
@overload
def BdsInstanceApiKey(resource_name: str,
args: BdsInstanceApiKeyArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Bds
Instance stringId The OCID of the cluster.
- Key
Alias 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.
- User
Id 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
- Default
Region 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 stringId The OCID of the cluster.
- Key
Alias 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.
- User
Id 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
- Default
Region 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 StringId The OCID of the cluster.
- key
Alias 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.
- user
Id 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
- default
Region 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 stringId The OCID of the cluster.
- key
Alias 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.
- user
Id 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
- default
Region 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_ strid 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.
- bds
Instance StringId The OCID of the cluster.
- key
Alias 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.
- user
Id 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
- default
Region 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.
- Tenant
Id string The OCID of your tenancy.
- Time
Created 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.
- Tenant
Id string The OCID of your tenancy.
- Time
Created 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.
- tenant
Id String The OCID of your tenancy.
- time
Created 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.
- tenant
Id string The OCID of your tenancy.
- time
Created 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.
- tenant
Id String The OCID of your tenancy.
- time
Created 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) -> BdsInstanceApiKeyfunc 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.
- Bds
Instance stringId The OCID of the cluster.
- Default
Region 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.
- Key
Alias 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.
- Tenant
Id string The OCID of your tenancy.
- Time
Created string The time the API key was created, shown as an RFC 3339 formatted datetime string.
- User
Id 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 stringId The OCID of the cluster.
- Default
Region 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.
- Key
Alias 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.
- Tenant
Id string The OCID of your tenancy.
- Time
Created string The time the API key was created, shown as an RFC 3339 formatted datetime string.
- User
Id 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 StringId The OCID of the cluster.
- default
Region 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.
- key
Alias 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.
- tenant
Id String The OCID of your tenancy.
- time
Created String The time the API key was created, shown as an RFC 3339 formatted datetime string.
- user
Id 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 stringId The OCID of the cluster.
- default
Region 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.
- key
Alias 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.
- tenant
Id string The OCID of your tenancy.
- time
Created string The time the API key was created, shown as an RFC 3339 formatted datetime string.
- user
Id 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_ strid 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
- bds
Instance StringId The OCID of the cluster.
- default
Region 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.
- key
Alias 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.
- tenant
Id String The OCID of your tenancy.
- time
Created String The time the API key was created, shown as an RFC 3339 formatted datetime string.
- user
Id 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}"
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
ociTerraform Provider.