@komminarlabs/influxdb
Version:
A Pulumi package for creating and managing InfluxDB resources.
146 lines (145 loc) • 5.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Creates and manages an authorization and returns the authorization with the generated API token. Use this resource to create/manage an authorization, which generates an API token with permissions to read or write to a specific resource or type of resource.
*/
export declare class Authorization extends pulumi.CustomResource {
/**
* Get an existing Authorization 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?: AuthorizationState, opts?: pulumi.CustomResourceOptions): Authorization;
/**
* Returns true if the given object is an instance of Authorization. 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 Authorization;
/**
* Authorization creation date.
*/
readonly createdAt: pulumi.Output<string>;
/**
* A description of the token.
*/
readonly description: pulumi.Output<string>;
/**
* Organization name. Specifies the organization that owns the authorization.
*/
readonly org: pulumi.Output<string>;
/**
* An organization ID. Specifies the organization that owns the authorization.
*/
readonly orgId: pulumi.Output<string>;
/**
* A list of permissions for an authorization.
*/
readonly permissions: pulumi.Output<outputs.AuthorizationPermission[]>;
/**
* Status of the token. Valid values are `active` or `inactive`.
*/
readonly status: pulumi.Output<string>;
/**
* The API token.
*/
readonly token: pulumi.Output<string>;
/**
* Last Authorization update date.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* A user name. Specifies the user that the authorization is scoped to.
*/
readonly user: pulumi.Output<string | undefined>;
/**
* A user ID. Specifies the user that the authorization is scoped to.
*/
readonly userId: pulumi.Output<string | undefined>;
/**
* Create a Authorization 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: AuthorizationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Authorization resources.
*/
export interface AuthorizationState {
/**
* Authorization creation date.
*/
createdAt?: pulumi.Input<string>;
/**
* A description of the token.
*/
description?: pulumi.Input<string>;
/**
* Organization name. Specifies the organization that owns the authorization.
*/
org?: pulumi.Input<string>;
/**
* An organization ID. Specifies the organization that owns the authorization.
*/
orgId?: pulumi.Input<string>;
/**
* A list of permissions for an authorization.
*/
permissions?: pulumi.Input<pulumi.Input<inputs.AuthorizationPermission>[]>;
/**
* Status of the token. Valid values are `active` or `inactive`.
*/
status?: pulumi.Input<string>;
/**
* The API token.
*/
token?: pulumi.Input<string>;
/**
* Last Authorization update date.
*/
updatedAt?: pulumi.Input<string>;
/**
* A user name. Specifies the user that the authorization is scoped to.
*/
user?: pulumi.Input<string>;
/**
* A user ID. Specifies the user that the authorization is scoped to.
*/
userId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Authorization resource.
*/
export interface AuthorizationArgs {
/**
* A description of the token.
*/
description?: pulumi.Input<string>;
/**
* An organization ID. Specifies the organization that owns the authorization.
*/
orgId: pulumi.Input<string>;
/**
* A list of permissions for an authorization.
*/
permissions: pulumi.Input<pulumi.Input<inputs.AuthorizationPermission>[]>;
/**
* Status of the token. Valid values are `active` or `inactive`.
*/
status?: pulumi.Input<string>;
/**
* A user name. Specifies the user that the authorization is scoped to.
*/
user?: pulumi.Input<string>;
/**
* A user ID. Specifies the user that the authorization is scoped to.
*/
userId?: pulumi.Input<string>;
}