volcengine.cloudfs.Namespace
Explore with Pulumi AI
Provides a resource to manage cloudfs namespace
Example Usage
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 pulumi
import pulumi_volcengine as volcengine
foo = volcengine.cloudfs.Namespace("foo",
    fs_name="tf-test-fs",
    read_only=True,
    tos_bucket="tf-test")
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cloudfs"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfs.NewNamespace(ctx, "foo", &cloudfs.NamespaceArgs{
			FsName:    pulumi.String("tf-test-fs"),
			ReadOnly:  pulumi.Bool(true),
			TosBucket: pulumi.String("tf-test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Cloudfs.Namespace("foo", new()
    {
        FsName = "tf-test-fs",
        ReadOnly = true,
        TosBucket = "tf-test",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloudfs.Namespace;
import com.pulumi.volcengine.cloudfs.NamespaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var foo = new Namespace("foo", NamespaceArgs.builder()        
            .fsName("tf-test-fs")
            .readOnly(true)
            .tosBucket("tf-test")
            .build());
    }
}
resources:
  foo:
    type: volcengine:cloudfs:Namespace
    properties:
      fsName: tf-test-fs
      readOnly: true
      tosBucket: tf-test
Create Namespace Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Namespace(name: string, args: NamespaceArgs, opts?: CustomResourceOptions);@overload
def Namespace(resource_name: str,
              args: NamespaceArgs,
              opts: Optional[ResourceOptions] = None)
@overload
def Namespace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              fs_name: Optional[str] = None,
              tos_bucket: Optional[str] = None,
              read_only: Optional[bool] = None,
              tos_account_id: Optional[int] = None,
              tos_ak: Optional[str] = None,
              tos_prefix: Optional[str] = None,
              tos_sk: Optional[str] = None)func NewNamespace(ctx *Context, name string, args NamespaceArgs, opts ...ResourceOption) (*Namespace, error)public Namespace(string name, NamespaceArgs args, CustomResourceOptions? opts = null)
public Namespace(String name, NamespaceArgs args)
public Namespace(String name, NamespaceArgs args, CustomResourceOptions options)
type: volcengine:cloudfs:Namespace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NamespaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NamespaceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NamespaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NamespaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NamespaceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var namespaceResource = new Volcengine.Cloudfs.Namespace("namespaceResource", new()
{
    FsName = "string",
    TosBucket = "string",
    ReadOnly = false,
    TosAccountId = 0,
    TosAk = "string",
    TosPrefix = "string",
    TosSk = "string",
});
example, err := cloudfs.NewNamespace(ctx, "namespaceResource", &cloudfs.NamespaceArgs{
	FsName:       pulumi.String("string"),
	TosBucket:    pulumi.String("string"),
	ReadOnly:     pulumi.Bool(false),
	TosAccountId: pulumi.Int(0),
	TosAk:        pulumi.String("string"),
	TosPrefix:    pulumi.String("string"),
	TosSk:        pulumi.String("string"),
})
var namespaceResource = new Namespace("namespaceResource", NamespaceArgs.builder()
    .fsName("string")
    .tosBucket("string")
    .readOnly(false)
    .tosAccountId(0)
    .tosAk("string")
    .tosPrefix("string")
    .tosSk("string")
    .build());
namespace_resource = volcengine.cloudfs.Namespace("namespaceResource",
    fs_name="string",
    tos_bucket="string",
    read_only=False,
    tos_account_id=0,
    tos_ak="string",
    tos_prefix="string",
    tos_sk="string")
const namespaceResource = new volcengine.cloudfs.Namespace("namespaceResource", {
    fsName: "string",
    tosBucket: "string",
    readOnly: false,
    tosAccountId: 0,
    tosAk: "string",
    tosPrefix: "string",
    tosSk: "string",
});
type: volcengine:cloudfs:Namespace
properties:
    fsName: string
    readOnly: false
    tosAccountId: 0
    tosAk: string
    tosBucket: string
    tosPrefix: string
    tosSk: string
Namespace Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Namespace resource accepts the following input properties:
- FsName string
- The name of file system.
- TosBucket string
- The name of tos bucket.
- ReadOnly bool
- Whether the namespace is read-only.
- TosAccount intId 
- 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 ignore_changes ignore changes in fields.
- TosAk string
- 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 ignore_changes ignore changes in fields.
- TosPrefix string
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- TosSk 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 ignore_changes ignore changes in fields.
- FsName string
- The name of file system.
- TosBucket string
- The name of tos bucket.
- ReadOnly bool
- Whether the namespace is read-only.
- TosAccount intId 
- 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 ignore_changes ignore changes in fields.
- TosAk string
- 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 ignore_changes ignore changes in fields.
- TosPrefix string
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- TosSk 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 ignore_changes ignore changes in fields.
- fsName String
- The name of file system.
- tosBucket String
- The name of tos bucket.
- readOnly Boolean
- Whether the namespace is read-only.
- tosAccount IntegerId 
- 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 ignore_changes ignore changes in fields.
- tosAk String
- 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 ignore_changes ignore changes in fields.
- tosPrefix String
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tosSk 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 ignore_changes ignore changes in fields.
- fsName string
- The name of file system.
- tosBucket string
- The name of tos bucket.
- readOnly boolean
- Whether the namespace is read-only.
- tosAccount numberId 
- 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 ignore_changes ignore changes in fields.
- tosAk string
- 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 ignore_changes ignore changes in fields.
- tosPrefix string
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tosSk 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 ignore_changes ignore changes in fields.
- fs_name str
- The name of file system.
- tos_bucket str
- The name of tos bucket.
- read_only bool
- Whether the namespace is read-only.
- tos_account_ intid 
- 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 ignore_changes ignore changes in fields.
- tos_ak str
- 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 ignore_changes ignore changes in fields.
- tos_prefix str
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tos_sk str
- 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 ignore_changes ignore changes in fields.
- fsName String
- The name of file system.
- tosBucket String
- The name of tos bucket.
- readOnly Boolean
- Whether the namespace is read-only.
- tosAccount NumberId 
- 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 ignore_changes ignore changes in fields.
- tosAk String
- 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 ignore_changes ignore changes in fields.
- tosPrefix String
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tosSk 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 ignore_changes ignore changes in fields.
Outputs
All input properties are implicitly available as output properties. Additionally, the Namespace resource produces the following output properties:
- CreatedTime string
- The creation time of the namespace.
- Id string
- The provider-assigned unique ID for this managed resource.
- IsMy boolBucket 
- Whether the tos bucket is your own bucket.
- NsId string
- The id of namespace.
- ServiceManaged bool
- Whether the namespace is the official service for volcengine.
- Status string
- The status of the namespace.
- CreatedTime string
- The creation time of the namespace.
- Id string
- The provider-assigned unique ID for this managed resource.
- IsMy boolBucket 
- Whether the tos bucket is your own bucket.
- NsId string
- The id of namespace.
- ServiceManaged bool
- Whether the namespace is the official service for volcengine.
- Status string
- The status of the namespace.
- createdTime String
- The creation time of the namespace.
- id String
- The provider-assigned unique ID for this managed resource.
- isMy BooleanBucket 
- Whether the tos bucket is your own bucket.
- nsId String
- The id of namespace.
- serviceManaged Boolean
- Whether the namespace is the official service for volcengine.
- status String
- The status of the namespace.
- createdTime string
- The creation time of the namespace.
- id string
- The provider-assigned unique ID for this managed resource.
- isMy booleanBucket 
- Whether the tos bucket is your own bucket.
- nsId string
- The id of namespace.
- serviceManaged boolean
- Whether the namespace is the official service for volcengine.
- status string
- The status of the namespace.
- created_time str
- The creation time of the namespace.
- id str
- The provider-assigned unique ID for this managed resource.
- is_my_ boolbucket 
- Whether the tos bucket is your own bucket.
- ns_id str
- The id of namespace.
- service_managed bool
- Whether the namespace is the official service for volcengine.
- status str
- The status of the namespace.
- createdTime String
- The creation time of the namespace.
- id String
- The provider-assigned unique ID for this managed resource.
- isMy BooleanBucket 
- Whether the tos bucket is your own bucket.
- nsId String
- The id of namespace.
- serviceManaged Boolean
- Whether the namespace is the official service for volcengine.
- status String
- The status of the namespace.
Look up Existing Namespace Resource
Get an existing Namespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NamespaceState, opts?: CustomResourceOptions): Namespace@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_time: Optional[str] = None,
        fs_name: Optional[str] = None,
        is_my_bucket: Optional[bool] = None,
        ns_id: Optional[str] = None,
        read_only: Optional[bool] = None,
        service_managed: Optional[bool] = None,
        status: Optional[str] = None,
        tos_account_id: Optional[int] = None,
        tos_ak: Optional[str] = None,
        tos_bucket: Optional[str] = None,
        tos_prefix: Optional[str] = None,
        tos_sk: Optional[str] = None) -> Namespacefunc GetNamespace(ctx *Context, name string, id IDInput, state *NamespaceState, opts ...ResourceOption) (*Namespace, error)public static Namespace Get(string name, Input<string> id, NamespaceState? state, CustomResourceOptions? opts = null)public static Namespace get(String name, Output<String> id, NamespaceState state, CustomResourceOptions options)resources:  _:    type: volcengine:cloudfs:Namespace    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- CreatedTime string
- The creation time of the namespace.
- FsName string
- The name of file system.
- IsMy boolBucket 
- Whether the tos bucket is your own bucket.
- NsId string
- The id of namespace.
- ReadOnly bool
- Whether the namespace is read-only.
- ServiceManaged bool
- Whether the namespace is the official service for volcengine.
- Status string
- The status of the namespace.
- TosAccount intId 
- 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 ignore_changes ignore changes in fields.
- TosAk string
- 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 ignore_changes ignore changes in fields.
- TosBucket string
- The name of tos bucket.
- TosPrefix string
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- TosSk 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 ignore_changes ignore changes in fields.
- CreatedTime string
- The creation time of the namespace.
- FsName string
- The name of file system.
- IsMy boolBucket 
- Whether the tos bucket is your own bucket.
- NsId string
- The id of namespace.
- ReadOnly bool
- Whether the namespace is read-only.
- ServiceManaged bool
- Whether the namespace is the official service for volcengine.
- Status string
- The status of the namespace.
- TosAccount intId 
- 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 ignore_changes ignore changes in fields.
- TosAk string
- 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 ignore_changes ignore changes in fields.
- TosBucket string
- The name of tos bucket.
- TosPrefix string
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- TosSk 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 ignore_changes ignore changes in fields.
- createdTime String
- The creation time of the namespace.
- fsName String
- The name of file system.
- isMy BooleanBucket 
- Whether the tos bucket is your own bucket.
- nsId String
- The id of namespace.
- readOnly Boolean
- Whether the namespace is read-only.
- serviceManaged Boolean
- Whether the namespace is the official service for volcengine.
- status String
- The status of the namespace.
- tosAccount IntegerId 
- 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 ignore_changes ignore changes in fields.
- tosAk String
- 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 ignore_changes ignore changes in fields.
- tosBucket String
- The name of tos bucket.
- tosPrefix String
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tosSk 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 ignore_changes ignore changes in fields.
- createdTime string
- The creation time of the namespace.
- fsName string
- The name of file system.
- isMy booleanBucket 
- Whether the tos bucket is your own bucket.
- nsId string
- The id of namespace.
- readOnly boolean
- Whether the namespace is read-only.
- serviceManaged boolean
- Whether the namespace is the official service for volcengine.
- status string
- The status of the namespace.
- tosAccount numberId 
- 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 ignore_changes ignore changes in fields.
- tosAk string
- 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 ignore_changes ignore changes in fields.
- tosBucket string
- The name of tos bucket.
- tosPrefix string
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tosSk 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 ignore_changes ignore changes in fields.
- created_time str
- The creation time of the namespace.
- fs_name str
- The name of file system.
- is_my_ boolbucket 
- Whether the tos bucket is your own bucket.
- ns_id str
- The id of namespace.
- read_only bool
- Whether the namespace is read-only.
- service_managed bool
- Whether the namespace is the official service for volcengine.
- status str
- The status of the namespace.
- tos_account_ intid 
- 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 ignore_changes ignore changes in fields.
- tos_ak str
- 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 ignore_changes ignore changes in fields.
- tos_bucket str
- The name of tos bucket.
- tos_prefix str
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tos_sk str
- 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 ignore_changes ignore changes in fields.
- createdTime String
- The creation time of the namespace.
- fsName String
- The name of file system.
- isMy BooleanBucket 
- Whether the tos bucket is your own bucket.
- nsId String
- The id of namespace.
- readOnly Boolean
- Whether the namespace is read-only.
- serviceManaged Boolean
- Whether the namespace is the official service for volcengine.
- status String
- The status of the namespace.
- tosAccount NumberId 
- 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 ignore_changes ignore changes in fields.
- tosAk String
- 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 ignore_changes ignore changes in fields.
- tosBucket String
- The name of tos bucket.
- tosPrefix String
- The tos prefix. Must not start with /, but must end with /, such as prefix/. When it is empty, it means the root path.
- tosSk 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 ignore_changes ignore changes in fields.
Import
CloudfsNamespace can be imported using the FsName:NsId, e.g.
$ pulumi import volcengine:cloudfs/namespace:Namespace default tfname:1801439850948****
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the volcengineTerraform Provider.