@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
159 lines (158 loc) • 4.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Retrieves a listing of config items.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Data source to fetch all external dynamic lists in the "Shared" folder.
* const allSharedEdls = scm.getExternalDynamicListList({
* folder: "All",
* });
* export const allSharedEdlsMap = allSharedEdls.then(allSharedEdls => allSharedEdls.datas);
* // Example of using pagination to get the first 5 EDLs.
* const paginatedEdls = scm.getExternalDynamicListList({
* folder: "All",
* limit: 5,
* offset: 0,
* });
* export const paginatedEdlsDetails = {
* totalInFolder: paginatedEdls.then(paginatedEdls => paginatedEdls.total),
* limitUsed: paginatedEdls.then(paginatedEdls => paginatedEdls.limit),
* offsetUsed: paginatedEdls.then(paginatedEdls => paginatedEdls.offset),
* };
* ```
*/
export declare function getExternalDynamicListList(args?: GetExternalDynamicListListArgs, opts?: pulumi.InvokeOptions): Promise<GetExternalDynamicListListResult>;
/**
* A collection of arguments for invoking getExternalDynamicListList.
*/
export interface GetExternalDynamicListListArgs {
/**
* The device of the item.
*/
device?: string;
/**
* The folder of the item. Default: Shared.
*/
folder?: string;
/**
* The max number of items to return. Default: 200.
*/
limit?: number;
/**
* The name of the item.
*/
name?: string;
/**
* The offset of the first item to return.
*/
offset?: number;
/**
* The snippet of the item.
*/
snippet?: string;
}
/**
* A collection of values returned by getExternalDynamicListList.
*/
export interface GetExternalDynamicListListResult {
/**
* The data.
*/
readonly datas: outputs.GetExternalDynamicListListData[];
/**
* The device of the item.
*/
readonly device?: string;
/**
* The folder of the item. Default: Shared.
*/
readonly folder?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The max number of items to return. Default: 200.
*/
readonly limit?: number;
/**
* The name of the item.
*/
readonly name?: string;
/**
* The offset of the first item to return.
*/
readonly offset?: number;
/**
* The snippet of the item.
*/
readonly snippet?: string;
readonly tfid: string;
/**
* The total number of items.
*/
readonly total: number;
}
/**
* Retrieves a listing of config items.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Data source to fetch all external dynamic lists in the "Shared" folder.
* const allSharedEdls = scm.getExternalDynamicListList({
* folder: "All",
* });
* export const allSharedEdlsMap = allSharedEdls.then(allSharedEdls => allSharedEdls.datas);
* // Example of using pagination to get the first 5 EDLs.
* const paginatedEdls = scm.getExternalDynamicListList({
* folder: "All",
* limit: 5,
* offset: 0,
* });
* export const paginatedEdlsDetails = {
* totalInFolder: paginatedEdls.then(paginatedEdls => paginatedEdls.total),
* limitUsed: paginatedEdls.then(paginatedEdls => paginatedEdls.limit),
* offsetUsed: paginatedEdls.then(paginatedEdls => paginatedEdls.offset),
* };
* ```
*/
export declare function getExternalDynamicListListOutput(args?: GetExternalDynamicListListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExternalDynamicListListResult>;
/**
* A collection of arguments for invoking getExternalDynamicListList.
*/
export interface GetExternalDynamicListListOutputArgs {
/**
* The device of the item.
*/
device?: pulumi.Input<string>;
/**
* The folder of the item. Default: Shared.
*/
folder?: pulumi.Input<string>;
/**
* The max number of items to return. Default: 200.
*/
limit?: pulumi.Input<number>;
/**
* The name of the item.
*/
name?: pulumi.Input<string>;
/**
* The offset of the first item to return.
*/
offset?: pulumi.Input<number>;
/**
* The snippet of the item.
*/
snippet?: pulumi.Input<string>;
}