@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
184 lines (183 loc) • 7.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage cloudfs namespace
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.cloudfs.Namespace("foo", {
* fsName: "tf-test-fs",
* readOnly: true,
* tosBucket: "tf-test",
* });
* ```
*
* ## Import
*
* CloudfsNamespace can be imported using the FsName:NsId, e.g.
*
* ```sh
* $ pulumi import volcengine:cloudfs/namespace:Namespace default tfname:1801439850948****
* ```
*/
export declare class Namespace extends pulumi.CustomResource {
/**
* Get an existing Namespace 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?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace;
/**
* Returns true if the given object is an instance of Namespace. 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 Namespace;
/**
* The creation time of the namespace.
*/
readonly createdTime: pulumi.Output<string>;
/**
* The name of file system.
*/
readonly fsName: pulumi.Output<string>;
/**
* Whether the tos bucket is your own bucket.
*/
readonly isMyBucket: pulumi.Output<boolean>;
/**
* The id of namespace.
*/
readonly nsId: pulumi.Output<string>;
/**
* Whether the namespace is read-only.
*/
readonly readOnly: pulumi.Output<boolean | undefined>;
/**
* Whether the namespace is the official service for volcengine.
*/
readonly serviceManaged: pulumi.Output<boolean>;
/**
* The status of the namespace.
*/
readonly status: pulumi.Output<string>;
/**
* When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly tosAccountId: pulumi.Output<number | undefined>;
/**
* The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly tosAk: pulumi.Output<string | undefined>;
/**
* The name of tos bucket.
*/
readonly tosBucket: pulumi.Output<string>;
/**
* The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
*/
readonly tosPrefix: pulumi.Output<string | undefined>;
/**
* The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly tosSk: pulumi.Output<string | undefined>;
/**
* Create a Namespace 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: NamespaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Namespace resources.
*/
export interface NamespaceState {
/**
* The creation time of the namespace.
*/
createdTime?: pulumi.Input<string>;
/**
* The name of file system.
*/
fsName?: pulumi.Input<string>;
/**
* Whether the tos bucket is your own bucket.
*/
isMyBucket?: pulumi.Input<boolean>;
/**
* The id of namespace.
*/
nsId?: pulumi.Input<string>;
/**
* Whether the namespace is read-only.
*/
readOnly?: pulumi.Input<boolean>;
/**
* Whether the namespace is the official service for volcengine.
*/
serviceManaged?: pulumi.Input<boolean>;
/**
* The status of the namespace.
*/
status?: pulumi.Input<string>;
/**
* When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
tosAccountId?: pulumi.Input<number>;
/**
* The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
tosAk?: pulumi.Input<string>;
/**
* The name of tos bucket.
*/
tosBucket?: pulumi.Input<string>;
/**
* The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
*/
tosPrefix?: pulumi.Input<string>;
/**
* The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
tosSk?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Namespace resource.
*/
export interface NamespaceArgs {
/**
* The name of file system.
*/
fsName: pulumi.Input<string>;
/**
* Whether the namespace is read-only.
*/
readOnly?: pulumi.Input<boolean>;
/**
* When a data lake scenario instance chooses to associate a bucket under another account, you need to set the ID of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
tosAccountId?: pulumi.Input<number>;
/**
* The tos ak. When the data lake scenario chooses to associate buckets under other accounts, need to set the Access Key ID of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
tosAk?: pulumi.Input<string>;
/**
* The name of tos bucket.
*/
tosBucket: pulumi.Input<string>;
/**
* The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
*/
tosPrefix?: pulumi.Input<string>;
/**
* The tos sk. When the data lake scenario chooses to associate buckets under other accounts, need to set the Secret Access Key of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
tosSk?: pulumi.Input<string>;
}