1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. DomainReplicationToRegion
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Identity.DomainReplicationToRegion

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This resource provides the Domain Replication To Region resource in Oracle Cloud Infrastructure Identity service.

    Replicate domain to a new region. This is an asynchronous call - where, at start, {@code state} of this domain in replica region is set to ENABLING_REPLICATION. On domain replication completion the {@code state} will be set to REPLICATION_ENABLED.

    To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide the async operation’s status.

    If the replica region’s {@code state} is already ENABLING_REPLICATION or REPLICATION_ENABLED, returns 409 CONFLICT.

    • If the domain doesn’t exists, returns 404 NOT FOUND.
    • If home region is same as replication region, return 400 BAD REQUEST.
    • If Domain is not active or being updated, returns 400 BAD REQUEST.
    • If any internal error occurs, return 500 INTERNAL SERVER ERROR.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDomainReplicationToRegion = new oci.identity.DomainReplicationToRegion("test_domain_replication_to_region", {
        domainId: testDomain.id,
        replicaRegion: domainReplicationToRegionReplicaRegion,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_domain_replication_to_region = oci.identity.DomainReplicationToRegion("test_domain_replication_to_region",
        domain_id=test_domain["id"],
        replica_region=domain_replication_to_region_replica_region)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Identity.NewDomainReplicationToRegion(ctx, "test_domain_replication_to_region", &Identity.DomainReplicationToRegionArgs{
    			DomainId:      pulumi.Any(testDomain.Id),
    			ReplicaRegion: pulumi.Any(domainReplicationToRegionReplicaRegion),
    		})
    		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 testDomainReplicationToRegion = new Oci.Identity.DomainReplicationToRegion("test_domain_replication_to_region", new()
        {
            DomainId = testDomain.Id,
            ReplicaRegion = domainReplicationToRegionReplicaRegion,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Identity.DomainReplicationToRegion;
    import com.pulumi.oci.Identity.DomainReplicationToRegionArgs;
    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 testDomainReplicationToRegion = new DomainReplicationToRegion("testDomainReplicationToRegion", DomainReplicationToRegionArgs.builder()
                .domainId(testDomain.id())
                .replicaRegion(domainReplicationToRegionReplicaRegion)
                .build());
    
        }
    }
    
    resources:
      testDomainReplicationToRegion:
        type: oci:Identity:DomainReplicationToRegion
        name: test_domain_replication_to_region
        properties:
          domainId: ${testDomain.id}
          replicaRegion: ${domainReplicationToRegionReplicaRegion}
    

    Create DomainReplicationToRegion Resource

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

    Constructor syntax

    new DomainReplicationToRegion(name: string, args: DomainReplicationToRegionArgs, opts?: CustomResourceOptions);
    @overload
    def DomainReplicationToRegion(resource_name: str,
                                  args: DomainReplicationToRegionArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainReplicationToRegion(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  domain_id: Optional[str] = None,
                                  replica_region: Optional[str] = None)
    func NewDomainReplicationToRegion(ctx *Context, name string, args DomainReplicationToRegionArgs, opts ...ResourceOption) (*DomainReplicationToRegion, error)
    public DomainReplicationToRegion(string name, DomainReplicationToRegionArgs args, CustomResourceOptions? opts = null)
    public DomainReplicationToRegion(String name, DomainReplicationToRegionArgs args)
    public DomainReplicationToRegion(String name, DomainReplicationToRegionArgs args, CustomResourceOptions options)
    
    type: oci:Identity:DomainReplicationToRegion
    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 DomainReplicationToRegionArgs
    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 DomainReplicationToRegionArgs
    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 DomainReplicationToRegionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainReplicationToRegionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainReplicationToRegionArgs
    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 domainReplicationToRegionResource = new Oci.Identity.DomainReplicationToRegion("domainReplicationToRegionResource", new()
    {
        DomainId = "string",
        ReplicaRegion = "string",
    });
    
    example, err := Identity.NewDomainReplicationToRegion(ctx, "domainReplicationToRegionResource", &Identity.DomainReplicationToRegionArgs{
    	DomainId:      pulumi.String("string"),
    	ReplicaRegion: pulumi.String("string"),
    })
    
    var domainReplicationToRegionResource = new DomainReplicationToRegion("domainReplicationToRegionResource", DomainReplicationToRegionArgs.builder()
        .domainId("string")
        .replicaRegion("string")
        .build());
    
    domain_replication_to_region_resource = oci.identity.DomainReplicationToRegion("domainReplicationToRegionResource",
        domain_id="string",
        replica_region="string")
    
    const domainReplicationToRegionResource = new oci.identity.DomainReplicationToRegion("domainReplicationToRegionResource", {
        domainId: "string",
        replicaRegion: "string",
    });
    
    type: oci:Identity:DomainReplicationToRegion
    properties:
        domainId: string
        replicaRegion: string
    

    DomainReplicationToRegion 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 DomainReplicationToRegion resource accepts the following input properties:

    DomainId string
    The OCID of the domain
    ReplicaRegion string

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    DomainId string
    The OCID of the domain
    ReplicaRegion string

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domainId String
    The OCID of the domain
    replicaRegion String

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domainId string
    The OCID of the domain
    replicaRegion string

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domain_id str
    The OCID of the domain
    replica_region str

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domainId String
    The OCID of the domain
    replicaRegion String

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DomainReplicationToRegion 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 DomainReplicationToRegion Resource

    Get an existing DomainReplicationToRegion 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?: DomainReplicationToRegionState, opts?: CustomResourceOptions): DomainReplicationToRegion
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain_id: Optional[str] = None,
            replica_region: Optional[str] = None) -> DomainReplicationToRegion
    func GetDomainReplicationToRegion(ctx *Context, name string, id IDInput, state *DomainReplicationToRegionState, opts ...ResourceOption) (*DomainReplicationToRegion, error)
    public static DomainReplicationToRegion Get(string name, Input<string> id, DomainReplicationToRegionState? state, CustomResourceOptions? opts = null)
    public static DomainReplicationToRegion get(String name, Output<String> id, DomainReplicationToRegionState 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:
    DomainId string
    The OCID of the domain
    ReplicaRegion string

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    DomainId string
    The OCID of the domain
    ReplicaRegion string

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domainId String
    The OCID of the domain
    replicaRegion String

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domainId string
    The OCID of the domain
    replicaRegion string

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domain_id str
    The OCID of the domain
    replica_region str

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    domainId String
    The OCID of the domain
    replicaRegion String

    A region for which domain replication is requested for. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

    ** 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

    Import is not supported for this resource.

    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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi