1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dns
  5. dns/v1
  6. getPolicy

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.dns/v1.getPolicy

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Fetches the representation of an existing Policy.

    Using getPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPolicy(args: GetPolicyArgs, opts?: InvokeOptions): Promise<GetPolicyResult>
    function getPolicyOutput(args: GetPolicyOutputArgs, opts?: InvokeOptions): Output<GetPolicyResult>
    def get_policy(client_operation_id: Optional[str] = None,
                   policy: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPolicyResult
    def get_policy_output(client_operation_id: Optional[pulumi.Input[str]] = None,
                   policy: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPolicyResult]
    func LookupPolicy(ctx *Context, args *LookupPolicyArgs, opts ...InvokeOption) (*LookupPolicyResult, error)
    func LookupPolicyOutput(ctx *Context, args *LookupPolicyOutputArgs, opts ...InvokeOption) LookupPolicyResultOutput

    > Note: This function is named LookupPolicy in the Go SDK.

    public static class GetPolicy 
    {
        public static Task<GetPolicyResult> InvokeAsync(GetPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyResult> Invoke(GetPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:dns/v1:getPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Policy string
    ClientOperationId string
    Project string
    Policy string
    ClientOperationId string
    Project string
    policy String
    clientOperationId String
    project String
    policy string
    clientOperationId string
    project string
    policy String
    clientOperationId String
    project String

    getPolicy Result

    The following output properties are available:

    AlternativeNameServerConfig Pulumi.GoogleNative.DNS.V1.Outputs.PolicyAlternativeNameServerConfigResponse
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    Description string
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    EnableInboundForwarding bool
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    EnableLogging bool
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    Kind string
    Name string
    User-assigned name for this policy.
    Networks List<Pulumi.GoogleNative.DNS.V1.Outputs.PolicyNetworkResponse>
    List of network names specifying networks to which this policy is applied.
    AlternativeNameServerConfig PolicyAlternativeNameServerConfigResponse
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    Description string
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    EnableInboundForwarding bool
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    EnableLogging bool
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    Kind string
    Name string
    User-assigned name for this policy.
    Networks []PolicyNetworkResponse
    List of network names specifying networks to which this policy is applied.
    alternativeNameServerConfig PolicyAlternativeNameServerConfigResponse
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    description String
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    enableInboundForwarding Boolean
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    enableLogging Boolean
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    kind String
    name String
    User-assigned name for this policy.
    networks List<PolicyNetworkResponse>
    List of network names specifying networks to which this policy is applied.
    alternativeNameServerConfig PolicyAlternativeNameServerConfigResponse
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    description string
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    enableInboundForwarding boolean
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    enableLogging boolean
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    kind string
    name string
    User-assigned name for this policy.
    networks PolicyNetworkResponse[]
    List of network names specifying networks to which this policy is applied.
    alternative_name_server_config PolicyAlternativeNameServerConfigResponse
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    description str
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    enable_inbound_forwarding bool
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    enable_logging bool
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    kind str
    name str
    User-assigned name for this policy.
    networks Sequence[PolicyNetworkResponse]
    List of network names specifying networks to which this policy is applied.
    alternativeNameServerConfig Property Map
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    description String
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    enableInboundForwarding Boolean
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    enableLogging Boolean
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    kind String
    name String
    User-assigned name for this policy.
    networks List<Property Map>
    List of network names specifying networks to which this policy is applied.

    Supporting Types

    PolicyAlternativeNameServerConfigResponse

    Kind string
    TargetNameServers List<Pulumi.GoogleNative.DNS.V1.Inputs.PolicyAlternativeNameServerConfigTargetNameServerResponse>
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    Kind string
    TargetNameServers []PolicyAlternativeNameServerConfigTargetNameServerResponse
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    kind String
    targetNameServers List<PolicyAlternativeNameServerConfigTargetNameServerResponse>
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    kind string
    targetNameServers PolicyAlternativeNameServerConfigTargetNameServerResponse[]
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    kind str
    target_name_servers Sequence[PolicyAlternativeNameServerConfigTargetNameServerResponse]
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    kind String
    targetNameServers List<Property Map>
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.

    PolicyAlternativeNameServerConfigTargetNameServerResponse

    ForwardingPath string
    Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
    Ipv4Address string
    IPv4 address to forward queries to.
    Ipv6Address string
    IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
    Kind string
    ForwardingPath string
    Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
    Ipv4Address string
    IPv4 address to forward queries to.
    Ipv6Address string
    IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
    Kind string
    forwardingPath String
    Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
    ipv4Address String
    IPv4 address to forward queries to.
    ipv6Address String
    IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
    kind String
    forwardingPath string
    Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
    ipv4Address string
    IPv4 address to forward queries to.
    ipv6Address string
    IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
    kind string
    forwarding_path str
    Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
    ipv4_address str
    IPv4 address to forward queries to.
    ipv6_address str
    IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
    kind str
    forwardingPath String
    Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
    ipv4Address String
    IPv4 address to forward queries to.
    ipv6Address String
    IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
    kind String

    PolicyNetworkResponse

    Kind string
    NetworkUrl string
    The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
    Kind string
    NetworkUrl string
    The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
    kind String
    networkUrl String
    The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
    kind string
    networkUrl string
    The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
    kind str
    network_url str
    The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
    kind String
    networkUrl String
    The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi