Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Civo Provider
  3. API Docs
  4. DnsDomainRecord
Civo v2.4.6 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-civo

civo.DnsDomainRecord

Explore with Pulumi AI

civo logo
Civo v2.4.6 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-civo

    Provides a Civo DNS domain record resource.

    Create DnsDomainRecord Resource

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

    Constructor syntax

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

@overload
def DnsDomainRecord(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_id: Optional[str] = None,
                    ttl: Optional[int] = None,
                    type: Optional[str] = None,
                    value: Optional[str] = None,
                    name: Optional[str] = None,
                    priority: Optional[int] = None)
    func NewDnsDomainRecord(ctx *Context, name string, args DnsDomainRecordArgs, opts ...ResourceOption) (*DnsDomainRecord, error)
    public DnsDomainRecord(string name, DnsDomainRecordArgs args, CustomResourceOptions? opts = null)
    public DnsDomainRecord(String name, DnsDomainRecordArgs args)
public DnsDomainRecord(String name, DnsDomainRecordArgs args, CustomResourceOptions options)

    type: civo:DnsDomainRecord
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 DnsDomainRecordArgs
    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 DnsDomainRecordArgs
    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 DnsDomainRecordArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsDomainRecordArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsDomainRecordArgs
    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 dnsDomainRecordResource = new Civo.DnsDomainRecord("dnsDomainRecordResource", new()
{
    DomainId = "string",
    Ttl = 0,
    Type = "string",
    Value = "string",
    Name = "string",
    Priority = 0,
});

    example, err := civo.NewDnsDomainRecord(ctx, "dnsDomainRecordResource", &civo.DnsDomainRecordArgs{
	DomainId: pulumi.String("string"),
	Ttl:      pulumi.Int(0),
	Type:     pulumi.String("string"),
	Value:    pulumi.String("string"),
	Name:     pulumi.String("string"),
	Priority: pulumi.Int(0),
})

    var dnsDomainRecordResource = new DnsDomainRecord("dnsDomainRecordResource", DnsDomainRecordArgs.builder()
    .domainId("string")
    .ttl(0)
    .type("string")
    .value("string")
    .name("string")
    .priority(0)
    .build());

    dns_domain_record_resource = civo.DnsDomainRecord("dnsDomainRecordResource",
    domain_id="string",
    ttl=0,
    type="string",
    value="string",
    name="string",
    priority=0)

    const dnsDomainRecordResource = new civo.DnsDomainRecord("dnsDomainRecordResource", {
    domainId: "string",
    ttl: 0,
    type: "string",
    value: "string",
    name: "string",
    priority: 0,
});

    type: civo:DnsDomainRecord
properties:
    domainId: string
    name: string
    priority: 0
    ttl: 0
    type: string
    value: string

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

    DomainId string
    ID from domain name
    Ttl int
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    Type string
    The choice of RR type from a, cname, mx or txt
    Value string
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    Name string
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    Priority int
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    DomainId string
    ID from domain name
    Ttl int
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    Type string
    The choice of RR type from a, cname, mx or txt
    Value string
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    Name string
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    Priority int
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    domainId String
    ID from domain name
    ttl Integer
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type String
    The choice of RR type from a, cname, mx or txt
    value String
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    name String
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority Integer
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    domainId string
    ID from domain name
    ttl number
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type string
    The choice of RR type from a, cname, mx or txt
    value string
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    name string
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority number
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    domain_id str
    ID from domain name
    ttl int
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type str
    The choice of RR type from a, cname, mx or txt
    value str
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    name str
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority int
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    domainId String
    ID from domain name
    ttl Number
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type String
    The choice of RR type from a, cname, mx or txt
    value String
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    name String
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority Number
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)

    Outputs

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

    AccountId string
    The account ID of this resource
    CreatedAt string
    Timestamp when this resource was created
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Timestamp when this resource was updated
    AccountId string
    The account ID of this resource
    CreatedAt string
    Timestamp when this resource was created
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Timestamp when this resource was updated
    accountId String
    The account ID of this resource
    createdAt String
    Timestamp when this resource was created
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Timestamp when this resource was updated
    accountId string
    The account ID of this resource
    createdAt string
    Timestamp when this resource was created
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Timestamp when this resource was updated
    account_id str
    The account ID of this resource
    created_at str
    Timestamp when this resource was created
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Timestamp when this resource was updated
    accountId String
    The account ID of this resource
    createdAt String
    Timestamp when this resource was created
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Timestamp when this resource was updated

    Look up Existing DnsDomainRecord Resource

    Get an existing DnsDomainRecord 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?: DnsDomainRecordState, opts?: CustomResourceOptions): DnsDomainRecord
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        created_at: Optional[str] = None,
        domain_id: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        ttl: Optional[int] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        value: Optional[str] = None) -> DnsDomainRecord
    func GetDnsDomainRecord(ctx *Context, name string, id IDInput, state *DnsDomainRecordState, opts ...ResourceOption) (*DnsDomainRecord, error)
    public static DnsDomainRecord Get(string name, Input<string> id, DnsDomainRecordState? state, CustomResourceOptions? opts = null)
    public static DnsDomainRecord get(String name, Output<String> id, DnsDomainRecordState 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:
    AccountId string
    The account ID of this resource
    CreatedAt string
    Timestamp when this resource was created
    DomainId string
    ID from domain name
    Name string
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    Priority int
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    Ttl int
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    Type string
    The choice of RR type from a, cname, mx or txt
    UpdatedAt string
    Timestamp when this resource was updated
    Value string
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    AccountId string
    The account ID of this resource
    CreatedAt string
    Timestamp when this resource was created
    DomainId string
    ID from domain name
    Name string
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    Priority int
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    Ttl int
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    Type string
    The choice of RR type from a, cname, mx or txt
    UpdatedAt string
    Timestamp when this resource was updated
    Value string
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    accountId String
    The account ID of this resource
    createdAt String
    Timestamp when this resource was created
    domainId String
    ID from domain name
    name String
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority Integer
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    ttl Integer
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type String
    The choice of RR type from a, cname, mx or txt
    updatedAt String
    Timestamp when this resource was updated
    value String
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    accountId string
    The account ID of this resource
    createdAt string
    Timestamp when this resource was created
    domainId string
    ID from domain name
    name string
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority number
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    ttl number
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type string
    The choice of RR type from a, cname, mx or txt
    updatedAt string
    Timestamp when this resource was updated
    value string
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    account_id str
    The account ID of this resource
    created_at str
    Timestamp when this resource was created
    domain_id str
    ID from domain name
    name str
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority int
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    ttl int
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type str
    The choice of RR type from a, cname, mx or txt
    updated_at str
    Timestamp when this resource was updated
    value str
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record
    accountId String
    The account ID of this resource
    createdAt String
    Timestamp when this resource was created
    domainId String
    ID from domain name
    name String
    The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)
    priority Number
    Useful for MX records only, the priority mail should be attempted it (defaults to 10)
    ttl Number
    How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)
    type String
    The choice of RR type from a, cname, mx or txt
    updatedAt String
    Timestamp when this resource was updated
    value String
    The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record

    Import

    using domain_id:domain_record_id

    $ pulumi import civo:index/dnsDomainRecord:DnsDomainRecord www a3cd6832-9577-4017-afd7-17d239fc0bf0:c9a39d14-ee1b-4870-8fb0-a2d4f465e822

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.4.6 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-civo