1. Packages
  2. Volcengine
  3. API Docs
  4. cloudfs
  5. Access
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.cloudfs.Access

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage cloudfs access

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo1 = new Volcengine.Cloudfs.Access("foo1", new()
        {
            FsName = "tftest2",
            SecurityGroupId = "sg-rrv1klfg5s00v0x578mx14m",
            SubnetId = "subnet-13fca1crr5d6o3n6nu46cyb5m",
            VpcRouteEnabled = false,
        });
    
    });
    
    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.NewAccess(ctx, "foo1", &cloudfs.AccessArgs{
    			FsName:          pulumi.String("tftest2"),
    			SecurityGroupId: pulumi.String("sg-rrv1klfg5s00v0x578mx14m"),
    			SubnetId:        pulumi.String("subnet-13fca1crr5d6o3n6nu46cyb5m"),
    			VpcRouteEnabled: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.cloudfs.Access;
    import com.pulumi.volcengine.cloudfs.AccessArgs;
    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 foo1 = new Access("foo1", AccessArgs.builder()        
                .fsName("tftest2")
                .securityGroupId("sg-rrv1klfg5s00v0x578mx14m")
                .subnetId("subnet-13fca1crr5d6o3n6nu46cyb5m")
                .vpcRouteEnabled(false)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo1 = volcengine.cloudfs.Access("foo1",
        fs_name="tftest2",
        security_group_id="sg-rrv1klfg5s00v0x578mx14m",
        subnet_id="subnet-13fca1crr5d6o3n6nu46cyb5m",
        vpc_route_enabled=False)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo1 = new volcengine.cloudfs.Access("foo1", {
        fsName: "tftest2",
        securityGroupId: "sg-rrv1klfg5s00v0x578mx14m",
        subnetId: "subnet-13fca1crr5d6o3n6nu46cyb5m",
        vpcRouteEnabled: false,
    });
    
    resources:
      foo1:
        type: volcengine:cloudfs:Access
        properties:
          fsName: tftest2
          securityGroupId: sg-rrv1klfg5s00v0x578mx14m
          subnetId: subnet-13fca1crr5d6o3n6nu46cyb5m
          vpcRouteEnabled: false
    

    Create Access Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Access(name: string, args: AccessArgs, opts?: CustomResourceOptions);
    @overload
    def Access(resource_name: str,
               args: AccessArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Access(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               fs_name: Optional[str] = None,
               security_group_id: Optional[str] = None,
               subnet_id: Optional[str] = None,
               access_account_id: Optional[int] = None,
               access_iam_role: Optional[str] = None,
               vpc_route_enabled: Optional[bool] = None)
    func NewAccess(ctx *Context, name string, args AccessArgs, opts ...ResourceOption) (*Access, error)
    public Access(string name, AccessArgs args, CustomResourceOptions? opts = null)
    public Access(String name, AccessArgs args)
    public Access(String name, AccessArgs args, CustomResourceOptions options)
    
    type: volcengine:cloudfs:Access
    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 AccessArgs
    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 AccessArgs
    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 AccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var accessResource = new Volcengine.Cloudfs.Access("accessResource", new()
    {
        FsName = "string",
        SecurityGroupId = "string",
        SubnetId = "string",
        AccessAccountId = 0,
        AccessIamRole = "string",
        VpcRouteEnabled = false,
    });
    
    example, err := cloudfs.NewAccess(ctx, "accessResource", &cloudfs.AccessArgs{
    	FsName:          pulumi.String("string"),
    	SecurityGroupId: pulumi.String("string"),
    	SubnetId:        pulumi.String("string"),
    	AccessAccountId: pulumi.Int(0),
    	AccessIamRole:   pulumi.String("string"),
    	VpcRouteEnabled: pulumi.Bool(false),
    })
    
    var accessResource = new Access("accessResource", AccessArgs.builder()
        .fsName("string")
        .securityGroupId("string")
        .subnetId("string")
        .accessAccountId(0)
        .accessIamRole("string")
        .vpcRouteEnabled(false)
        .build());
    
    access_resource = volcengine.cloudfs.Access("accessResource",
        fs_name="string",
        security_group_id="string",
        subnet_id="string",
        access_account_id=0,
        access_iam_role="string",
        vpc_route_enabled=False)
    
    const accessResource = new volcengine.cloudfs.Access("accessResource", {
        fsName: "string",
        securityGroupId: "string",
        subnetId: "string",
        accessAccountId: 0,
        accessIamRole: "string",
        vpcRouteEnabled: false,
    });
    
    type: volcengine:cloudfs:Access
    properties:
        accessAccountId: 0
        accessIamRole: string
        fsName: string
        securityGroupId: string
        subnetId: string
        vpcRouteEnabled: false
    

    Access Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Access resource accepts the following input properties:

    FsName string
    The name of file system.
    SecurityGroupId string
    The id of security group.
    SubnetId string
    The id of subnet.
    AccessAccountId int
    The account id of access.
    AccessIamRole string
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    VpcRouteEnabled bool
    Whether enable all vpc route.
    FsName string
    The name of file system.
    SecurityGroupId string
    The id of security group.
    SubnetId string
    The id of subnet.
    AccessAccountId int
    The account id of access.
    AccessIamRole string
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    VpcRouteEnabled bool
    Whether enable all vpc route.
    fsName String
    The name of file system.
    securityGroupId String
    The id of security group.
    subnetId String
    The id of subnet.
    accessAccountId Integer
    The account id of access.
    accessIamRole String
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    vpcRouteEnabled Boolean
    Whether enable all vpc route.
    fsName string
    The name of file system.
    securityGroupId string
    The id of security group.
    subnetId string
    The id of subnet.
    accessAccountId number
    The account id of access.
    accessIamRole string
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    vpcRouteEnabled boolean
    Whether enable all vpc route.
    fs_name str
    The name of file system.
    security_group_id str
    The id of security group.
    subnet_id str
    The id of subnet.
    access_account_id int
    The account id of access.
    access_iam_role str
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    vpc_route_enabled bool
    Whether enable all vpc route.
    fsName String
    The name of file system.
    securityGroupId String
    The id of security group.
    subnetId String
    The id of subnet.
    accessAccountId Number
    The account id of access.
    accessIamRole String
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    vpcRouteEnabled Boolean
    Whether enable all vpc route.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Access resource produces the following output properties:

    AccessId string
    The id of access.
    AccessServiceName string
    The service name of access.
    CreatedTime string
    The creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether is default access.
    Status string
    Status of access.
    VpcId string
    The id of vpc.
    AccessId string
    The id of access.
    AccessServiceName string
    The service name of access.
    CreatedTime string
    The creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether is default access.
    Status string
    Status of access.
    VpcId string
    The id of vpc.
    accessId String
    The id of access.
    accessServiceName String
    The service name of access.
    createdTime String
    The creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether is default access.
    status String
    Status of access.
    vpcId String
    The id of vpc.
    accessId string
    The id of access.
    accessServiceName string
    The service name of access.
    createdTime string
    The creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Whether is default access.
    status string
    Status of access.
    vpcId string
    The id of vpc.
    access_id str
    The id of access.
    access_service_name str
    The service name of access.
    created_time str
    The creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether is default access.
    status str
    Status of access.
    vpc_id str
    The id of vpc.
    accessId String
    The id of access.
    accessServiceName String
    The service name of access.
    createdTime String
    The creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether is default access.
    status String
    Status of access.
    vpcId String
    The id of vpc.

    Look up Existing Access Resource

    Get an existing Access 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?: AccessState, opts?: CustomResourceOptions): Access
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_account_id: Optional[int] = None,
            access_iam_role: Optional[str] = None,
            access_id: Optional[str] = None,
            access_service_name: Optional[str] = None,
            created_time: Optional[str] = None,
            fs_name: Optional[str] = None,
            is_default: Optional[bool] = None,
            security_group_id: Optional[str] = None,
            status: Optional[str] = None,
            subnet_id: Optional[str] = None,
            vpc_id: Optional[str] = None,
            vpc_route_enabled: Optional[bool] = None) -> Access
    func GetAccess(ctx *Context, name string, id IDInput, state *AccessState, opts ...ResourceOption) (*Access, error)
    public static Access Get(string name, Input<string> id, AccessState? state, CustomResourceOptions? opts = null)
    public static Access get(String name, Output<String> id, AccessState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    AccessAccountId int
    The account id of access.
    AccessIamRole string
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    AccessId string
    The id of access.
    AccessServiceName string
    The service name of access.
    CreatedTime string
    The creation time.
    FsName string
    The name of file system.
    IsDefault bool
    Whether is default access.
    SecurityGroupId string
    The id of security group.
    Status string
    Status of access.
    SubnetId string
    The id of subnet.
    VpcId string
    The id of vpc.
    VpcRouteEnabled bool
    Whether enable all vpc route.
    AccessAccountId int
    The account id of access.
    AccessIamRole string
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    AccessId string
    The id of access.
    AccessServiceName string
    The service name of access.
    CreatedTime string
    The creation time.
    FsName string
    The name of file system.
    IsDefault bool
    Whether is default access.
    SecurityGroupId string
    The id of security group.
    Status string
    Status of access.
    SubnetId string
    The id of subnet.
    VpcId string
    The id of vpc.
    VpcRouteEnabled bool
    Whether enable all vpc route.
    accessAccountId Integer
    The account id of access.
    accessIamRole String
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    accessId String
    The id of access.
    accessServiceName String
    The service name of access.
    createdTime String
    The creation time.
    fsName String
    The name of file system.
    isDefault Boolean
    Whether is default access.
    securityGroupId String
    The id of security group.
    status String
    Status of access.
    subnetId String
    The id of subnet.
    vpcId String
    The id of vpc.
    vpcRouteEnabled Boolean
    Whether enable all vpc route.
    accessAccountId number
    The account id of access.
    accessIamRole string
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    accessId string
    The id of access.
    accessServiceName string
    The service name of access.
    createdTime string
    The creation time.
    fsName string
    The name of file system.
    isDefault boolean
    Whether is default access.
    securityGroupId string
    The id of security group.
    status string
    Status of access.
    subnetId string
    The id of subnet.
    vpcId string
    The id of vpc.
    vpcRouteEnabled boolean
    Whether enable all vpc route.
    access_account_id int
    The account id of access.
    access_iam_role str
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    access_id str
    The id of access.
    access_service_name str
    The service name of access.
    created_time str
    The creation time.
    fs_name str
    The name of file system.
    is_default bool
    Whether is default access.
    security_group_id str
    The id of security group.
    status str
    Status of access.
    subnet_id str
    The id of subnet.
    vpc_id str
    The id of vpc.
    vpc_route_enabled bool
    Whether enable all vpc route.
    accessAccountId Number
    The account id of access.
    accessIamRole String
    The iam role of access. If the VPC of another account is attached, the other account needs to create a role with CFSCacheAccess permission, and enter the role name as a parameter.
    accessId String
    The id of access.
    accessServiceName String
    The service name of access.
    createdTime String
    The creation time.
    fsName String
    The name of file system.
    isDefault Boolean
    Whether is default access.
    securityGroupId String
    The id of security group.
    status String
    Status of access.
    subnetId String
    The id of subnet.
    vpcId String
    The id of vpc.
    vpcRouteEnabled Boolean
    Whether enable all vpc route.

    Import

    CloudFs Access can be imported using the FsName:AccessId, e.g.

     $ pulumi import volcengine:cloudfs/access:Access default tfname:access-**rdgmedx3fow
    

    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 volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine