import * as pulumi from "@pulumi/pulumi"; /** * A gateway advertised route is a route that a gateway spoke advertises somewhere. * * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. * See Provider Versions for more details on beta resources. * * To get more information about GatewayAdvertisedRoute, see: * * * [API documentation](https://docs.cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest/v1beta/projects.locations.spokes.gatewayAdvertisedRoutes) * * How-to Guides * * [QUICKSTART_TITLE](https://docs.cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/ncc-gateway-overview) * * ## Example Usage * * ### Network Connectivity Gateway Advertised Route Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const network = new gcp.compute.Network("network", { * name: "net-spoke", * autoCreateSubnetworks: false, * }); * const subnetwork = new gcp.compute.Subnetwork("subnetwork", { * name: "tf-test-subnet_26240", * ipCidrRange: "10.0.0.0/28", * region: "us-central1", * network: network.selfLink, * }); * const basicHub = new gcp.networkconnectivity.Hub("basic_hub", { * name: "hub", * description: "A sample hub", * labels: { * "label-two": "value-one", * }, * presetTopology: "HYBRID_INSPECTION", * }); * const primary = new gcp.networkconnectivity.Spoke("primary", { * name: "spoke-name", * location: "us-central1", * description: "A sample spoke of type Gateway", * labels: { * "label-one": "value-one", * }, * hub: basicHub.id, * gateway: { * ipRangeReservations: [{ * ipRange: "10.0.0.0/23", * }], * capacity: "CAPACITY_1_GBPS", * }, * group: "gateways", * }); * const _default = new gcp.networkconnectivity.GatewayAdvertisedRoute("default", { * spoke: primary.name, * location: "us-central1", * name: "gateway-advertised-route-name", * labels: { * "label-one": "value-one", * }, * description: "description of the gateway advertised route", * ipRange: "0.0.0.0/24", * recipient: "ADVERTISE_TO_HUB", * priority: 200, * }); * ``` * * ## Import * * GatewayAdvertisedRoute can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes/{{name}}` * * `{{project}}/{{location}}/{{spoke}}/{{name}}` * * `{{location}}/{{spoke}}/{{name}}` * * When using the `pulumi import` command, GatewayAdvertisedRoute can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:networkconnectivity/gatewayAdvertisedRoute:GatewayAdvertisedRoute default projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes/{{name}} * $ pulumi import gcp:networkconnectivity/gatewayAdvertisedRoute:GatewayAdvertisedRoute default {{project}}/{{location}}/{{spoke}}/{{name}} * $ pulumi import gcp:networkconnectivity/gatewayAdvertisedRoute:GatewayAdvertisedRoute default {{location}}/{{spoke}}/{{name}} * ``` */ export declare class GatewayAdvertisedRoute extends pulumi.CustomResource { /** * Get an existing GatewayAdvertisedRoute 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, state?: GatewayAdvertisedRouteState, opts?: pulumi.CustomResourceOptions): GatewayAdvertisedRoute; /** * Returns true if the given object is an instance of GatewayAdvertisedRoute. 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 GatewayAdvertisedRoute; /** * The time the gateway advertised route was created. */ readonly createTime: pulumi.Output; /** * 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; /** * An optional description of the gateway advertised route. */ readonly description: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * This route's advertised IP address range. Must be a valid CIDR-formatted prefix. * If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128 */ readonly ipRange: pulumi.Output; /** * Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The location for the resource */ readonly location: pulumi.Output; /** * The name of the gateway advertised route. Route names must be unique. */ readonly name: pulumi.Output; /** * The priority of this advertised route. You can choose a value from 0 to 65335. * If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges. */ readonly priority: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * the recipient of this advertised route * Possible values are: `RECIPIENT_UNSPECIFIED`, `ADVERTISE_TO_HUB`. */ readonly recipient: pulumi.Output; /** * The name of the spoke */ readonly spoke: pulumi.Output; /** * The current lifecycle state of this gateway advertised route. */ readonly state: pulumi.Output; /** * The Google-generated UUID for the gateway advertised route. * This value is unique across all gateway advertised route resources. * If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId. */ readonly uniqueId: pulumi.Output; /** * The time the gateway advertised route was last updated. */ readonly updateTime: pulumi.Output; /** * Create a GatewayAdvertisedRoute 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: GatewayAdvertisedRouteArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GatewayAdvertisedRoute resources. */ export interface GatewayAdvertisedRouteState { /** * The time the gateway advertised route was created. */ createTime?: pulumi.Input; /** * 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; /** * An optional description of the gateway advertised route. */ description?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * This route's advertised IP address range. Must be a valid CIDR-formatted prefix. * If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128 */ ipRange?: pulumi.Input; /** * Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The location for the resource */ location?: pulumi.Input; /** * The name of the gateway advertised route. Route names must be unique. */ name?: pulumi.Input; /** * The priority of this advertised route. You can choose a value from 0 to 65335. * If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges. */ priority?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * the recipient of this advertised route * Possible values are: `RECIPIENT_UNSPECIFIED`, `ADVERTISE_TO_HUB`. */ recipient?: pulumi.Input; /** * The name of the spoke */ spoke?: pulumi.Input; /** * The current lifecycle state of this gateway advertised route. */ state?: pulumi.Input; /** * The Google-generated UUID for the gateway advertised route. * This value is unique across all gateway advertised route resources. * If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId. */ uniqueId?: pulumi.Input; /** * The time the gateway advertised route was last updated. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a GatewayAdvertisedRoute resource. */ export interface GatewayAdvertisedRouteArgs { /** * 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; /** * An optional description of the gateway advertised route. */ description?: pulumi.Input; /** * This route's advertised IP address range. Must be a valid CIDR-formatted prefix. * If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128 */ ipRange?: pulumi.Input; /** * Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The location for the resource */ location: pulumi.Input; /** * The name of the gateway advertised route. Route names must be unique. */ name?: pulumi.Input; /** * The priority of this advertised route. You can choose a value from 0 to 65335. * If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges. */ priority?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * the recipient of this advertised route * Possible values are: `RECIPIENT_UNSPECIFIED`, `ADVERTISE_TO_HUB`. */ recipient?: pulumi.Input; /** * The name of the spoke */ spoke: pulumi.Input; } //# sourceMappingURL=gatewayAdvertisedRoute.d.ts.map