@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
172 lines (171 loc) • 5.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manages an Image Share Group.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-sharegroups). May not be currently available to all users even under v4beta.
*
* ## Example Usage
*
* Create an Image Share Group without any Images:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const test_empty = new linode.ProducerImageShareGroup("test-empty", {
* label: "my-image-share-group",
* description: "My description.",
* });
* ```
*
* Create an Image Share Group with one Image:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const test_images = new linode.ProducerImageShareGroup("test-images", {
* label: "my-image-share-group",
* description: "My description.",
* images: [{
* id: "private/12345",
* label: "my-image",
* description: "My image description.",
* }],
* });
* ```
*/
export declare class ProducerImageShareGroup extends pulumi.CustomResource {
/**
* Get an existing ProducerImageShareGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProducerImageShareGroupState, opts?: pulumi.CustomResourceOptions): ProducerImageShareGroup;
/**
* Returns true if the given object is an instance of ProducerImageShareGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ProducerImageShareGroup;
/**
* The date and time the Image Share Group was created.
*/
readonly created: pulumi.Output<string>;
/**
* The description of the Image Share Group
*
* * `images` - (Optional) A list of Images to include in the Image Share Group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The date and time the Image Share Group will expire.
*/
readonly expiry: pulumi.Output<string>;
/**
* The images to be shared using this Image Share Group.
*/
readonly images: pulumi.Output<outputs.ProducerImageShareGroupImage[]>;
/**
* The number of images in the Image Share Group.
*/
readonly imagesCount: pulumi.Output<number>;
/**
* Whether the Image Share Group is suspended.
*/
readonly isSuspended: pulumi.Output<boolean>;
/**
* The label of the Image Share Group.
*/
readonly label: pulumi.Output<string>;
/**
* The number of members in the Image Share Group.
*/
readonly membersCount: pulumi.Output<number>;
/**
* The date and time the Image Share Group was last updated.
*/
readonly updated: pulumi.Output<string>;
/**
* The UUID of the Image Share Group.
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a ProducerImageShareGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ProducerImageShareGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProducerImageShareGroup resources.
*/
export interface ProducerImageShareGroupState {
/**
* The date and time the Image Share Group was created.
*/
created?: pulumi.Input<string>;
/**
* The description of the Image Share Group
*
* * `images` - (Optional) A list of Images to include in the Image Share Group.
*/
description?: pulumi.Input<string>;
/**
* The date and time the Image Share Group will expire.
*/
expiry?: pulumi.Input<string>;
/**
* The images to be shared using this Image Share Group.
*/
images?: pulumi.Input<pulumi.Input<inputs.ProducerImageShareGroupImage>[]>;
/**
* The number of images in the Image Share Group.
*/
imagesCount?: pulumi.Input<number>;
/**
* Whether the Image Share Group is suspended.
*/
isSuspended?: pulumi.Input<boolean>;
/**
* The label of the Image Share Group.
*/
label?: pulumi.Input<string>;
/**
* The number of members in the Image Share Group.
*/
membersCount?: pulumi.Input<number>;
/**
* The date and time the Image Share Group was last updated.
*/
updated?: pulumi.Input<string>;
/**
* The UUID of the Image Share Group.
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ProducerImageShareGroup resource.
*/
export interface ProducerImageShareGroupArgs {
/**
* The description of the Image Share Group
*
* * `images` - (Optional) A list of Images to include in the Image Share Group.
*/
description?: pulumi.Input<string>;
/**
* The images to be shared using this Image Share Group.
*/
images?: pulumi.Input<pulumi.Input<inputs.ProducerImageShareGroupImage>[]>;
/**
* The label of the Image Share Group.
*/
label: pulumi.Input<string>;
}