DnsZone

The akamai.DnsZone provides the resource for configuring a DNS zone to integrate easily with your existing DNS infrastructure to provide a secure, high performance, highly available and scalable solution for DNS hosting.

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var demozone = new Akamai.DnsZone("demozone", new Akamai.DnsZoneArgs
        {
            Comment = "some comment",
            Contract = "ctr_1-AB123",
            Group = "100",
            Masters = 
            {
                "1.2.3.4",
                "1.2.3.5",
            },
            SignAndServe = false,
            Type = "secondary",
            Zone = "example.com",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v2/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := akamai.NewDnsZone(ctx, "demozone", &akamai.DnsZoneArgs{
			Comment:  pulumi.String("some comment"),
			Contract: pulumi.String("ctr_1-AB123"),
			Group:    pulumi.String("100"),
			Masters: pulumi.StringArray{
				pulumi.String("1.2.3.4"),
				pulumi.String("1.2.3.5"),
			},
			SignAndServe: pulumi.Bool(false),
			Type:         pulumi.String("secondary"),
			Zone:         pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_akamai as akamai

demozone = akamai.DnsZone("demozone",
    comment="some comment",
    contract="ctr_1-AB123",
    group="100",
    masters=[
        "1.2.3.4",
        "1.2.3.5",
    ],
    sign_and_serve=False,
    type="secondary",
    zone="example.com")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const demozone = new akamai.DnsZone("demozone", {
    comment: "some comment",
    contract: "ctr_1-AB123",
    group: "100",
    masters: [
        "1.2.3.4",
        "1.2.3.5",
    ],
    signAndServe: false,
    type: "secondary",
    zone: "example.com",
});

Create a DnsZone Resource

new DnsZone(name: string, args: DnsZoneArgs, opts?: CustomResourceOptions);
@overload
def DnsZone(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            contract: Optional[str] = None,
            end_customer_id: Optional[str] = None,
            group: Optional[str] = None,
            masters: Optional[Sequence[str]] = None,
            sign_and_serve: Optional[bool] = None,
            sign_and_serve_algorithm: Optional[str] = None,
            target: Optional[str] = None,
            tsig_key: Optional[DnsZoneTsigKeyArgs] = None,
            type: Optional[str] = None,
            zone: Optional[str] = None)
@overload
def DnsZone(resource_name: str,
            args: DnsZoneArgs,
            opts: Optional[ResourceOptions] = None)
func NewDnsZone(ctx *Context, name string, args DnsZoneArgs, opts ...ResourceOption) (*DnsZone, error)
public DnsZone(string name, DnsZoneArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DnsZoneArgs
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 DnsZoneArgs
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 DnsZoneArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DnsZoneArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DnsZone Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The DnsZone resource accepts the following input properties:

Contract string
The contract ID.
Group string
The currently selected group ID.
Type string
Whether the zone is primary or secondary.
Zone string
Domain zone, encapsulating any nested subdomains.
Comment string
A descriptive comment.
EndCustomerId string
Masters List<string>
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
SignAndServe bool
Whether DNSSEC Sign&Serve is enabled.
SignAndServeAlgorithm string
Algorithm used by Sign&Serve.
Target string
The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKeyArgs
TSIG Key used in secure zone transfers
Contract string
The contract ID.
Group string
The currently selected group ID.
Type string
Whether the zone is primary or secondary.
Zone string
Domain zone, encapsulating any nested subdomains.
Comment string
A descriptive comment.
EndCustomerId string
Masters []string
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
SignAndServe bool
Whether DNSSEC Sign&Serve is enabled.
SignAndServeAlgorithm string
Algorithm used by Sign&Serve.
Target string
The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKey
TSIG Key used in secure zone transfers
contract string
The contract ID.
group string
The currently selected group ID.
type string
Whether the zone is primary or secondary.
zone string
Domain zone, encapsulating any nested subdomains.
comment string
A descriptive comment.
endCustomerId string
masters string[]
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
signAndServe boolean
Whether DNSSEC Sign&Serve is enabled.
signAndServeAlgorithm string
Algorithm used by Sign&Serve.
target string
The name of the zone whose configuration this zone will copy.
tsigKey DnsZoneTsigKeyArgs
TSIG Key used in secure zone transfers
contract str
The contract ID.
group str
The currently selected group ID.
type str
Whether the zone is primary or secondary.
zone str
Domain zone, encapsulating any nested subdomains.
comment str
A descriptive comment.
end_customer_id str
masters Sequence[str]
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
sign_and_serve bool
Whether DNSSEC Sign&Serve is enabled.
sign_and_serve_algorithm str
Algorithm used by Sign&Serve.
target str
The name of the zone whose configuration this zone will copy.
tsig_key DnsZoneTsigKeyArgs
TSIG Key used in secure zone transfers

Outputs

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

ActivationState string
AliasCount int
Id string
The provider-assigned unique ID for this managed resource.
VersionId string
ActivationState string
AliasCount int
Id string
The provider-assigned unique ID for this managed resource.
VersionId string
activationState string
aliasCount number
id string
The provider-assigned unique ID for this managed resource.
versionId string
activation_state str
alias_count int
id str
The provider-assigned unique ID for this managed resource.
version_id str

Look up an Existing DnsZone Resource

Get an existing DnsZone 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?: DnsZoneState, opts?: CustomResourceOptions): DnsZone
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_state: Optional[str] = None,
        alias_count: Optional[int] = None,
        comment: Optional[str] = None,
        contract: Optional[str] = None,
        end_customer_id: Optional[str] = None,
        group: Optional[str] = None,
        masters: Optional[Sequence[str]] = None,
        sign_and_serve: Optional[bool] = None,
        sign_and_serve_algorithm: Optional[str] = None,
        target: Optional[str] = None,
        tsig_key: Optional[DnsZoneTsigKeyArgs] = None,
        type: Optional[str] = None,
        version_id: Optional[str] = None,
        zone: Optional[str] = None) -> DnsZone
func GetDnsZone(ctx *Context, name string, id IDInput, state *DnsZoneState, opts ...ResourceOption) (*DnsZone, error)
public static DnsZone Get(string name, Input<string> id, DnsZoneState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

ActivationState string
AliasCount int
Comment string
A descriptive comment.
Contract string
The contract ID.
EndCustomerId string
Group string
The currently selected group ID.
Masters List<string>
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
SignAndServe bool
Whether DNSSEC Sign&Serve is enabled.
SignAndServeAlgorithm string
Algorithm used by Sign&Serve.
Target string
The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKeyArgs
TSIG Key used in secure zone transfers
Type string
Whether the zone is primary or secondary.
VersionId string
Zone string
Domain zone, encapsulating any nested subdomains.
ActivationState string
AliasCount int
Comment string
A descriptive comment.
Contract string
The contract ID.
EndCustomerId string
Group string
The currently selected group ID.
Masters []string
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
SignAndServe bool
Whether DNSSEC Sign&Serve is enabled.
SignAndServeAlgorithm string
Algorithm used by Sign&Serve.
Target string
The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKey
TSIG Key used in secure zone transfers
Type string
Whether the zone is primary or secondary.
VersionId string
Zone string
Domain zone, encapsulating any nested subdomains.
activationState string
aliasCount number
comment string
A descriptive comment.
contract string
The contract ID.
endCustomerId string
group string
The currently selected group ID.
masters string[]
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
signAndServe boolean
Whether DNSSEC Sign&Serve is enabled.
signAndServeAlgorithm string
Algorithm used by Sign&Serve.
target string
The name of the zone whose configuration this zone will copy.
tsigKey DnsZoneTsigKeyArgs
TSIG Key used in secure zone transfers
type string
Whether the zone is primary or secondary.
versionId string
zone string
Domain zone, encapsulating any nested subdomains.
activation_state str
alias_count int
comment str
A descriptive comment.
contract str
The contract ID.
end_customer_id str
group str
The currently selected group ID.
masters Sequence[str]
The names or addresses of the customer’s nameservers from which the zone data should be retrieved.
sign_and_serve bool
Whether DNSSEC Sign&Serve is enabled.
sign_and_serve_algorithm str
Algorithm used by Sign&Serve.
target str
The name of the zone whose configuration this zone will copy.
tsig_key DnsZoneTsigKeyArgs
TSIG Key used in secure zone transfers
type str
Whether the zone is primary or secondary.
version_id str
zone str
Domain zone, encapsulating any nested subdomains.

Supporting Types

DnsZoneTsigKey

Algorithm string
Name string

key name

  • algorithm
  • secret
Secret string
Algorithm string
Name string

key name

  • algorithm
  • secret
Secret string
algorithm string
name string

key name

  • algorithm
  • secret
secret string
algorithm str
name str

key name

  • algorithm
  • secret
secret str

Package Details

Repository
https://github.com/pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.