Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KmsVaultClient

Hierarchy

  • KmsVaultClient

Constructors

constructor

Properties

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

_waiters: KmsVaultWaiter

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://kms.{region}.{secondLevelDomain}"

Accessors

endpoint

  • set endpoint(endpoint: string): void

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

Methods

backupVault

  • Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later. You can backup a vault whether or not it contains keys. This operation only backs up the metadata of the vault, and does not include key metadata.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<BackupVaultResponse>

    BackupVaultResponse

cancelVaultDeletion

  • Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to their respective states from before their scheduled deletion. All keys that were scheduled for deletion prior to vault deletion retain their lifecycle state and time of deletion.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<CancelVaultDeletionResponse>

    CancelVaultDeletionResponse

changeVaultCompartment

  • Moves a vault into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

    When provided, if-match is checked against the ETag values of the resource.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ChangeVaultCompartmentResponse>

    ChangeVaultCompartmentResponse

createVault

  • Creates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and either a dedicated hardware security module (HSM) or a multitenant HSM.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<CreateVaultResponse>

    CreateVaultResponse

createWaiters

  • Creates a new KmsVaultWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns KmsVaultWaiter

    The service waiters.

getVault

  • Gets the specified vault's configuration information.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<GetVaultResponse>

    GetVaultResponse

getVaultUsage

getWaiters

listAllVaults

  • Creates a new async iterator which will iterate over the models.VaultSummary objects contained in responses from the listVaults operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VaultSummary>

listAllVaultsResponses

listVaults

  • Lists the vaults in the specified compartment.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ListVaultsResponse>

    ListVaultsResponse

restoreVaultFromFile

restoreVaultFromObjectStore

scheduleVaultDeletion

  • Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it that are not already scheduled for deletion to PENDING_DELETION and then deletes them after the retention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't change. If any keys in the vault are scheduled to be deleted after the specified time of deletion for the vault, the call is rejected with the error code 409.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ScheduleVaultDeletionResponse>

    ScheduleVaultDeletionResponse

updateVault

  • Updates the properties of a vault. Specifically, you can update the displayName, freeformTags, and definedTags properties. Furthermore, the vault must be in an ACTIVE or CREATING state to be updated.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<UpdateVaultResponse>

    UpdateVaultResponse