1. Packages
  2. Scaleway
  3. API Docs
  4. domain
  5. Zone
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.domain.Zone

Explore with Pulumi AI

Import

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

bash

$ pulumi import scaleway:domain/zone:Zone test test.scaleway-terraform.com
Copy

Create Zone Resource

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

Constructor syntax

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

@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         domain: Optional[str] = None,
         subdomain: Optional[str] = None,
         project_id: Optional[str] = None)
func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
public Zone(String name, ZoneArgs args)
public Zone(String name, ZoneArgs args, CustomResourceOptions options)
type: scaleway:domain:Zone
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. ZoneArgs
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. ZoneArgs
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. ZoneArgs
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. ZoneArgs
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. ZoneArgs
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 zoneResource = new Scaleway.Domain.Zone("zoneResource", new()
{
    Domain = "string",
    Subdomain = "string",
    ProjectId = "string",
});
Copy
example, err := domain.NewZone(ctx, "zoneResource", &domain.ZoneArgs{
	Domain:    pulumi.String("string"),
	Subdomain: pulumi.String("string"),
	ProjectId: pulumi.String("string"),
})
Copy
var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
    .domain("string")
    .subdomain("string")
    .projectId("string")
    .build());
Copy
zone_resource = scaleway.domain.Zone("zoneResource",
    domain="string",
    subdomain="string",
    project_id="string")
Copy
const zoneResource = new scaleway.domain.Zone("zoneResource", {
    domain: "string",
    subdomain: "string",
    projectId: "string",
});
Copy
type: scaleway:domain:Zone
properties:
    domain: string
    projectId: string
    subdomain: string
Copy

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

Domain
This property is required.
Changes to this property will trigger replacement.
string
The main domain where the DNS zone will be created.
Subdomain This property is required. string
The name of the subdomain (zone name) to create within the domain.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project associated with the domain.
Domain
This property is required.
Changes to this property will trigger replacement.
string
The main domain where the DNS zone will be created.
Subdomain This property is required. string
The name of the subdomain (zone name) to create within the domain.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project associated with the domain.
domain
This property is required.
Changes to this property will trigger replacement.
String
The main domain where the DNS zone will be created.
subdomain This property is required. String
The name of the subdomain (zone name) to create within the domain.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project associated with the domain.
domain
This property is required.
Changes to this property will trigger replacement.
string
The main domain where the DNS zone will be created.
subdomain This property is required. string
The name of the subdomain (zone name) to create within the domain.
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project associated with the domain.
domain
This property is required.
Changes to this property will trigger replacement.
str
The main domain where the DNS zone will be created.
subdomain This property is required. str
The name of the subdomain (zone name) to create within the domain.
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project associated with the domain.
domain
This property is required.
Changes to this property will trigger replacement.
String
The main domain where the DNS zone will be created.
subdomain This property is required. String
The name of the subdomain (zone name) to create within the domain.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project associated with the domain.

Outputs

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

Get an existing Zone 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?: ZoneState, opts?: CustomResourceOptions): Zone
@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) -> Zone
func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
public static Zone get(String name, Output<String> id, ZoneState state, CustomResourceOptions options)
resources:  _:    type: scaleway:domain:Zone    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:
Domain Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.