1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. efs
  6. getFileSystem
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.efs.getFileSystem

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::EFS::FileSystem

    Using getFileSystem

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFileSystem(args: GetFileSystemArgs, opts?: InvokeOptions): Promise<GetFileSystemResult>
function getFileSystemOutput(args: GetFileSystemOutputArgs, opts?: InvokeOptions): Output<GetFileSystemResult>
    def get_file_system(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFileSystemResult
def get_file_system_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetFileSystemResult]
    func LookupFileSystem(ctx *Context, args *LookupFileSystemArgs, opts ...InvokeOption) (*LookupFileSystemResult, error)
func LookupFileSystemOutput(ctx *Context, args *LookupFileSystemOutputArgs, opts ...InvokeOption) LookupFileSystemResultOutput

    > Note: This function is named LookupFileSystem in the Go SDK.

    public static class GetFileSystem 
{
    public static Task<GetFileSystemResult> InvokeAsync(GetFileSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetFileSystemResult> Invoke(GetFileSystemInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFileSystemResult> getFileSystem(GetFileSystemArgs args, InvokeOptions options)
public static Output<GetFileSystemResult> getFileSystem(GetFileSystemArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:efs/getFileSystem:getFileSystem
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getFileSystem Result

    The following output properties are available:

    AccessPointLimit int
    Access point limit.
    ChargeConfig Volcengine.GetFileSystemChargeConfig
    File system billing configuration.
    ChargeType string
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    CreateTime string
    File system creation time.
    Description string
    Description.
    DowngradeUnlockTime string
    Time when file system bandwidth can be downgraded.
    FileSystemId string
    File system ID.
    FileSystemName string
    File system name.
    Id string
    Uniquely identifies the resource.
    InstanceType string
    Basic: Basic type, Premium: Premium type.
    MountPointLimit int
    Mount point limit.
    Performance Volcengine.GetFileSystemPerformance
    File system performance information.
    PerformanceDensity string
    File system performance density. Value description: Basic50: Basic type 50MB/s/TiB, Premium125: Premium type 125MB/s/TiB.
    ProjectName string
    Project name.
    ProtocolTypes List<string>
    Protocol type.
    Status string
    File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.
    Storage Volcengine.GetFileSystemStorage
    File system capacity information.
    Tags List<Volcengine.GetFileSystemTag>
    Tag list.
    UpdateTime string
    File system update time.
    ZoneId string
    Availability zone ID.
    ZoneName string
    Availability zone name.
    AccessPointLimit int
    Access point limit.
    ChargeConfig GetFileSystemChargeConfig
    File system billing configuration.
    ChargeType string
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    CreateTime string
    File system creation time.
    Description string
    Description.
    DowngradeUnlockTime string
    Time when file system bandwidth can be downgraded.
    FileSystemId string
    File system ID.
    FileSystemName string
    File system name.
    Id string
    Uniquely identifies the resource.
    InstanceType string
    Basic: Basic type, Premium: Premium type.
    MountPointLimit int
    Mount point limit.
    Performance GetFileSystemPerformance
    File system performance information.
    PerformanceDensity string
    File system performance density. Value description: Basic50: Basic type 50MB/s/TiB, Premium125: Premium type 125MB/s/TiB.
    ProjectName string
    Project name.
    ProtocolTypes []string
    Protocol type.
    Status string
    File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.
    Storage GetFileSystemStorage
    File system capacity information.
    Tags []GetFileSystemTag
    Tag list.
    UpdateTime string
    File system update time.
    ZoneId string
    Availability zone ID.
    ZoneName string
    Availability zone name.
    accessPointLimit Integer
    Access point limit.
    chargeConfig GetFileSystemChargeConfig
    File system billing configuration.
    chargeType String
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    createTime String
    File system creation time.
    description String
    Description.
    downgradeUnlockTime String
    Time when file system bandwidth can be downgraded.
    fileSystemId String
    File system ID.
    fileSystemName String
    File system name.
    id String
    Uniquely identifies the resource.
    instanceType String
    Basic: Basic type, Premium: Premium type.
    mountPointLimit Integer
    Mount point limit.
    performance GetFileSystemPerformance
    File system performance information.
    performanceDensity String
    File system performance density. Value description: Basic50: Basic type 50MB/s/TiB, Premium125: Premium type 125MB/s/TiB.
    projectName String
    Project name.
    protocolTypes List<String>
    Protocol type.
    status String
    File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.
    storage GetFileSystemStorage
    File system capacity information.
    tags List<GetFileSystemTag>
    Tag list.
    updateTime String
    File system update time.
    zoneId String
    Availability zone ID.
    zoneName String
    Availability zone name.
    accessPointLimit number
    Access point limit.
    chargeConfig GetFileSystemChargeConfig
    File system billing configuration.
    chargeType string
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    createTime string
    File system creation time.
    description string
    Description.
    downgradeUnlockTime string
    Time when file system bandwidth can be downgraded.
    fileSystemId string
    File system ID.
    fileSystemName string
    File system name.
    id string
    Uniquely identifies the resource.
    instanceType string
    Basic: Basic type, Premium: Premium type.
    mountPointLimit number
    Mount point limit.
    performance GetFileSystemPerformance
    File system performance information.
    performanceDensity string
    File system performance density. Value description: Basic50: Basic type 50MB/s/TiB, Premium125: Premium type 125MB/s/TiB.
    projectName string
    Project name.
    protocolTypes string[]
    Protocol type.
    status string
    File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.
    storage GetFileSystemStorage
    File system capacity information.
    tags GetFileSystemTag[]
    Tag list.
    updateTime string
    File system update time.
    zoneId string
    Availability zone ID.
    zoneName string
    Availability zone name.
    access_point_limit int
    Access point limit.
    charge_config GetFileSystemChargeConfig
    File system billing configuration.
    charge_type str
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    create_time str
    File system creation time.
    description str
    Description.
    downgrade_unlock_time str
    Time when file system bandwidth can be downgraded.
    file_system_id str
    File system ID.
    file_system_name str
    File system name.
    id str
    Uniquely identifies the resource.
    instance_type str
    Basic: Basic type, Premium: Premium type.
    mount_point_limit int
    Mount point limit.
    performance GetFileSystemPerformance
    File system performance information.
    performance_density str
    File system performance density. Value description: Basic50: Basic type 50MB/s/TiB, Premium125: Premium type 125MB/s/TiB.
    project_name str
    Project name.
    protocol_types Sequence[str]
    Protocol type.
    status str
    File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.
    storage GetFileSystemStorage
    File system capacity information.
    tags Sequence[GetFileSystemTag]
    Tag list.
    update_time str
    File system update time.
    zone_id str
    Availability zone ID.
    zone_name str
    Availability zone name.
    accessPointLimit Number
    Access point limit.
    chargeConfig Property Map
    File system billing configuration.
    chargeType String
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    createTime String
    File system creation time.
    description String
    Description.
    downgradeUnlockTime String
    Time when file system bandwidth can be downgraded.
    fileSystemId String
    File system ID.
    fileSystemName String
    File system name.
    id String
    Uniquely identifies the resource.
    instanceType String
    Basic: Basic type, Premium: Premium type.
    mountPointLimit Number
    Mount point limit.
    performance Property Map
    File system performance information.
    performanceDensity String
    File system performance density. Value description: Basic50: Basic type 50MB/s/TiB, Premium125: Premium type 125MB/s/TiB.
    projectName String
    Project name.
    protocolTypes List<String>
    Protocol type.
    status String
    File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.
    storage Property Map
    File system capacity information.
    tags List<Property Map>
    Tag list.
    updateTime String
    File system update time.
    zoneId String
    Availability zone ID.
    zoneName String
    Availability zone name.

    Supporting Types

    GetFileSystemChargeConfig

    ChargeStatus string
    Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.
    ChargeType string
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    ExpireTime string
    Expiration time.
    ReclaimTime string
    Recycle time.
    StopTime string
    Shutdown time.
    ChargeStatus string
    Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.
    ChargeType string
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    ExpireTime string
    Expiration time.
    ReclaimTime string
    Recycle time.
    StopTime string
    Shutdown time.
    chargeStatus String
    Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.
    chargeType String
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    expireTime String
    Expiration time.
    reclaimTime String
    Recycle time.
    stopTime String
    Shutdown time.
    chargeStatus string
    Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.
    chargeType string
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    expireTime string
    Expiration time.
    reclaimTime string
    Recycle time.
    stopTime string
    Shutdown time.
    charge_status str
    Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.
    charge_type str
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    expire_time str
    Expiration time.
    reclaim_time str
    Recycle time.
    stop_time str
    Shutdown time.
    chargeStatus String
    Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.
    chargeType String
    Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.
    expireTime String
    Expiration time.
    reclaimTime String
    Recycle time.
    stopTime String
    Shutdown time.

    GetFileSystemPerformance

    BandwidthMode string
    Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.
    BaselineBandwidth int
    Baseline bandwidth.
    BaselineIops int
    Baseline IOPS.
    BurstBandwidth int
    Burst bandwidth.
    BurstIops int
    Burst IOPS.
    ProvisionedBandwidth int
    Provisioned bandwidth.
    ProvisionedIops int
    Provisioned IOPS.
    BandwidthMode string
    Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.
    BaselineBandwidth int
    Baseline bandwidth.
    BaselineIops int
    Baseline IOPS.
    BurstBandwidth int
    Burst bandwidth.
    BurstIops int
    Burst IOPS.
    ProvisionedBandwidth int
    Provisioned bandwidth.
    ProvisionedIops int
    Provisioned IOPS.
    bandwidthMode String
    Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.
    baselineBandwidth Integer
    Baseline bandwidth.
    baselineIops Integer
    Baseline IOPS.
    burstBandwidth Integer
    Burst bandwidth.
    burstIops Integer
    Burst IOPS.
    provisionedBandwidth Integer
    Provisioned bandwidth.
    provisionedIops Integer
    Provisioned IOPS.
    bandwidthMode string
    Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.
    baselineBandwidth number
    Baseline bandwidth.
    baselineIops number
    Baseline IOPS.
    burstBandwidth number
    Burst bandwidth.
    burstIops number
    Burst IOPS.
    provisionedBandwidth number
    Provisioned bandwidth.
    provisionedIops number
    Provisioned IOPS.
    bandwidth_mode str
    Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.
    baseline_bandwidth int
    Baseline bandwidth.
    baseline_iops int
    Baseline IOPS.
    burst_bandwidth int
    Burst bandwidth.
    burst_iops int
    Burst IOPS.
    provisioned_bandwidth int
    Provisioned bandwidth.
    provisioned_iops int
    Provisioned IOPS.
    bandwidthMode String
    Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.
    baselineBandwidth Number
    Baseline bandwidth.
    baselineIops Number
    Baseline IOPS.
    burstBandwidth Number
    Burst bandwidth.
    burstIops Number
    Burst IOPS.
    provisionedBandwidth Number
    Provisioned bandwidth.
    provisionedIops Number
    Provisioned IOPS.

    GetFileSystemStorage

    CapacityLimit int
    Capacity limit, in MiB.
    CapacityUsed int
    Used capacity, in MiB.
    InodeLimit int
    File count limit.
    InodeUsed int
    Used file count.
    CapacityLimit int
    Capacity limit, in MiB.
    CapacityUsed int
    Used capacity, in MiB.
    InodeLimit int
    File count limit.
    InodeUsed int
    Used file count.
    capacityLimit Integer
    Capacity limit, in MiB.
    capacityUsed Integer
    Used capacity, in MiB.
    inodeLimit Integer
    File count limit.
    inodeUsed Integer
    Used file count.
    capacityLimit number
    Capacity limit, in MiB.
    capacityUsed number
    Used capacity, in MiB.
    inodeLimit number
    File count limit.
    inodeUsed number
    Used file count.
    capacity_limit int
    Capacity limit, in MiB.
    capacity_used int
    Used capacity, in MiB.
    inode_limit int
    File count limit.
    inode_used int
    Used file count.
    capacityLimit Number
    Capacity limit, in MiB.
    capacityUsed Number
    Used capacity, in MiB.
    inodeLimit Number
    File count limit.
    inodeUsed Number
    Used file count.

    GetFileSystemTag

    Key string
    Tag key.
    Type string
    Tag type. Value description: System: System tag, Custom: Custom tag.
    Value string
    Tag value.
    Key string
    Tag key.
    Type string
    Tag type. Value description: System: System tag, Custom: Custom tag.
    Value string
    Tag value.
    key String
    Tag key.
    type String
    Tag type. Value description: System: System tag, Custom: Custom tag.
    value String
    Tag value.
    key string
    Tag key.
    type string
    Tag type. Value description: System: System tag, Custom: Custom tag.
    value string
    Tag value.
    key str
    Tag key.
    type str
    Tag type. Value description: System: System tag, Custom: Custom tag.
    value str
    Tag value.
    key String
    Tag key.
    type String
    Tag type. Value description: System: System tag, Custom: Custom tag.
    value String
    Tag value.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.