1. Packages
  2. Powerdns Provider
  3. API Docs
  4. Zone
powerdns 1.5.0 published on Monday, Apr 14, 2025 by pan-net

powerdns.Zone

Explore with Pulumi AI

powerdns logo
powerdns 1.5.0 published on Monday, Apr 14, 2025 by pan-net

    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,
             kind: Optional[str] = None,
             account: Optional[str] = None,
             masters: Optional[Sequence[str]] = None,
             name: Optional[str] = None,
             nameservers: Optional[Sequence[str]] = None,
             soa_edit_api: Optional[str] = None,
             zone_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: powerdns:Zone
    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 ZoneArgs
    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 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 string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 Powerdns.Zone("zoneResource", new()
    {
        Kind = "string",
        Account = "string",
        Masters = new[]
        {
            "string",
        },
        Name = "string",
        Nameservers = new[]
        {
            "string",
        },
        SoaEditApi = "string",
        ZoneId = "string",
    });
    
    example, err := powerdns.NewZone(ctx, "zoneResource", &powerdns.ZoneArgs{
    	Kind:    pulumi.String("string"),
    	Account: pulumi.String("string"),
    	Masters: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Nameservers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SoaEditApi: pulumi.String("string"),
    	ZoneId:     pulumi.String("string"),
    })
    
    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
        .kind("string")
        .account("string")
        .masters("string")
        .name("string")
        .nameservers("string")
        .soaEditApi("string")
        .zoneId("string")
        .build());
    
    zone_resource = powerdns.Zone("zoneResource",
        kind="string",
        account="string",
        masters=["string"],
        name="string",
        nameservers=["string"],
        soa_edit_api="string",
        zone_id="string")
    
    const zoneResource = new powerdns.Zone("zoneResource", {
        kind: "string",
        account: "string",
        masters: ["string"],
        name: "string",
        nameservers: ["string"],
        soaEditApi: "string",
        zoneId: "string",
    });
    
    type: powerdns:Zone
    properties:
        account: string
        kind: string
        masters:
            - string
        name: string
        nameservers:
            - string
        soaEditApi: string
        zoneId: string
    

    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:

    Kind string
    The kind of the zone.
    Account string
    The account owning the zone. (Default to "admin")
    Masters List<string>
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    Name string
    The name of zone.
    Nameservers List<string>
    The zone nameservers.
    SoaEditApi string
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    ZoneId string
    Kind string
    The kind of the zone.
    Account string
    The account owning the zone. (Default to "admin")
    Masters []string
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    Name string
    The name of zone.
    Nameservers []string
    The zone nameservers.
    SoaEditApi string
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    ZoneId string
    kind String
    The kind of the zone.
    account String
    The account owning the zone. (Default to "admin")
    masters List<String>
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name String
    The name of zone.
    nameservers List<String>
    The zone nameservers.
    soaEditApi String
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zoneId String
    kind string
    The kind of the zone.
    account string
    The account owning the zone. (Default to "admin")
    masters string[]
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name string
    The name of zone.
    nameservers string[]
    The zone nameservers.
    soaEditApi string
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zoneId string
    kind str
    The kind of the zone.
    account str
    The account owning the zone. (Default to "admin")
    masters Sequence[str]
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name str
    The name of zone.
    nameservers Sequence[str]
    The zone nameservers.
    soa_edit_api str
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zone_id str
    kind String
    The kind of the zone.
    account String
    The account owning the zone. (Default to "admin")
    masters List<String>
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name String
    The name of zone.
    nameservers List<String>
    The zone nameservers.
    soaEditApi String
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zoneId String

    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.
    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 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,
            account: Optional[str] = None,
            kind: Optional[str] = None,
            masters: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            nameservers: Optional[Sequence[str]] = None,
            soa_edit_api: Optional[str] = None,
            zone_id: 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: powerdns:Zone    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:
    Account string
    The account owning the zone. (Default to "admin")
    Kind string
    The kind of the zone.
    Masters List<string>
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    Name string
    The name of zone.
    Nameservers List<string>
    The zone nameservers.
    SoaEditApi string
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    ZoneId string
    Account string
    The account owning the zone. (Default to "admin")
    Kind string
    The kind of the zone.
    Masters []string
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    Name string
    The name of zone.
    Nameservers []string
    The zone nameservers.
    SoaEditApi string
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    ZoneId string
    account String
    The account owning the zone. (Default to "admin")
    kind String
    The kind of the zone.
    masters List<String>
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name String
    The name of zone.
    nameservers List<String>
    The zone nameservers.
    soaEditApi String
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zoneId String
    account string
    The account owning the zone. (Default to "admin")
    kind string
    The kind of the zone.
    masters string[]
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name string
    The name of zone.
    nameservers string[]
    The zone nameservers.
    soaEditApi string
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zoneId string
    account str
    The account owning the zone. (Default to "admin")
    kind str
    The kind of the zone.
    masters Sequence[str]
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name str
    The name of zone.
    nameservers Sequence[str]
    The zone nameservers.
    soa_edit_api str
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zone_id str
    account String
    The account owning the zone. (Default to "admin")
    kind String
    The kind of the zone.
    masters List<String>
    List of IP addresses configured as a master for this zone (“Slave” kind zones only)
    name String
    The name of zone.
    nameservers List<String>
    The zone nameservers.
    soaEditApi String
    This should map to one of the supported API values or in case you wish to remove the setting, set this argument as \"\" (that will translate to the API value "").
    zoneId String

    Package Details

    Repository
    powerdns pan-net/terraform-provider-powerdns
    License
    Notes
    This Pulumi package is based on the powerdns Terraform Provider.
    powerdns logo
    powerdns 1.5.0 published on Monday, Apr 14, 2025 by pan-net