@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
125 lines (124 loc) • 4.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides information about a list of Images shared in the specified Image Share Group that match a set of filters.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images). May not be currently available to all users even under v4beta.
*
* ## Example Usage
*
* The following example shows how one might use this data source to list Images shared in an Image Share Group.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* export = async () => {
* const all = await linode.getProducerImageShareGroupImageShares({
* sharegroupId: 123,
* });
* const filtered = await linode.getProducerImageShareGroupImageShares({
* sharegroupId: 123,
* filters: [{
* name: "label",
* values: ["my-label"],
* }],
* });
* return {
* "all-shared-images": all.imageShares,
* "filtered-shared-images": filtered.imageShares,
* };
* }
* ```
*
* ## Filterable Fields
*
* * `id`
*
* * `label`
*/
export declare function getProducerImageShareGroupImageShares(args: GetProducerImageShareGroupImageSharesArgs, opts?: pulumi.InvokeOptions): Promise<GetProducerImageShareGroupImageSharesResult>;
/**
* A collection of arguments for invoking getProducerImageShareGroupImageShares.
*/
export interface GetProducerImageShareGroupImageSharesArgs {
filters?: inputs.GetProducerImageShareGroupImageSharesFilter[];
imageShares?: inputs.GetProducerImageShareGroupImageSharesImageShare[];
order?: string;
orderBy?: string;
/**
* The ID of the Image Share Group to list shared Images from.
*
* * `filter` - (Optional) A set of filters used to select Image Share Groups that meet certain requirements.
*/
sharegroupId: number;
}
/**
* A collection of values returned by getProducerImageShareGroupImageShares.
*/
export interface GetProducerImageShareGroupImageSharesResult {
readonly filters?: outputs.GetProducerImageShareGroupImageSharesFilter[];
/**
* The unique ID assigned to this Image Share.
*/
readonly id: string;
readonly imageShares?: outputs.GetProducerImageShareGroupImageSharesImageShare[];
readonly order?: string;
readonly orderBy?: string;
/**
* The sharegroupId from the im_ImageShare row.
*/
readonly sharegroupId: number;
}
/**
* Provides information about a list of Images shared in the specified Image Share Group that match a set of filters.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images). May not be currently available to all users even under v4beta.
*
* ## Example Usage
*
* The following example shows how one might use this data source to list Images shared in an Image Share Group.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* export = async () => {
* const all = await linode.getProducerImageShareGroupImageShares({
* sharegroupId: 123,
* });
* const filtered = await linode.getProducerImageShareGroupImageShares({
* sharegroupId: 123,
* filters: [{
* name: "label",
* values: ["my-label"],
* }],
* });
* return {
* "all-shared-images": all.imageShares,
* "filtered-shared-images": filtered.imageShares,
* };
* }
* ```
*
* ## Filterable Fields
*
* * `id`
*
* * `label`
*/
export declare function getProducerImageShareGroupImageSharesOutput(args: GetProducerImageShareGroupImageSharesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProducerImageShareGroupImageSharesResult>;
/**
* A collection of arguments for invoking getProducerImageShareGroupImageShares.
*/
export interface GetProducerImageShareGroupImageSharesOutputArgs {
filters?: pulumi.Input<pulumi.Input<inputs.GetProducerImageShareGroupImageSharesFilterArgs>[]>;
imageShares?: pulumi.Input<pulumi.Input<inputs.GetProducerImageShareGroupImageSharesImageShareArgs>[]>;
order?: pulumi.Input<string>;
orderBy?: pulumi.Input<string>;
/**
* The ID of the Image Share Group to list shared Images from.
*
* * `filter` - (Optional) A set of filters used to select Image Share Groups that meet certain requirements.
*/
sharegroupId: pulumi.Input<number>;
}