@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
260 lines • 10.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A policy is a collection of DNS rules applied to one or more Virtual
* Private Cloud resources.
*
* To get more information about Policy, see:
*
* * [API documentation](https://cloud.google.com/dns/docs/reference/v1beta2/policies)
* * How-to Guides
* * [Using DNS server policies](https://cloud.google.com/dns/zones/#using-dns-server-policies)
*
* ## Example Usage
*
* ### Dns Policy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const network_1 = new gcp.compute.Network("network-1", {
* name: "network-1",
* autoCreateSubnetworks: false,
* });
* const network_2 = new gcp.compute.Network("network-2", {
* name: "network-2",
* autoCreateSubnetworks: false,
* });
* const example_policy = new gcp.dns.Policy("example-policy", {
* name: "example-policy",
* enableInboundForwarding: true,
* enableLogging: true,
* alternativeNameServerConfig: {
* targetNameServers: [
* {
* ipv4Address: "172.16.1.10",
* forwardingPath: "private",
* },
* {
* ipv4Address: "172.16.1.20",
* },
* ],
* },
* networks: [
* {
* networkUrl: network_1.id,
* },
* {
* networkUrl: network_2.id,
* },
* ],
* });
* ```
*
* ## Import
*
* Policy can be imported using any of these accepted formats:
*
* * `projects/{{project}}/policies/{{name}}`
* * `{{project}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, Policy can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dns/policy:Policy default projects/{{project}}/policies/{{name}}
* $ pulumi import gcp:dns/policy:Policy default {{project}}/{{name}}
* $ pulumi import gcp:dns/policy:Policy default {{name}}
* ```
*/
export declare class Policy extends pulumi.CustomResource {
/**
* Get an existing Policy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PolicyState, opts?: pulumi.CustomResourceOptions): Policy;
/**
* Returns true if the given object is an instance of Policy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Policy;
/**
* 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.
* Structure is documented below.
*/
readonly alternativeNameServerConfig: pulumi.Output<outputs.dns.PolicyAlternativeNameServerConfig | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* A textual description field. Defaults to 'Managed by Pulumi'.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Configurations related to DNS64 for this Policy.
* Structure is documented below.
*/
readonly dns64Config: pulumi.Output<outputs.dns.PolicyDns64Config>;
/**
* Allows networks bound to this policy to receive DNS queries sent
* by VMs or applications over VPN connections. When enabled, a
* virtual IP address will be allocated from each of the sub-networks
* that are bound to this policy.
*/
readonly enableInboundForwarding: pulumi.Output<boolean | undefined>;
/**
* Controls whether logging is enabled for the networks bound to this policy.
* Defaults to no logging if not set.
*/
readonly enableLogging: pulumi.Output<boolean | undefined>;
/**
* User assigned name for this policy.
*/
readonly name: pulumi.Output<string>;
/**
* List of network names specifying networks to which this policy is applied.
* Structure is documented below.
*/
readonly networks: pulumi.Output<outputs.dns.PolicyNetwork[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Create a Policy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: PolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Policy resources.
*/
export interface PolicyState {
/**
* 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.
* Structure is documented below.
*/
alternativeNameServerConfig?: pulumi.Input<inputs.dns.PolicyAlternativeNameServerConfig | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A textual description field. Defaults to 'Managed by Pulumi'.
*/
description?: pulumi.Input<string | undefined>;
/**
* Configurations related to DNS64 for this Policy.
* Structure is documented below.
*/
dns64Config?: pulumi.Input<inputs.dns.PolicyDns64Config | undefined>;
/**
* Allows networks bound to this policy to receive DNS queries sent
* by VMs or applications over VPN connections. When enabled, a
* virtual IP address will be allocated from each of the sub-networks
* that are bound to this policy.
*/
enableInboundForwarding?: pulumi.Input<boolean | undefined>;
/**
* Controls whether logging is enabled for the networks bound to this policy.
* Defaults to no logging if not set.
*/
enableLogging?: pulumi.Input<boolean | undefined>;
/**
* User assigned name for this policy.
*/
name?: pulumi.Input<string | undefined>;
/**
* List of network names specifying networks to which this policy is applied.
* Structure is documented below.
*/
networks?: pulumi.Input<pulumi.Input<inputs.dns.PolicyNetwork>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Policy resource.
*/
export interface PolicyArgs {
/**
* 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.
* Structure is documented below.
*/
alternativeNameServerConfig?: pulumi.Input<inputs.dns.PolicyAlternativeNameServerConfig | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A textual description field. Defaults to 'Managed by Pulumi'.
*/
description?: pulumi.Input<string | undefined>;
/**
* Configurations related to DNS64 for this Policy.
* Structure is documented below.
*/
dns64Config?: pulumi.Input<inputs.dns.PolicyDns64Config | undefined>;
/**
* Allows networks bound to this policy to receive DNS queries sent
* by VMs or applications over VPN connections. When enabled, a
* virtual IP address will be allocated from each of the sub-networks
* that are bound to this policy.
*/
enableInboundForwarding?: pulumi.Input<boolean | undefined>;
/**
* Controls whether logging is enabled for the networks bound to this policy.
* Defaults to no logging if not set.
*/
enableLogging?: pulumi.Input<boolean | undefined>;
/**
* User assigned name for this policy.
*/
name?: pulumi.Input<string | undefined>;
/**
* List of network names specifying networks to which this policy is applied.
* Structure is documented below.
*/
networks?: pulumi.Input<pulumi.Input<inputs.dns.PolicyNetwork>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=policy.d.ts.map