Akamai

v3.0.0 published on Monday, Jul 25, 2022 by Pulumi

DnsZone

Deprecated:

akamai.edgedns.DnsZone has been deprecated in favor of akamai.DnsZone

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)

public DnsZone(String name, DnsZoneArgs args)
public DnsZone(String name, DnsZoneArgs args, CustomResourceOptions options)

type: akamai:edgedns:DnsZone
properties: # The arguments to resource properties.
options: # 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.

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.

name String: The unique name of the resource.
args DnsZoneArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The DnsZone resource accepts the following input properties:

Contract string: The contract ID.
Type string: Whether the zone is primary, secondary, or alias.
Zone string: The domain zone, encapsulating any nested subdomains.
Comment string: A descriptive comment.
EndCustomerId string: A free form identifier for the zone.
Group string: The currently selected group ID.
Masters List<string>: The names or IP addresses of the nameservers that the zone data should be retrieved from.
SignAndServe bool: Whether DNSSEC Sign and Serve is enabled.
SignAndServeAlgorithm string: The algorithm used by Sign and Serve.
Target string: The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:

Contract string: The contract ID.
Type string: Whether the zone is primary, secondary, or alias.
Zone string: The domain zone, encapsulating any nested subdomains.
Comment string: A descriptive comment.
EndCustomerId string: A free form identifier for the zone.
Group string: The currently selected group ID.
Masters []string: The names or IP addresses of the nameservers that the zone data should be retrieved from.
SignAndServe bool: Whether DNSSEC Sign and Serve is enabled.
SignAndServeAlgorithm string: The algorithm used by Sign and Serve.
Target string: The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:

contract String: The contract ID.
type String: Whether the zone is primary, secondary, or alias.
zone String: The domain zone, encapsulating any nested subdomains.
comment String: A descriptive comment.
endCustomerId String: A free form identifier for the zone.
group String: The currently selected group ID.
masters List<String>: The names or IP addresses of the nameservers that the zone data should be retrieved from.
signAndServe Boolean: Whether DNSSEC Sign and Serve is enabled.
signAndServeAlgorithm String: The algorithm used by Sign and Serve.
target String: The name of the zone whose configuration this zone will copy.
tsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:

contract string: The contract ID.
type string: Whether the zone is primary, secondary, or alias.
zone string: The domain zone, encapsulating any nested subdomains.
comment string: A descriptive comment.
endCustomerId string: A free form identifier for the zone.
group string: The currently selected group ID.
masters string[]: The names or IP addresses of the nameservers that the zone data should be retrieved from.
signAndServe boolean: Whether DNSSEC Sign and Serve is enabled.
signAndServeAlgorithm string: The algorithm used by Sign and Serve.
target string: The name of the zone whose configuration this zone will copy.
tsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:

contract str: The contract ID.
type str: Whether the zone is primary, secondary, or alias.
zone str: The domain zone, encapsulating any nested subdomains.
comment str: A descriptive comment.
end_customer_id str: A free form identifier for the zone.
group str: The currently selected group ID.
masters Sequence[str]: The names or IP addresses of the nameservers that the zone data should be retrieved from.
sign_and_serve bool: Whether DNSSEC Sign and Serve is enabled.
sign_and_serve_algorithm str: The algorithm used by Sign and Serve.
target str: The name of the zone whose configuration this zone will copy.
tsig_key DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:

contract String: The contract ID.
type String: Whether the zone is primary, secondary, or alias.
zone String: The domain zone, encapsulating any nested subdomains.
comment String: A descriptive comment.
endCustomerId String: A free form identifier for the zone.
group String: The currently selected group ID.
masters List<String>: The names or IP addresses of the nameservers that the zone data should be retrieved from.
signAndServe Boolean: Whether DNSSEC Sign and Serve is enabled.
signAndServeAlgorithm String: The algorithm used by Sign and Serve.
target String: The name of the zone whose configuration this zone will copy.
tsigKey Property Map: The TSIG Key used in secure zone transfers. If used, requires these arguments:

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 Integer
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

activationState String
aliasCount Number
id String: The provider-assigned unique ID for this managed resource.
versionId String

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)

public static DnsZone get(String name, Output<String> id, DnsZoneState 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:

ActivationState string
AliasCount int
Comment string: A descriptive comment.
Contract string: The contract ID.
EndCustomerId string: A free form identifier for the zone.
Group string: The currently selected group ID.
Masters List<string>: The names or IP addresses of the nameservers that the zone data should be retrieved from.
SignAndServe bool: Whether DNSSEC Sign and Serve is enabled.
SignAndServeAlgorithm string: The algorithm used by Sign and Serve.
Target string: The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:
Type string: Whether the zone is primary, secondary, or alias.
VersionId string
Zone string: The domain zone, encapsulating any nested subdomains.

ActivationState string
AliasCount int
Comment string: A descriptive comment.
Contract string: The contract ID.
EndCustomerId string: A free form identifier for the zone.
Group string: The currently selected group ID.
Masters []string: The names or IP addresses of the nameservers that the zone data should be retrieved from.
SignAndServe bool: Whether DNSSEC Sign and Serve is enabled.
SignAndServeAlgorithm string: The algorithm used by Sign and Serve.
Target string: The name of the zone whose configuration this zone will copy.
TsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:
Type string: Whether the zone is primary, secondary, or alias.
VersionId string
Zone string: The domain zone, encapsulating any nested subdomains.

activationState String
aliasCount Integer
comment String: A descriptive comment.
contract String: The contract ID.
endCustomerId String: A free form identifier for the zone.
group String: The currently selected group ID.
masters List<String>: The names or IP addresses of the nameservers that the zone data should be retrieved from.
signAndServe Boolean: Whether DNSSEC Sign and Serve is enabled.
signAndServeAlgorithm String: The algorithm used by Sign and Serve.
target String: The name of the zone whose configuration this zone will copy.
tsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:
type String: Whether the zone is primary, secondary, or alias.
versionId String
zone String: The domain zone, encapsulating any nested subdomains.

activationState string
aliasCount number
comment string: A descriptive comment.
contract string: The contract ID.
endCustomerId string: A free form identifier for the zone.
group string: The currently selected group ID.
masters string[]: The names or IP addresses of the nameservers that the zone data should be retrieved from.
signAndServe boolean: Whether DNSSEC Sign and Serve is enabled.
signAndServeAlgorithm string: The algorithm used by Sign and Serve.
target string: The name of the zone whose configuration this zone will copy.
tsigKey DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:
type string: Whether the zone is primary, secondary, or alias.
versionId string
zone string: The 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: A free form identifier for the zone.
group str: The currently selected group ID.
masters Sequence[str]: The names or IP addresses of the nameservers that the zone data should be retrieved from.
sign_and_serve bool: Whether DNSSEC Sign and Serve is enabled.
sign_and_serve_algorithm str: The algorithm used by Sign and Serve.
target str: The name of the zone whose configuration this zone will copy.
tsig_key DnsZoneTsigKeyArgs: The TSIG Key used in secure zone transfers. If used, requires these arguments:
type str: Whether the zone is primary, secondary, or alias.
version_id str
zone str: The domain zone, encapsulating any nested subdomains.

activationState String
aliasCount Number
comment String: A descriptive comment.
contract String: The contract ID.
endCustomerId String: A free form identifier for the zone.
group String: The currently selected group ID.
masters List<String>: The names or IP addresses of the nameservers that the zone data should be retrieved from.
signAndServe Boolean: Whether DNSSEC Sign and Serve is enabled.
signAndServeAlgorithm String: The algorithm used by Sign and Serve.
target String: The name of the zone whose configuration this zone will copy.
tsigKey Property Map: The TSIG Key used in secure zone transfers. If used, requires these arguments:
type String: Whether the zone is primary, secondary, or alias.
versionId String
zone String: The domain zone, encapsulating any nested subdomains.

Supporting Types

DnsZoneTsigKey

Algorithm string: The hashing algorithm.
Name string: The key name.
Secret string: String known between transfer endpoints.

Algorithm string: The hashing algorithm.
Name string: The key name.
Secret string: String known between transfer endpoints.

algorithm String: The hashing algorithm.
name String: The key name.
secret String: String known between transfer endpoints.

algorithm string: The hashing algorithm.
name string: The key name.
secret string: String known between transfer endpoints.

algorithm str: The hashing algorithm.
name str: The key name.
secret str: String known between transfer endpoints.

algorithm String: The hashing algorithm.
name String: The key name.
secret String: String known between transfer endpoints.

Package Details

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