1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. RegistrarDomain
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.RegistrarDomain

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleRegistrarDomain = new cloudflare.RegistrarDomain("example_registrar_domain", {
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        domainName: "cloudflare.com",
        autoRenew: true,
        locked: false,
        privacy: true,
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_registrar_domain = cloudflare.RegistrarDomain("example_registrar_domain",
        account_id="023e105f4ecef8ad9ca31a8372d0c353",
        domain_name="cloudflare.com",
        auto_renew=True,
        locked=False,
        privacy=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewRegistrarDomain(ctx, "example_registrar_domain", &cloudflare.RegistrarDomainArgs{
    			AccountId:  pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			DomainName: pulumi.String("cloudflare.com"),
    			AutoRenew:  pulumi.Bool(true),
    			Locked:     pulumi.Bool(false),
    			Privacy:    pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleRegistrarDomain = new Cloudflare.RegistrarDomain("example_registrar_domain", new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            DomainName = "cloudflare.com",
            AutoRenew = true,
            Locked = false,
            Privacy = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.RegistrarDomain;
    import com.pulumi.cloudflare.RegistrarDomainArgs;
    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 exampleRegistrarDomain = new RegistrarDomain("exampleRegistrarDomain", RegistrarDomainArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .domainName("cloudflare.com")
                .autoRenew(true)
                .locked(false)
                .privacy(true)
                .build());
    
        }
    }
    
    resources:
      exampleRegistrarDomain:
        type: cloudflare:RegistrarDomain
        name: example_registrar_domain
        properties:
          accountId: 023e105f4ecef8ad9ca31a8372d0c353
          domainName: cloudflare.com
          autoRenew: true
          locked: false
          privacy: true
    

    Create RegistrarDomain Resource

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

    Constructor syntax

    new RegistrarDomain(name: string, args: RegistrarDomainArgs, opts?: CustomResourceOptions);
    @overload
    def RegistrarDomain(resource_name: str,
                        args: RegistrarDomainArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def RegistrarDomain(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        account_id: Optional[str] = None,
                        domain_name: Optional[str] = None,
                        auto_renew: Optional[bool] = None,
                        locked: Optional[bool] = None,
                        privacy: Optional[bool] = None)
    func NewRegistrarDomain(ctx *Context, name string, args RegistrarDomainArgs, opts ...ResourceOption) (*RegistrarDomain, error)
    public RegistrarDomain(string name, RegistrarDomainArgs args, CustomResourceOptions? opts = null)
    public RegistrarDomain(String name, RegistrarDomainArgs args)
    public RegistrarDomain(String name, RegistrarDomainArgs args, CustomResourceOptions options)
    
    type: cloudflare:RegistrarDomain
    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 RegistrarDomainArgs
    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 RegistrarDomainArgs
    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 RegistrarDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegistrarDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegistrarDomainArgs
    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 registrarDomainResource = new Cloudflare.RegistrarDomain("registrarDomainResource", new()
    {
        AccountId = "string",
        DomainName = "string",
        AutoRenew = false,
        Locked = false,
        Privacy = false,
    });
    
    example, err := cloudflare.NewRegistrarDomain(ctx, "registrarDomainResource", &cloudflare.RegistrarDomainArgs{
    	AccountId:  pulumi.String("string"),
    	DomainName: pulumi.String("string"),
    	AutoRenew:  pulumi.Bool(false),
    	Locked:     pulumi.Bool(false),
    	Privacy:    pulumi.Bool(false),
    })
    
    var registrarDomainResource = new RegistrarDomain("registrarDomainResource", RegistrarDomainArgs.builder()
        .accountId("string")
        .domainName("string")
        .autoRenew(false)
        .locked(false)
        .privacy(false)
        .build());
    
    registrar_domain_resource = cloudflare.RegistrarDomain("registrarDomainResource",
        account_id="string",
        domain_name="string",
        auto_renew=False,
        locked=False,
        privacy=False)
    
    const registrarDomainResource = new cloudflare.RegistrarDomain("registrarDomainResource", {
        accountId: "string",
        domainName: "string",
        autoRenew: false,
        locked: false,
        privacy: false,
    });
    
    type: cloudflare:RegistrarDomain
    properties:
        accountId: string
        autoRenew: false
        domainName: string
        locked: false
        privacy: false
    

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

    AccountId string
    Identifier
    DomainName string
    Domain name.
    AutoRenew bool
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    Locked bool
    Shows whether a registrar lock is in place for a domain.
    Privacy bool
    Privacy option controls redacting WHOIS information.
    AccountId string
    Identifier
    DomainName string
    Domain name.
    AutoRenew bool
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    Locked bool
    Shows whether a registrar lock is in place for a domain.
    Privacy bool
    Privacy option controls redacting WHOIS information.
    accountId String
    Identifier
    domainName String
    Domain name.
    autoRenew Boolean
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    locked Boolean
    Shows whether a registrar lock is in place for a domain.
    privacy Boolean
    Privacy option controls redacting WHOIS information.
    accountId string
    Identifier
    domainName string
    Domain name.
    autoRenew boolean
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    locked boolean
    Shows whether a registrar lock is in place for a domain.
    privacy boolean
    Privacy option controls redacting WHOIS information.
    account_id str
    Identifier
    domain_name str
    Domain name.
    auto_renew bool
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    locked bool
    Shows whether a registrar lock is in place for a domain.
    privacy bool
    Privacy option controls redacting WHOIS information.
    accountId String
    Identifier
    domainName String
    Domain name.
    autoRenew Boolean
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    locked Boolean
    Shows whether a registrar lock is in place for a domain.
    privacy Boolean
    Privacy option controls redacting WHOIS information.

    Outputs

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

    Get an existing RegistrarDomain 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?: RegistrarDomainState, opts?: CustomResourceOptions): RegistrarDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            auto_renew: Optional[bool] = None,
            domain_name: Optional[str] = None,
            locked: Optional[bool] = None,
            privacy: Optional[bool] = None) -> RegistrarDomain
    func GetRegistrarDomain(ctx *Context, name string, id IDInput, state *RegistrarDomainState, opts ...ResourceOption) (*RegistrarDomain, error)
    public static RegistrarDomain Get(string name, Input<string> id, RegistrarDomainState? state, CustomResourceOptions? opts = null)
    public static RegistrarDomain get(String name, Output<String> id, RegistrarDomainState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:RegistrarDomain    get:      id: ${id}
    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:
    AccountId string
    Identifier
    AutoRenew bool
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    DomainName string
    Domain name.
    Locked bool
    Shows whether a registrar lock is in place for a domain.
    Privacy bool
    Privacy option controls redacting WHOIS information.
    AccountId string
    Identifier
    AutoRenew bool
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    DomainName string
    Domain name.
    Locked bool
    Shows whether a registrar lock is in place for a domain.
    Privacy bool
    Privacy option controls redacting WHOIS information.
    accountId String
    Identifier
    autoRenew Boolean
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    domainName String
    Domain name.
    locked Boolean
    Shows whether a registrar lock is in place for a domain.
    privacy Boolean
    Privacy option controls redacting WHOIS information.
    accountId string
    Identifier
    autoRenew boolean
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    domainName string
    Domain name.
    locked boolean
    Shows whether a registrar lock is in place for a domain.
    privacy boolean
    Privacy option controls redacting WHOIS information.
    account_id str
    Identifier
    auto_renew bool
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    domain_name str
    Domain name.
    locked bool
    Shows whether a registrar lock is in place for a domain.
    privacy bool
    Privacy option controls redacting WHOIS information.
    accountId String
    Identifier
    autoRenew Boolean
    Auto-renew controls whether subscription is automatically renewed upon domain expiration.
    domainName String
    Domain name.
    locked Boolean
    Shows whether a registrar lock is in place for a domain.
    privacy Boolean
    Privacy option controls redacting WHOIS information.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi