@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
120 lines (119 loc) • 4.74 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 that match a set of filters that have been
* shared in the Image Share Group that the provided Token has been accepted into.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images-by-token). 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.getConsumerImageShareGroupImageShares({});
* const filtered = await linode.getConsumerImageShareGroupImageShares({
* tokenUuid: "54e1adf3-e499-4685-82be-10d29d4e8fae",
* filters: [{
* name: "label",
* values: ["my-label"],
* }],
* });
* return {
* "all-shared-images": all.imageShares,
* "filtered-shared-images": filtered.imageShares,
* };
* }
* ```
*
* ## Filterable Fields
*
* * `id`
*
* * `label`
*/
export declare function getConsumerImageShareGroupImageShares(args: GetConsumerImageShareGroupImageSharesArgs, opts?: pulumi.InvokeOptions): Promise<GetConsumerImageShareGroupImageSharesResult>;
/**
* A collection of arguments for invoking getConsumerImageShareGroupImageShares.
*/
export interface GetConsumerImageShareGroupImageSharesArgs {
filters?: inputs.GetConsumerImageShareGroupImageSharesFilter[];
imageShares?: inputs.GetConsumerImageShareGroupImageSharesImageShare[];
order?: string;
orderBy?: string;
/**
* The UUID of the Token that has been accepted into 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.
*/
tokenUuid: string;
}
/**
* A collection of values returned by getConsumerImageShareGroupImageShares.
*/
export interface GetConsumerImageShareGroupImageSharesResult {
readonly filters?: outputs.GetConsumerImageShareGroupImageSharesFilter[];
/**
* The unique ID assigned to this Image Share.
*/
readonly id: string;
readonly imageShares?: outputs.GetConsumerImageShareGroupImageSharesImageShare[];
readonly order?: string;
readonly orderBy?: string;
readonly tokenUuid: string;
}
/**
* Provides information about a list of Images that match a set of filters that have been
* shared in the Image Share Group that the provided Token has been accepted into.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images-by-token). 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.getConsumerImageShareGroupImageShares({});
* const filtered = await linode.getConsumerImageShareGroupImageShares({
* tokenUuid: "54e1adf3-e499-4685-82be-10d29d4e8fae",
* filters: [{
* name: "label",
* values: ["my-label"],
* }],
* });
* return {
* "all-shared-images": all.imageShares,
* "filtered-shared-images": filtered.imageShares,
* };
* }
* ```
*
* ## Filterable Fields
*
* * `id`
*
* * `label`
*/
export declare function getConsumerImageShareGroupImageSharesOutput(args: GetConsumerImageShareGroupImageSharesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConsumerImageShareGroupImageSharesResult>;
/**
* A collection of arguments for invoking getConsumerImageShareGroupImageShares.
*/
export interface GetConsumerImageShareGroupImageSharesOutputArgs {
filters?: pulumi.Input<pulumi.Input<inputs.GetConsumerImageShareGroupImageSharesFilterArgs>[]>;
imageShares?: pulumi.Input<pulumi.Input<inputs.GetConsumerImageShareGroupImageSharesImageShareArgs>[]>;
order?: pulumi.Input<string>;
orderBy?: pulumi.Input<string>;
/**
* The UUID of the Token that has been accepted into 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.
*/
tokenUuid: pulumi.Input<string>;
}