UNPKG

@lbrlabs/pulumi-scaleway

Version:

A Pulumi package for creating and managing scaleway cloud resources.

148 lines (147 loc) 4.87 kB
import * as pulumi from "@pulumi/pulumi"; /** * Creates and manages Scaleway Container Token. * For more information see [the documentation](https://developers.scaleway.com/en/products/containers/api/#tokens-26b085). * * ## Examples * * ### Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const mainContainerNamespace = new scaleway.ContainerNamespace("mainContainerNamespace", {}); * const mainContainer = new scaleway.Container("mainContainer", {namespaceId: mainContainerNamespace.id}); * // Namespace Token * const namespace = new scaleway.ContainerToken("namespace", { * namespaceId: mainContainerNamespace.id, * expiresAt: "2022-10-18T11:35:15+02:00", * }); * // Container Token * const container = new scaleway.ContainerToken("container", {containerId: mainContainer.id}); * ``` * * ## Import * * Tokens can be imported using the `{region}/{id}`, e.g. bash * * ```sh * $ pulumi import scaleway:index/containerToken:ContainerToken main fr-par/11111111-1111-1111-1111-111111111111 * ``` */ export declare class ContainerToken extends pulumi.CustomResource { /** * Get an existing ContainerToken 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?: ContainerTokenState, opts?: pulumi.CustomResourceOptions): ContainerToken; /** * Returns true if the given object is an instance of ContainerToken. 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 ContainerToken; /** * The ID of the container. * * > Only one of `namespaceId` or `containerId` must be set. */ readonly containerId: pulumi.Output<string | undefined>; /** * The description of the token. */ readonly description: pulumi.Output<string | undefined>; /** * The expiration date of the token. */ readonly expiresAt: pulumi.Output<string | undefined>; /** * The ID of the container namespace. */ readonly namespaceId: pulumi.Output<string | undefined>; /** * `region`). The region in which the namespace should be created. * * > **Important** Updates to any fields will recreate the token. */ readonly region: pulumi.Output<string>; /** * The token. */ readonly token: pulumi.Output<string>; /** * Create a ContainerToken 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?: ContainerTokenArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ContainerToken resources. */ export interface ContainerTokenState { /** * The ID of the container. * * > Only one of `namespaceId` or `containerId` must be set. */ containerId?: pulumi.Input<string>; /** * The description of the token. */ description?: pulumi.Input<string>; /** * The expiration date of the token. */ expiresAt?: pulumi.Input<string>; /** * The ID of the container namespace. */ namespaceId?: pulumi.Input<string>; /** * `region`). The region in which the namespace should be created. * * > **Important** Updates to any fields will recreate the token. */ region?: pulumi.Input<string>; /** * The token. */ token?: pulumi.Input<string>; } /** * The set of arguments for constructing a ContainerToken resource. */ export interface ContainerTokenArgs { /** * The ID of the container. * * > Only one of `namespaceId` or `containerId` must be set. */ containerId?: pulumi.Input<string>; /** * The description of the token. */ description?: pulumi.Input<string>; /** * The expiration date of the token. */ expiresAt?: pulumi.Input<string>; /** * The ID of the container namespace. */ namespaceId?: pulumi.Input<string>; /** * `region`). The region in which the namespace should be created. * * > **Important** Updates to any fields will recreate the token. */ region?: pulumi.Input<string>; }