1. Packages
  2. Akamai
  3. API Docs
  4. DnsZone
Akamai v7.0.0 published on Monday, Apr 8, 2024 by Pulumi

akamai.DnsZone

Explore with Pulumi AI

akamai logo
Akamai v7.0.0 published on Monday, Apr 8, 2024 by Pulumi

    Create DnsZone Resource

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

    Constructor syntax

    new DnsZone(name: string, args: DnsZoneArgs, opts?: CustomResourceOptions);
    @overload
    def DnsZone(resource_name: str,
                args: DnsZoneArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def DnsZone(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                contract: Optional[str] = None,
                type: Optional[str] = None,
                zone: Optional[str] = None,
                comment: 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)
    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:DnsZone
    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 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.

    Example

    The following reference example uses placeholder values for all input properties.

    var dnsZoneResource = new Akamai.DnsZone("dnsZoneResource", new()
    {
        Contract = "string",
        Type = "string",
        Zone = "string",
        Comment = "string",
        EndCustomerId = "string",
        Group = "string",
        Masters = new[]
        {
            "string",
        },
        SignAndServe = false,
        SignAndServeAlgorithm = "string",
        Target = "string",
        TsigKey = new Akamai.Inputs.DnsZoneTsigKeyArgs
        {
            Algorithm = "string",
            Name = "string",
            Secret = "string",
        },
    });
    
    example, err := akamai.NewDnsZone(ctx, "dnsZoneResource", &akamai.DnsZoneArgs{
    	Contract:      pulumi.String("string"),
    	Type:          pulumi.String("string"),
    	Zone:          pulumi.String("string"),
    	Comment:       pulumi.String("string"),
    	EndCustomerId: pulumi.String("string"),
    	Group:         pulumi.String("string"),
    	Masters: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SignAndServe:          pulumi.Bool(false),
    	SignAndServeAlgorithm: pulumi.String("string"),
    	Target:                pulumi.String("string"),
    	TsigKey: &akamai.DnsZoneTsigKeyArgs{
    		Algorithm: pulumi.String("string"),
    		Name:      pulumi.String("string"),
    		Secret:    pulumi.String("string"),
    	},
    })
    
    var dnsZoneResource = new DnsZone("dnsZoneResource", DnsZoneArgs.builder()        
        .contract("string")
        .type("string")
        .zone("string")
        .comment("string")
        .endCustomerId("string")
        .group("string")
        .masters("string")
        .signAndServe(false)
        .signAndServeAlgorithm("string")
        .target("string")
        .tsigKey(DnsZoneTsigKeyArgs.builder()
            .algorithm("string")
            .name("string")
            .secret("string")
            .build())
        .build());
    
    dns_zone_resource = akamai.DnsZone("dnsZoneResource",
        contract="string",
        type="string",
        zone="string",
        comment="string",
        end_customer_id="string",
        group="string",
        masters=["string"],
        sign_and_serve=False,
        sign_and_serve_algorithm="string",
        target="string",
        tsig_key=akamai.DnsZoneTsigKeyArgs(
            algorithm="string",
            name="string",
            secret="string",
        ))
    
    const dnsZoneResource = new akamai.DnsZone("dnsZoneResource", {
        contract: "string",
        type: "string",
        zone: "string",
        comment: "string",
        endCustomerId: "string",
        group: "string",
        masters: ["string"],
        signAndServe: false,
        signAndServeAlgorithm: "string",
        target: "string",
        tsigKey: {
            algorithm: "string",
            name: "string",
            secret: "string",
        },
    });
    
    type: akamai:DnsZone
    properties:
        comment: string
        contract: string
        endCustomerId: string
        group: string
        masters:
            - string
        signAndServe: false
        signAndServeAlgorithm: string
        target: string
        tsigKey:
            algorithm: string
            name: string
            secret: string
        type: string
        zone: string
    

    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
    Type string
    Zone string
    Comment string
    EndCustomerId string
    Group string
    Masters List<string>
    SignAndServe bool
    SignAndServeAlgorithm string
    Target string
    TsigKey DnsZoneTsigKey
    contract String
    type String
    zone String
    comment String
    endCustomerId String
    group String
    masters List<String>
    signAndServe Boolean
    signAndServeAlgorithm String
    target String
    tsigKey DnsZoneTsigKey
    contract string
    type string
    zone string
    comment string
    endCustomerId string
    group string
    masters string[]
    signAndServe boolean
    signAndServeAlgorithm string
    target string
    tsigKey DnsZoneTsigKey
    contract String
    type String
    zone String
    comment String
    endCustomerId String
    group String
    masters List<String>
    signAndServe Boolean
    signAndServeAlgorithm String
    target String
    tsigKey Property Map

    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 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 Integer
    comment String
    contract String
    endCustomerId String
    group String
    masters List<String>
    signAndServe Boolean
    signAndServeAlgorithm String
    target String
    tsigKey DnsZoneTsigKey
    type String
    versionId String
    zone String
    activationState string
    aliasCount number
    comment string
    contract string
    endCustomerId string
    group string
    masters string[]
    signAndServe boolean
    signAndServeAlgorithm string
    target string
    tsigKey DnsZoneTsigKey
    type string
    versionId string
    zone string
    activationState String
    aliasCount Number
    comment String
    contract String
    endCustomerId String
    group String
    masters List<String>
    signAndServe Boolean
    signAndServeAlgorithm String
    target String
    tsigKey Property Map
    type String
    versionId String
    zone String

    Supporting Types

    DnsZoneTsigKey, DnsZoneTsigKeyArgs

    Algorithm string
    Name string
    Secret string
    Algorithm string
    Name string
    Secret string
    algorithm String
    name String
    secret String
    algorithm string
    name string
    secret string
    algorithm String
    name String
    secret String

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.0.0 published on Monday, Apr 8, 2024 by Pulumi