@pulumiverse/cpln
Version:
A Pulumi package for creating and managing Control Plane (cpln) resources.
139 lines (138 loc) • 4.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class Location extends pulumi.CustomResource {
/**
* Get an existing Location 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?: LocationState, opts?: pulumi.CustomResourceOptions): Location;
/**
* Returns true if the given object is an instance of Location. 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 Location;
/**
* Cloud Provider of the location. Valid values: `aws`, `gcp`, `azure`, `byok`, `linode`, `vultr`, `equinix`, `oci`.
*/
readonly cloudProvider: pulumi.Output<string>;
/**
* The ID, in GUID format, of the location.
*/
readonly cplnId: pulumi.Output<string>;
/**
* Description of the location.
*/
readonly description: pulumi.Output<string>;
/**
* Indication if location is enabled.
*/
readonly enabled: pulumi.Output<boolean>;
readonly geos: pulumi.Output<outputs.LocationGeo[]>;
/**
* A list of IP ranges of the location.
*/
readonly ipRanges: pulumi.Output<string[]>;
/**
* Name of the location.
*/
readonly name: pulumi.Output<string>;
/**
* Origin of the location. Valid values: `builtin`, `default`, `custom`.
*/
readonly origin: pulumi.Output<string>;
/**
* Region of the location.
*/
readonly region: pulumi.Output<string>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Key-value map of resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Location 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: LocationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Location resources.
*/
export interface LocationState {
/**
* Cloud Provider of the location. Valid values: `aws`, `gcp`, `azure`, `byok`, `linode`, `vultr`, `equinix`, `oci`.
*/
cloudProvider?: pulumi.Input<string>;
/**
* The ID, in GUID format, of the location.
*/
cplnId?: pulumi.Input<string>;
/**
* Description of the location.
*/
description?: pulumi.Input<string>;
/**
* Indication if location is enabled.
*/
enabled?: pulumi.Input<boolean>;
geos?: pulumi.Input<pulumi.Input<inputs.LocationGeo>[]>;
/**
* A list of IP ranges of the location.
*/
ipRanges?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the location.
*/
name?: pulumi.Input<string>;
/**
* Origin of the location. Valid values: `builtin`, `default`, `custom`.
*/
origin?: pulumi.Input<string>;
/**
* Region of the location.
*/
region?: pulumi.Input<string>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
selfLink?: pulumi.Input<string>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Location resource.
*/
export interface LocationArgs {
/**
* Indication if location is enabled.
*/
enabled: pulumi.Input<boolean>;
/**
* Name of the location.
*/
name?: pulumi.Input<string>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}