@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
224 lines (223 loc) • 8.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Represents a PublicAdvertisedPrefix for use with bring your own IP addresses (BYOIP).
*
* To get more information about PublicAdvertisedPrefix, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/publicAdvertisedPrefixes)
* * How-to Guides
* * [Using bring your own IP](https://cloud.google.com/vpc/docs/using-bring-your-own-ip)
*
* ## Example Usage
*
* ### Public Advertised Prefixes Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const prefixes = new gcp.compute.PublicAdvertisedPrefix("prefixes", {
* name: "my-prefix",
* description: "description",
* dnsVerificationIp: "127.127.0.0",
* ipCidrRange: "127.127.0.0/16",
* });
* ```
* ### Public Advertised Prefixes Pdp Scope
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const prefixes = new gcp.compute.PublicAdvertisedPrefix("prefixes", {
* name: "my-pap",
* description: "description",
* dnsVerificationIp: "127.127.0.0",
* ipCidrRange: "127.127.0.0/16",
* pdpScope: "REGIONAL",
* });
* ```
*
* ## Import
*
* PublicAdvertisedPrefix can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/publicAdvertisedPrefixes/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, PublicAdvertisedPrefix can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/publicAdvertisedPrefix:PublicAdvertisedPrefix default projects/{{project}}/global/publicAdvertisedPrefixes/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/publicAdvertisedPrefix:PublicAdvertisedPrefix default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/publicAdvertisedPrefix:PublicAdvertisedPrefix default {{name}}
* ```
*/
export declare class PublicAdvertisedPrefix extends pulumi.CustomResource {
/**
* Get an existing PublicAdvertisedPrefix 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?: PublicAdvertisedPrefixState, opts?: pulumi.CustomResourceOptions): PublicAdvertisedPrefix;
/**
* Returns true if the given object is an instance of PublicAdvertisedPrefix. 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 PublicAdvertisedPrefix;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The IPv4 address to be used for reverse DNS verification.
*/
readonly dnsVerificationIp: pulumi.Output<string>;
/**
* The address range, in CIDR format, represented by this public advertised prefix.
*/
readonly ipCidrRange: pulumi.Output<string>;
/**
* Name of the resource. The name must be 1-63 characters long, and
* comply with RFC1035. Specifically, the name must be 1-63 characters
* long and match the regular expression `a-z?`
* which means the first character must be a lowercase letter, and all
* following characters must be a dash, lowercase letter, or digit,
* except the last character, which cannot be a dash.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies how child public delegated prefix will be scoped. pdpScope
* must be one of: GLOBAL, REGIONAL
* * REGIONAL: The public delegated prefix is regional only. The
* provisioning will take a few minutes.
* * GLOBAL: The public delegated prefix is global only. The provisioning
* will take ~4 weeks.
* Possible values are: `GLOBAL`, `REGIONAL`.
*/
readonly pdpScope: pulumi.Output<string | 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>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Output Only. The shared secret to be used for reverse DNS verification.
*/
readonly sharedSecret: pulumi.Output<string>;
/**
* Create a PublicAdvertisedPrefix 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: PublicAdvertisedPrefixArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PublicAdvertisedPrefix resources.
*/
export interface PublicAdvertisedPrefixState {
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* The IPv4 address to be used for reverse DNS verification.
*/
dnsVerificationIp?: pulumi.Input<string>;
/**
* The address range, in CIDR format, represented by this public advertised prefix.
*/
ipCidrRange?: pulumi.Input<string>;
/**
* Name of the resource. The name must be 1-63 characters long, and
* comply with RFC1035. Specifically, the name must be 1-63 characters
* long and match the regular expression `a-z?`
* which means the first character must be a lowercase letter, and all
* following characters must be a dash, lowercase letter, or digit,
* except the last character, which cannot be a dash.
*/
name?: pulumi.Input<string>;
/**
* Specifies how child public delegated prefix will be scoped. pdpScope
* must be one of: GLOBAL, REGIONAL
* * REGIONAL: The public delegated prefix is regional only. The
* provisioning will take a few minutes.
* * GLOBAL: The public delegated prefix is global only. The provisioning
* will take ~4 weeks.
* Possible values are: `GLOBAL`, `REGIONAL`.
*/
pdpScope?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
/**
* Output Only. The shared secret to be used for reverse DNS verification.
*/
sharedSecret?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PublicAdvertisedPrefix resource.
*/
export interface PublicAdvertisedPrefixArgs {
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* The IPv4 address to be used for reverse DNS verification.
*/
dnsVerificationIp: pulumi.Input<string>;
/**
* The address range, in CIDR format, represented by this public advertised prefix.
*/
ipCidrRange: pulumi.Input<string>;
/**
* Name of the resource. The name must be 1-63 characters long, and
* comply with RFC1035. Specifically, the name must be 1-63 characters
* long and match the regular expression `a-z?`
* which means the first character must be a lowercase letter, and all
* following characters must be a dash, lowercase letter, or digit,
* except the last character, which cannot be a dash.
*/
name?: pulumi.Input<string>;
/**
* Specifies how child public delegated prefix will be scoped. pdpScope
* must be one of: GLOBAL, REGIONAL
* * REGIONAL: The public delegated prefix is regional only. The
* provisioning will take a few minutes.
* * GLOBAL: The public delegated prefix is global only. The provisioning
* will take ~4 weeks.
* Possible values are: `GLOBAL`, `REGIONAL`.
*/
pdpScope?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}