@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
116 lines (115 loc) • 3.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Get information on a DigitalOcean App.
*
* ## Example Usage
*
* Get the account:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getApp({
* appId: "e665d18d-7b56-44a9-92ce-31979174d544",
* });
* export const defaultIngress = example.then(example => example.defaultIngress);
* ```
*/
export declare function getApp(args: GetAppArgs, opts?: pulumi.InvokeOptions): Promise<GetAppResult>;
/**
* A collection of arguments for invoking getApp.
*/
export interface GetAppArgs {
/**
* The ID of the app to retrieve information about.
*/
appId: string;
/**
* A list of dedicated egress IP addresses associated with the app.
*/
dedicatedIps?: inputs.GetAppDedicatedIp[];
}
/**
* A collection of values returned by getApp.
*/
export interface GetAppResult {
/**
* The ID the app's currently active deployment.
*/
readonly activeDeploymentId: string;
readonly appId: string;
/**
* The date and time of when the app was created.
*/
readonly createdAt: string;
/**
* A list of dedicated egress IP addresses associated with the app.
*/
readonly dedicatedIps: outputs.GetAppDedicatedIp[];
/**
* The default URL to access the app.
*/
readonly defaultIngress: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The live domain of the app.
*/
readonly liveDomain: string;
/**
* The live URL of the app.
*/
readonly liveUrl: string;
/**
* The ID of the project that the app is assigned to.
*/
readonly projectId: string;
/**
* A DigitalOcean App spec describing the app.
*/
readonly specs: outputs.GetAppSpec[];
/**
* The date and time of when the app was last updated.
*/
readonly updatedAt: string;
/**
* The uniform resource identifier for the app.
*/
readonly urn: string;
}
/**
* Get information on a DigitalOcean App.
*
* ## Example Usage
*
* Get the account:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getApp({
* appId: "e665d18d-7b56-44a9-92ce-31979174d544",
* });
* export const defaultIngress = example.then(example => example.defaultIngress);
* ```
*/
export declare function getAppOutput(args: GetAppOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAppResult>;
/**
* A collection of arguments for invoking getApp.
*/
export interface GetAppOutputArgs {
/**
* The ID of the app to retrieve information about.
*/
appId: pulumi.Input<string>;
/**
* A list of dedicated egress IP addresses associated with the app.
*/
dedicatedIps?: pulumi.Input<pulumi.Input<inputs.GetAppDedicatedIpArgs>[]>;
}