@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
152 lines (151 loc) • 5.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The `scaleway.containers.Token` resource allows you to create and manage authentication tokens for Scaleway [Serverless Containers](https://www.scaleway.com/en/docs/serverless/containers/).
*
* Refer to the Containers tokens [documentation](https://www.scaleway.com/en/docs/serverless/containers/how-to/create-auth-token-from-console/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#path-tokens-list-all-tokens) for more information.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.containers.Namespace("main", {name: "test-container-token-ns"});
* const mainContainer = new scaleway.containers.Container("main", {namespaceId: main.id});
* // Namespace Token
* const namespace = new scaleway.containers.Token("namespace", {
* namespaceId: main.id,
* expiresAt: "2022-10-18T11:35:15+02:00",
* });
* // Container Token
* const container = new scaleway.containers.Token("container", {containerId: mainContainer.id});
* ```
*
* ## Import
*
* Tokens can be imported using `{region}/{id}`, as shown below:
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/containerToken:ContainerToken main fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/containertoken.ContainerToken has been deprecated in favor of scaleway.containers/token.Token
*/
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 unique identifier 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 unique identifier of the Containers namespace.
*/
readonly namespaceId: pulumi.Output<string | undefined>;
/**
* `region`). The region in which the namespace is created.
*
* > **Important** Updating any of the arguments above will recreate the token.
*/
readonly region: pulumi.Output<string>;
/**
* The token.
*/
readonly value: 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.
*/
/** @deprecated scaleway.index/containertoken.ContainerToken has been deprecated in favor of scaleway.containers/token.Token */
constructor(name: string, args?: ContainerTokenArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ContainerToken resources.
*/
export interface ContainerTokenState {
/**
* The unique identifier 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 unique identifier of the Containers namespace.
*/
namespaceId?: pulumi.Input<string>;
/**
* `region`). The region in which the namespace is created.
*
* > **Important** Updating any of the arguments above will recreate the token.
*/
region?: pulumi.Input<string>;
/**
* The token.
*/
value?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ContainerToken resource.
*/
export interface ContainerTokenArgs {
/**
* The unique identifier 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 unique identifier of the Containers namespace.
*/
namespaceId?: pulumi.Input<string>;
/**
* `region`). The region in which the namespace is created.
*
* > **Important** Updating any of the arguments above will recreate the token.
*/
region?: pulumi.Input<string>;
}