@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
206 lines (205 loc) • 6.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway API Keys. For more information, refer to the [IAM API documentation](https://www.scaleway.com/en/developers/api/iam/#api-keys-3665ae).
*
* ## Example Usage
*
* ### With application
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const ciCd = new scaleway.iam.Application("ci_cd", {name: "My application"});
* const main = new scaleway.iam.ApiKey("main", {
* applicationId: mainScalewayIamApplication.id,
* description: "a description",
* });
* ```
*
* ### With user
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.iam.User("main", {email: "test@test.com"});
* const mainApiKey = new scaleway.iam.ApiKey("main", {
* userId: main.id,
* description: "a description",
* });
* ```
*
* ### With expiration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
* import * as time from "@pulumi/time";
*
* const rotateAfterAYear = new time.index.Rotating("rotate_after_a_year", {rotationYears: 1});
* const main = new scaleway.iam.ApiKey("main", {
* applicationId: mainScalewayIamApplication.id,
* expiresAt: rotateAfterAYear.rotationRfc3339,
* });
* ```
*
* ## Import
*
* Api keys can be imported using the `{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:iam/apiKey:ApiKey main 11111111111111111111
* ```
*/
export declare class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey 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?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey;
/**
* Returns true if the given object is an instance of ApiKey. 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 ApiKey;
/**
* The access key of the IAM API key.
*/
readonly accessKey: pulumi.Output<string>;
/**
* ID of the application attached to the API key.
*/
readonly applicationId: pulumi.Output<string | undefined>;
/**
* The date and time of the creation of the IAM API key.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The IP Address of the device which created the API key.
*/
readonly creationIp: pulumi.Output<string>;
/**
* The default Project ID to use with Object Storage.
*/
readonly defaultProjectId: pulumi.Output<string>;
/**
* The description of the API key.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Whether the IAM API key is editable.
*/
readonly editable: pulumi.Output<boolean>;
/**
* The date and time of the expiration of the IAM API key. Please note that in case of any changes,
* the resource will be recreated.
*/
readonly expiresAt: pulumi.Output<string | undefined>;
/**
* The secret Key of the IAM API key.
*/
readonly secretKey: pulumi.Output<string>;
/**
* The date and time of the last update of the IAM API key.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* ID of the user attached to the API key.
* > **Note** You must specify at least one: `applicationId` and/or `userId`.
*/
readonly userId: pulumi.Output<string | undefined>;
/**
* Create a ApiKey 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?: ApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiKey resources.
*/
export interface ApiKeyState {
/**
* The access key of the IAM API key.
*/
accessKey?: pulumi.Input<string>;
/**
* ID of the application attached to the API key.
*/
applicationId?: pulumi.Input<string>;
/**
* The date and time of the creation of the IAM API key.
*/
createdAt?: pulumi.Input<string>;
/**
* The IP Address of the device which created the API key.
*/
creationIp?: pulumi.Input<string>;
/**
* The default Project ID to use with Object Storage.
*/
defaultProjectId?: pulumi.Input<string>;
/**
* The description of the API key.
*/
description?: pulumi.Input<string>;
/**
* Whether the IAM API key is editable.
*/
editable?: pulumi.Input<boolean>;
/**
* The date and time of the expiration of the IAM API key. Please note that in case of any changes,
* the resource will be recreated.
*/
expiresAt?: pulumi.Input<string>;
/**
* The secret Key of the IAM API key.
*/
secretKey?: pulumi.Input<string>;
/**
* The date and time of the last update of the IAM API key.
*/
updatedAt?: pulumi.Input<string>;
/**
* ID of the user attached to the API key.
* > **Note** You must specify at least one: `applicationId` and/or `userId`.
*/
userId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
/**
* ID of the application attached to the API key.
*/
applicationId?: pulumi.Input<string>;
/**
* The default Project ID to use with Object Storage.
*/
defaultProjectId?: pulumi.Input<string>;
/**
* The description of the API key.
*/
description?: pulumi.Input<string>;
/**
* The date and time of the expiration of the IAM API key. Please note that in case of any changes,
* the resource will be recreated.
*/
expiresAt?: pulumi.Input<string>;
/**
* ID of the user attached to the API key.
* > **Note** You must specify at least one: `applicationId` and/or `userId`.
*/
userId?: pulumi.Input<string>;
}