1. Packages
  2. Scaleway
  3. API Docs
  4. DomainZone
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

scaleway.DomainZone

Explore with Pulumi AI

scaleway logo
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

    Import

    This section explains how to import a zone using the {subdomain}.{domain} format.

    bash

    $ pulumi import scaleway:index/domainZone:DomainZone test test.scaleway-terraform.com
    

    Create DomainZone Resource

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

    Constructor syntax

    new DomainZone(name: string, args: DomainZoneArgs, opts?: CustomResourceOptions);
    @overload
    def DomainZone(resource_name: str,
                   args: DomainZoneArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainZone(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain: Optional[str] = None,
                   subdomain: Optional[str] = None,
                   project_id: Optional[str] = None)
    func NewDomainZone(ctx *Context, name string, args DomainZoneArgs, opts ...ResourceOption) (*DomainZone, error)
    public DomainZone(string name, DomainZoneArgs args, CustomResourceOptions? opts = null)
    public DomainZone(String name, DomainZoneArgs args)
    public DomainZone(String name, DomainZoneArgs args, CustomResourceOptions options)
    
    type: scaleway:DomainZone
    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 DomainZoneArgs
    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 DomainZoneArgs
    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 DomainZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainZoneArgs
    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 domainZoneResource = new Scaleway.DomainZone("domainZoneResource", new()
    {
        Domain = "string",
        Subdomain = "string",
        ProjectId = "string",
    });
    
    example, err := scaleway.NewDomainZone(ctx, "domainZoneResource", &scaleway.DomainZoneArgs{
    	Domain:    pulumi.String("string"),
    	Subdomain: pulumi.String("string"),
    	ProjectId: pulumi.String("string"),
    })
    
    var domainZoneResource = new DomainZone("domainZoneResource", DomainZoneArgs.builder()
        .domain("string")
        .subdomain("string")
        .projectId("string")
        .build());
    
    domain_zone_resource = scaleway.DomainZone("domainZoneResource",
        domain="string",
        subdomain="string",
        project_id="string")
    
    const domainZoneResource = new scaleway.DomainZone("domainZoneResource", {
        domain: "string",
        subdomain: "string",
        projectId: "string",
    });
    
    type: scaleway:DomainZone
    properties:
        domain: string
        projectId: string
        subdomain: string
    

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

    Domain string
    The main domain where the DNS zone will be created.
    Subdomain string
    The name of the subdomain (zone name) to create within the domain.
    ProjectId string
    project_id) The ID of the Project associated with the domain.
    Domain string
    The main domain where the DNS zone will be created.
    Subdomain string
    The name of the subdomain (zone name) to create within the domain.
    ProjectId string
    project_id) The ID of the Project associated with the domain.
    domain String
    The main domain where the DNS zone will be created.
    subdomain String
    The name of the subdomain (zone name) to create within the domain.
    projectId String
    project_id) The ID of the Project associated with the domain.
    domain string
    The main domain where the DNS zone will be created.
    subdomain string
    The name of the subdomain (zone name) to create within the domain.
    projectId string
    project_id) The ID of the Project associated with the domain.
    domain str
    The main domain where the DNS zone will be created.
    subdomain str
    The name of the subdomain (zone name) to create within the domain.
    project_id str
    project_id) The ID of the Project associated with the domain.
    domain String
    The main domain where the DNS zone will be created.
    subdomain String
    The name of the subdomain (zone name) to create within the domain.
    projectId String
    project_id) The ID of the Project associated with the domain.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Message.
    Ns List<string>
    The list of same servers for the zone.
    NsDefaults List<string>
    The default list of same servers for the zone.
    NsMasters List<string>
    The master list of same servers for the zone.
    Status string
    The status of the domain zone.
    UpdatedAt string
    The date and time at which the DNS zone was last updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Message.
    Ns []string
    The list of same servers for the zone.
    NsDefaults []string
    The default list of same servers for the zone.
    NsMasters []string
    The master list of same servers for the zone.
    Status string
    The status of the domain zone.
    UpdatedAt string
    The date and time at which the DNS zone was last updated.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Message.
    ns List<String>
    The list of same servers for the zone.
    nsDefaults List<String>
    The default list of same servers for the zone.
    nsMasters List<String>
    The master list of same servers for the zone.
    status String
    The status of the domain zone.
    updatedAt String
    The date and time at which the DNS zone was last updated.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Message.
    ns string[]
    The list of same servers for the zone.
    nsDefaults string[]
    The default list of same servers for the zone.
    nsMasters string[]
    The master list of same servers for the zone.
    status string
    The status of the domain zone.
    updatedAt string
    The date and time at which the DNS zone was last updated.
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    Message.
    ns Sequence[str]
    The list of same servers for the zone.
    ns_defaults Sequence[str]
    The default list of same servers for the zone.
    ns_masters Sequence[str]
    The master list of same servers for the zone.
    status str
    The status of the domain zone.
    updated_at str
    The date and time at which the DNS zone was last updated.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Message.
    ns List<String>
    The list of same servers for the zone.
    nsDefaults List<String>
    The default list of same servers for the zone.
    nsMasters List<String>
    The master list of same servers for the zone.
    status String
    The status of the domain zone.
    updatedAt String
    The date and time at which the DNS zone was last updated.

    Look up Existing DomainZone Resource

    Get an existing DomainZone 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?: DomainZoneState, opts?: CustomResourceOptions): DomainZone
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain: Optional[str] = None,
            message: Optional[str] = None,
            ns: Optional[Sequence[str]] = None,
            ns_defaults: Optional[Sequence[str]] = None,
            ns_masters: Optional[Sequence[str]] = None,
            project_id: Optional[str] = None,
            status: Optional[str] = None,
            subdomain: Optional[str] = None,
            updated_at: Optional[str] = None) -> DomainZone
    func GetDomainZone(ctx *Context, name string, id IDInput, state *DomainZoneState, opts ...ResourceOption) (*DomainZone, error)
    public static DomainZone Get(string name, Input<string> id, DomainZoneState? state, CustomResourceOptions? opts = null)
    public static DomainZone get(String name, Output<String> id, DomainZoneState 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:
    Domain string
    The main domain where the DNS zone will be created.
    Message string
    Message.
    Ns List<string>
    The list of same servers for the zone.
    NsDefaults List<string>
    The default list of same servers for the zone.
    NsMasters List<string>
    The master list of same servers for the zone.
    ProjectId string
    project_id) The ID of the Project associated with the domain.
    Status string
    The status of the domain zone.
    Subdomain string
    The name of the subdomain (zone name) to create within the domain.
    UpdatedAt string
    The date and time at which the DNS zone was last updated.
    Domain string
    The main domain where the DNS zone will be created.
    Message string
    Message.
    Ns []string
    The list of same servers for the zone.
    NsDefaults []string
    The default list of same servers for the zone.
    NsMasters []string
    The master list of same servers for the zone.
    ProjectId string
    project_id) The ID of the Project associated with the domain.
    Status string
    The status of the domain zone.
    Subdomain string
    The name of the subdomain (zone name) to create within the domain.
    UpdatedAt string
    The date and time at which the DNS zone was last updated.
    domain String
    The main domain where the DNS zone will be created.
    message String
    Message.
    ns List<String>
    The list of same servers for the zone.
    nsDefaults List<String>
    The default list of same servers for the zone.
    nsMasters List<String>
    The master list of same servers for the zone.
    projectId String
    project_id) The ID of the Project associated with the domain.
    status String
    The status of the domain zone.
    subdomain String
    The name of the subdomain (zone name) to create within the domain.
    updatedAt String
    The date and time at which the DNS zone was last updated.
    domain string
    The main domain where the DNS zone will be created.
    message string
    Message.
    ns string[]
    The list of same servers for the zone.
    nsDefaults string[]
    The default list of same servers for the zone.
    nsMasters string[]
    The master list of same servers for the zone.
    projectId string
    project_id) The ID of the Project associated with the domain.
    status string
    The status of the domain zone.
    subdomain string
    The name of the subdomain (zone name) to create within the domain.
    updatedAt string
    The date and time at which the DNS zone was last updated.
    domain str
    The main domain where the DNS zone will be created.
    message str
    Message.
    ns Sequence[str]
    The list of same servers for the zone.
    ns_defaults Sequence[str]
    The default list of same servers for the zone.
    ns_masters Sequence[str]
    The master list of same servers for the zone.
    project_id str
    project_id) The ID of the Project associated with the domain.
    status str
    The status of the domain zone.
    subdomain str
    The name of the subdomain (zone name) to create within the domain.
    updated_at str
    The date and time at which the DNS zone was last updated.
    domain String
    The main domain where the DNS zone will be created.
    message String
    Message.
    ns List<String>
    The list of same servers for the zone.
    nsDefaults List<String>
    The default list of same servers for the zone.
    nsMasters List<String>
    The master list of same servers for the zone.
    projectId String
    project_id) The ID of the Project associated with the domain.
    status String
    The status of the domain zone.
    subdomain String
    The name of the subdomain (zone name) to create within the domain.
    updatedAt String
    The date and time at which the DNS zone was last updated.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse