@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
103 lines • 3.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Gets information about a Apple Silicon operating system.
* For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/apple-silicon/#path-os-list-all-operating-systems-os).
*
* You can also use the [scaleway-cli](https://github.com/scaleway/scaleway-cli) with `scw apple-silicon os list` to list all available operating systems.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by os name and version
* const byName = scaleway.applesilicon.getOs({
* name: "devos-sequoia-15.6",
* });
* // Get info by os id
* const byId = scaleway.applesilicon.getOs({
* osId: "cafecafe-5018-4dcd-bd08-35f031b0ac3e",
* });
* ```
*/
export declare function getOs(args?: GetOsArgs, opts?: pulumi.InvokeOptions): Promise<GetOsResult>;
/**
* A collection of arguments for invoking getOs.
*/
export interface GetOsArgs {
/**
* The os name. Only one of `name` and `osId` should be specified.
*/
name?: string;
/**
* The operating system id. Only one of `name` and `osId` should be specified.
*/
osId?: string;
/**
* The os version.
*/
version?: string;
/**
* `zone`) The zone in which the os exists.
*/
zone?: string;
}
/**
* A collection of values returned by getOs.
*/
export interface GetOsResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name?: string;
readonly osId?: string;
readonly version: string;
readonly zone?: string;
}
/**
* Gets information about a Apple Silicon operating system.
* For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/apple-silicon/#path-os-list-all-operating-systems-os).
*
* You can also use the [scaleway-cli](https://github.com/scaleway/scaleway-cli) with `scw apple-silicon os list` to list all available operating systems.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by os name and version
* const byName = scaleway.applesilicon.getOs({
* name: "devos-sequoia-15.6",
* });
* // Get info by os id
* const byId = scaleway.applesilicon.getOs({
* osId: "cafecafe-5018-4dcd-bd08-35f031b0ac3e",
* });
* ```
*/
export declare function getOsOutput(args?: GetOsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetOsResult>;
/**
* A collection of arguments for invoking getOs.
*/
export interface GetOsOutputArgs {
/**
* The os name. Only one of `name` and `osId` should be specified.
*/
name?: pulumi.Input<string | undefined>;
/**
* The operating system id. Only one of `name` and `osId` should be specified.
*/
osId?: pulumi.Input<string | undefined>;
/**
* The os version.
*/
version?: pulumi.Input<string | undefined>;
/**
* `zone`) The zone in which the os exists.
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getOs.d.ts.map