Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyDnsForwarderZone
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyDnsForwarderZone

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyDnsForwarderZone Resource

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

    Constructor syntax

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

@overload
def PolicyDnsForwarderZone(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           display_name: Optional[str] = None,
                           upstream_servers: Optional[Sequence[str]] = None,
                           context: Optional[PolicyDnsForwarderZoneContextArgs] = None,
                           description: Optional[str] = None,
                           dns_domain_names: Optional[Sequence[str]] = None,
                           nsx_id: Optional[str] = None,
                           policy_dns_forwarder_zone_id: Optional[str] = None,
                           source_ip: Optional[str] = None,
                           tags: Optional[Sequence[PolicyDnsForwarderZoneTagArgs]] = None)
    func NewPolicyDnsForwarderZone(ctx *Context, name string, args PolicyDnsForwarderZoneArgs, opts ...ResourceOption) (*PolicyDnsForwarderZone, error)
    public PolicyDnsForwarderZone(string name, PolicyDnsForwarderZoneArgs args, CustomResourceOptions? opts = null)
    public PolicyDnsForwarderZone(String name, PolicyDnsForwarderZoneArgs args)
public PolicyDnsForwarderZone(String name, PolicyDnsForwarderZoneArgs args, CustomResourceOptions options)

    type: nsxt:PolicyDnsForwarderZone
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 PolicyDnsForwarderZoneArgs
    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 PolicyDnsForwarderZoneArgs
    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 PolicyDnsForwarderZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyDnsForwarderZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyDnsForwarderZoneArgs
    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 policyDnsForwarderZoneResource = new Nsxt.PolicyDnsForwarderZone("policyDnsForwarderZoneResource", new()
{
    DisplayName = "string",
    UpstreamServers = new[]
    {
        "string",
    },
    Context = new Nsxt.Inputs.PolicyDnsForwarderZoneContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    DnsDomainNames = new[]
    {
        "string",
    },
    NsxId = "string",
    PolicyDnsForwarderZoneId = "string",
    SourceIp = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyDnsForwarderZoneTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyDnsForwarderZone(ctx, "policyDnsForwarderZoneResource", &nsxt.PolicyDnsForwarderZoneArgs{
	DisplayName: pulumi.String("string"),
	UpstreamServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Context: &nsxt.PolicyDnsForwarderZoneContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DnsDomainNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	NsxId:                    pulumi.String("string"),
	PolicyDnsForwarderZoneId: pulumi.String("string"),
	SourceIp:                 pulumi.String("string"),
	Tags: nsxt.PolicyDnsForwarderZoneTagArray{
		&nsxt.PolicyDnsForwarderZoneTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyDnsForwarderZoneResource = new PolicyDnsForwarderZone("policyDnsForwarderZoneResource", PolicyDnsForwarderZoneArgs.builder()
    .displayName("string")
    .upstreamServers("string")
    .context(PolicyDnsForwarderZoneContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .dnsDomainNames("string")
    .nsxId("string")
    .policyDnsForwarderZoneId("string")
    .sourceIp("string")
    .tags(PolicyDnsForwarderZoneTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_dns_forwarder_zone_resource = nsxt.PolicyDnsForwarderZone("policyDnsForwarderZoneResource",
    display_name="string",
    upstream_servers=["string"],
    context={
        "project_id": "string",
    },
    description="string",
    dns_domain_names=["string"],
    nsx_id="string",
    policy_dns_forwarder_zone_id="string",
    source_ip="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyDnsForwarderZoneResource = new nsxt.PolicyDnsForwarderZone("policyDnsForwarderZoneResource", {
    displayName: "string",
    upstreamServers: ["string"],
    context: {
        projectId: "string",
    },
    description: "string",
    dnsDomainNames: ["string"],
    nsxId: "string",
    policyDnsForwarderZoneId: "string",
    sourceIp: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyDnsForwarderZone
properties:
    context:
        projectId: string
    description: string
    displayName: string
    dnsDomainNames:
        - string
    nsxId: string
    policyDnsForwarderZoneId: string
    sourceIp: string
    tags:
        - scope: string
          tag: string
    upstreamServers:
        - string

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

    DisplayName string
    Display name of the resource.
    UpstreamServers List<string>
    List of server IP addresses for this Forwarder Zone.
    Context PolicyDnsForwarderZoneContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DnsDomainNames List<string>
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyDnsForwarderZoneId string
    ID of the resource.
    SourceIp string
    The source IP address used by the DNS Forwarder zone.
    Tags List<PolicyDnsForwarderZoneTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    UpstreamServers []string
    List of server IP addresses for this Forwarder Zone.
    Context PolicyDnsForwarderZoneContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DnsDomainNames []string
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyDnsForwarderZoneId string
    ID of the resource.
    SourceIp string
    The source IP address used by the DNS Forwarder zone.
    Tags []PolicyDnsForwarderZoneTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    upstreamServers List<String>
    List of server IP addresses for this Forwarder Zone.
    context PolicyDnsForwarderZoneContext
    The context which the object belongs to
    description String
    Description of the resource.
    dnsDomainNames List<String>
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyDnsForwarderZoneId String
    ID of the resource.
    sourceIp String
    The source IP address used by the DNS Forwarder zone.
    tags List<PolicyDnsForwarderZoneTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    upstreamServers string[]
    List of server IP addresses for this Forwarder Zone.
    context PolicyDnsForwarderZoneContext
    The context which the object belongs to
    description string
    Description of the resource.
    dnsDomainNames string[]
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyDnsForwarderZoneId string
    ID of the resource.
    sourceIp string
    The source IP address used by the DNS Forwarder zone.
    tags PolicyDnsForwarderZoneTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    upstream_servers Sequence[str]
    List of server IP addresses for this Forwarder Zone.
    context PolicyDnsForwarderZoneContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    dns_domain_names Sequence[str]
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_dns_forwarder_zone_id str
    ID of the resource.
    source_ip str
    The source IP address used by the DNS Forwarder zone.
    tags Sequence[PolicyDnsForwarderZoneTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    upstreamServers List<String>
    List of server IP addresses for this Forwarder Zone.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    dnsDomainNames List<String>
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyDnsForwarderZoneId String
    ID of the resource.
    sourceIp String
    The source IP address used by the DNS Forwarder zone.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyDnsForwarderZone Resource

    Get an existing PolicyDnsForwarderZone 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?: PolicyDnsForwarderZoneState, opts?: CustomResourceOptions): PolicyDnsForwarderZone
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[PolicyDnsForwarderZoneContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        dns_domain_names: Optional[Sequence[str]] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_dns_forwarder_zone_id: Optional[str] = None,
        revision: Optional[float] = None,
        source_ip: Optional[str] = None,
        tags: Optional[Sequence[PolicyDnsForwarderZoneTagArgs]] = None,
        upstream_servers: Optional[Sequence[str]] = None) -> PolicyDnsForwarderZone
    func GetPolicyDnsForwarderZone(ctx *Context, name string, id IDInput, state *PolicyDnsForwarderZoneState, opts ...ResourceOption) (*PolicyDnsForwarderZone, error)
    public static PolicyDnsForwarderZone Get(string name, Input<string> id, PolicyDnsForwarderZoneState? state, CustomResourceOptions? opts = null)
    public static PolicyDnsForwarderZone get(String name, Output<String> id, PolicyDnsForwarderZoneState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyDnsForwarderZone    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:
    Context PolicyDnsForwarderZoneContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    DnsDomainNames List<string>
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyDnsForwarderZoneId string
    ID of the resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    SourceIp string
    The source IP address used by the DNS Forwarder zone.
    Tags List<PolicyDnsForwarderZoneTag>
    A list of scope + tag pairs to associate with this resource.
    UpstreamServers List<string>
    List of server IP addresses for this Forwarder Zone.
    Context PolicyDnsForwarderZoneContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    DnsDomainNames []string
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyDnsForwarderZoneId string
    ID of the resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    SourceIp string
    The source IP address used by the DNS Forwarder zone.
    Tags []PolicyDnsForwarderZoneTagArgs
    A list of scope + tag pairs to associate with this resource.
    UpstreamServers []string
    List of server IP addresses for this Forwarder Zone.
    context PolicyDnsForwarderZoneContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    dnsDomainNames List<String>
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyDnsForwarderZoneId String
    ID of the resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sourceIp String
    The source IP address used by the DNS Forwarder zone.
    tags List<PolicyDnsForwarderZoneTag>
    A list of scope + tag pairs to associate with this resource.
    upstreamServers List<String>
    List of server IP addresses for this Forwarder Zone.
    context PolicyDnsForwarderZoneContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    dnsDomainNames string[]
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the policy resource.
    policyDnsForwarderZoneId string
    ID of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sourceIp string
    The source IP address used by the DNS Forwarder zone.
    tags PolicyDnsForwarderZoneTag[]
    A list of scope + tag pairs to associate with this resource.
    upstreamServers string[]
    List of server IP addresses for this Forwarder Zone.
    context PolicyDnsForwarderZoneContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    dns_domain_names Sequence[str]
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the policy resource.
    policy_dns_forwarder_zone_id str
    ID of the resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    source_ip str
    The source IP address used by the DNS Forwarder zone.
    tags Sequence[PolicyDnsForwarderZoneTagArgs]
    A list of scope + tag pairs to associate with this resource.
    upstream_servers Sequence[str]
    List of server IP addresses for this Forwarder Zone.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    dnsDomainNames List<String>
    For conditional (FQDN) zones, a list of domains. For Default Forwarder Zone, this attribute should not be specified.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyDnsForwarderZoneId String
    ID of the resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sourceIp String
    The source IP address used by the DNS Forwarder zone.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    upstreamServers List<String>
    List of server IP addresses for this Forwarder Zone.

    Supporting Types

    PolicyDnsForwarderZoneContext, PolicyDnsForwarderZoneContextArgs

    ProjectId string
    The ID of the project which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to

    PolicyDnsForwarderZoneTag, PolicyDnsForwarderZoneTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt