1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Kms
  5. VaultVerification
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Kms.VaultVerification

Explore with Pulumi AI

This source triggers action to create, update and delete replica for a vault in Oracle Cloud Infrastructure Kms service.

A vault replica is a mirror of that vault in a different region in the same realm. The vault replica and all the resources have same OCID with corresponding original ones.

This only supports virtual private vault for now. This supports only one replica in a region for a vault. Multiple replica will be supported in the future.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testReplication = new oci.kms.VaultVerification("test_replication", {
    vaultId: testVault.id,
    replicaRegion: replicaRegion,
});
Copy
import pulumi
import pulumi_oci as oci

test_replication = oci.kms.VaultVerification("test_replication",
    vault_id=test_vault["id"],
    replica_region=replica_region)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/kms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.NewVaultVerification(ctx, "test_replication", &kms.VaultVerificationArgs{
			VaultId:       pulumi.Any(testVault.Id),
			ReplicaRegion: pulumi.Any(replicaRegion),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testReplication = new Oci.Kms.VaultVerification("test_replication", new()
    {
        VaultId = testVault.Id,
        ReplicaRegion = replicaRegion,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Kms.VaultVerification;
import com.pulumi.oci.Kms.VaultVerificationArgs;
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 testReplication = new VaultVerification("testReplication", VaultVerificationArgs.builder()
            .vaultId(testVault.id())
            .replicaRegion(replicaRegion)
            .build());

    }
}
Copy
resources:
  testReplication:
    type: oci:Kms:VaultVerification
    name: test_replication
    properties:
      vaultId: ${testVault.id}
      replicaRegion: ${replicaRegion}
Copy

Create VaultVerification Resource

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

Constructor syntax

new VaultVerification(name: string, args: VaultVerificationArgs, opts?: CustomResourceOptions);
@overload
def VaultVerification(resource_name: str,
                      args: VaultVerificationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def VaultVerification(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      replica_region: Optional[str] = None,
                      vault_id: Optional[str] = None,
                      replica_vault_metadata: Optional[_kms.VaultVerificationReplicaVaultMetadataArgs] = None)
func NewVaultVerification(ctx *Context, name string, args VaultVerificationArgs, opts ...ResourceOption) (*VaultVerification, error)
public VaultVerification(string name, VaultVerificationArgs args, CustomResourceOptions? opts = null)
public VaultVerification(String name, VaultVerificationArgs args)
public VaultVerification(String name, VaultVerificationArgs args, CustomResourceOptions options)
type: oci:Kms:VaultVerification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var vaultVerificationResource = new Oci.Kms.VaultVerification("vaultVerificationResource", new()
{
    ReplicaRegion = "string",
    VaultId = "string",
    ReplicaVaultMetadata = new Oci.Kms.Inputs.VaultVerificationReplicaVaultMetadataArgs
    {
        IdcsAccountNameUrl = "string",
        PrivateEndpointId = "string",
        VaultType = "string",
    },
});
Copy
example, err := Kms.NewVaultVerification(ctx, "vaultVerificationResource", &Kms.VaultVerificationArgs{
	ReplicaRegion: pulumi.String("string"),
	VaultId:       pulumi.String("string"),
	ReplicaVaultMetadata: &kms.VaultVerificationReplicaVaultMetadataArgs{
		IdcsAccountNameUrl: pulumi.String("string"),
		PrivateEndpointId:  pulumi.String("string"),
		VaultType:          pulumi.String("string"),
	},
})
Copy
var vaultVerificationResource = new VaultVerification("vaultVerificationResource", VaultVerificationArgs.builder()
    .replicaRegion("string")
    .vaultId("string")
    .replicaVaultMetadata(VaultVerificationReplicaVaultMetadataArgs.builder()
        .idcsAccountNameUrl("string")
        .privateEndpointId("string")
        .vaultType("string")
        .build())
    .build());
Copy
vault_verification_resource = oci.kms.VaultVerification("vaultVerificationResource",
    replica_region="string",
    vault_id="string",
    replica_vault_metadata={
        "idcs_account_name_url": "string",
        "private_endpoint_id": "string",
        "vault_type": "string",
    })
Copy
const vaultVerificationResource = new oci.kms.VaultVerification("vaultVerificationResource", {
    replicaRegion: "string",
    vaultId: "string",
    replicaVaultMetadata: {
        idcsAccountNameUrl: "string",
        privateEndpointId: "string",
        vaultType: "string",
    },
});
Copy
type: oci:Kms:VaultVerification
properties:
    replicaRegion: string
    replicaVaultMetadata:
        idcsAccountNameUrl: string
        privateEndpointId: string
        vaultType: string
    vaultId: string
Copy

VaultVerification Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VaultVerification resource accepts the following input properties:

ReplicaRegion This property is required. string
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
VaultId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the primary vault to create replica from.
ReplicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadata
ReplicaRegion This property is required. string
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
VaultId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the primary vault to create replica from.
ReplicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadataArgs
replicaRegion This property is required. String
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
vaultId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the primary vault to create replica from.
replicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadata
replicaRegion This property is required. string
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
vaultId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the primary vault to create replica from.
replicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadata
replica_region This property is required. str
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
vault_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the primary vault to create replica from.
replica_vault_metadata Changes to this property will trigger replacement. kms.VaultVerificationReplicaVaultMetadataArgs
replicaRegion This property is required. String
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
vaultId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the primary vault to create replica from.
replicaVaultMetadata Changes to this property will trigger replacement. Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing VaultVerification Resource

Get an existing VaultVerification 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?: VaultVerificationState, opts?: CustomResourceOptions): VaultVerification
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        replica_region: Optional[str] = None,
        replica_vault_metadata: Optional[_kms.VaultVerificationReplicaVaultMetadataArgs] = None,
        vault_id: Optional[str] = None) -> VaultVerification
func GetVaultVerification(ctx *Context, name string, id IDInput, state *VaultVerificationState, opts ...ResourceOption) (*VaultVerification, error)
public static VaultVerification Get(string name, Input<string> id, VaultVerificationState? state, CustomResourceOptions? opts = null)
public static VaultVerification get(String name, Output<String> id, VaultVerificationState state, CustomResourceOptions options)
resources:  _:    type: oci:Kms:VaultVerification    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ReplicaRegion string
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
ReplicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadata
VaultId Changes to this property will trigger replacement. string
The OCID of the primary vault to create replica from.
ReplicaRegion string
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
ReplicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadataArgs
VaultId Changes to this property will trigger replacement. string
The OCID of the primary vault to create replica from.
replicaRegion String
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
replicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadata
vaultId Changes to this property will trigger replacement. String
The OCID of the primary vault to create replica from.
replicaRegion string
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
replicaVaultMetadata Changes to this property will trigger replacement. VaultVerificationReplicaVaultMetadata
vaultId Changes to this property will trigger replacement. string
The OCID of the primary vault to create replica from.
replica_region str
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
replica_vault_metadata Changes to this property will trigger replacement. kms.VaultVerificationReplicaVaultMetadataArgs
vault_id Changes to this property will trigger replacement. str
The OCID of the primary vault to create replica from.
replicaRegion String
(Updatable) The region to be created replica to. When updated, replica will be deleted from old region, and created to updated region.
replicaVaultMetadata Changes to this property will trigger replacement. Property Map
vaultId Changes to this property will trigger replacement. String
The OCID of the primary vault to create replica from.

Supporting Types

VaultVerificationReplicaVaultMetadata
, VaultVerificationReplicaVaultMetadataArgs

IdcsAccountNameUrl
This property is required.
Changes to this property will trigger replacement.
string
PrivateEndpointId
This property is required.
Changes to this property will trigger replacement.
string
VaultType
This property is required.
Changes to this property will trigger replacement.
string
IdcsAccountNameUrl
This property is required.
Changes to this property will trigger replacement.
string
PrivateEndpointId
This property is required.
Changes to this property will trigger replacement.
string
VaultType
This property is required.
Changes to this property will trigger replacement.
string
idcsAccountNameUrl
This property is required.
Changes to this property will trigger replacement.
String
privateEndpointId
This property is required.
Changes to this property will trigger replacement.
String
vaultType
This property is required.
Changes to this property will trigger replacement.
String
idcsAccountNameUrl
This property is required.
Changes to this property will trigger replacement.
string
privateEndpointId
This property is required.
Changes to this property will trigger replacement.
string
vaultType
This property is required.
Changes to this property will trigger replacement.
string
idcs_account_name_url
This property is required.
Changes to this property will trigger replacement.
str
private_endpoint_id
This property is required.
Changes to this property will trigger replacement.
str
vault_type
This property is required.
Changes to this property will trigger replacement.
str
idcsAccountNameUrl
This property is required.
Changes to this property will trigger replacement.
String
privateEndpointId
This property is required.
Changes to this property will trigger replacement.
String
vaultType
This property is required.
Changes to this property will trigger replacement.
String

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.