# Module efs

### namespace **metrics**

- burstCreditBalance
- clientConnections
- dataReadIOBytes
- dataWriteIOBytes
- EfsMetricChange
- EfsMetricName
- metadataIOBytes
- metric
- percentIOLimit
- permittedThroughput
- totalIOBytes

## namespace **metrics**

###
function **burstCreditBalance**

`burstCreditBalance(change?: EfsMetricChange): Metric`

The number of burst credits that a file system has.

Burst credits allow a file system to burst to throughput levels above a file systemâ€™s baseline level for periods of time. For more information, see Throughput scaling in Amazon EFS.

The Minimum statistic is the smallest burst credit balance for any minute during the period. The Maximum statistic is the largest burst credit balance for any minute during the period. The Average statistic is the average burst credit balance during the period.

Units: Bytes

Valid statistics: Minimum, Maximum, Average

###
function **clientConnections**

`clientConnections(change?: EfsMetricChange): Metric`

The number of client connections to a file system. When using a standard client, there is one connection per mounted Amazon EC2 instance.

Note: To calculate the average ClientConnections for periods greater than one minute, divide the Sum statistic by the number of minutes in the period.

Units: Count of client connections

Valid statistics: Sum

###
function **dataReadIOBytes**

`dataReadIOBytes(change?: EfsMetricChange): Metric`

The number of bytes for each file system read operation.

The Sum statistic is the total number of bytes associated with read operations. The Minimum statistic is the size of the smallest read operation during the period. The Maximum statistic is the size of the largest read operation during the period. The Average statistic is the average size of read operations during the period. The SampleCount statistic provides a count of read operations.

Units: * Bytes for Minimum, Maximum, Average, and Sum. * Count for SampleCount.

Valid statistics: Minimum, Maximum, Average, Sum, SampleCount

###
function **dataWriteIOBytes**

`dataWriteIOBytes(change?: EfsMetricChange): Metric`

The number of bytes for each file write operation.

The Sum statistic is the total number of bytes associated with write operations. The Minimum statistic is the size of the smallest write operation during the period. The Maximum statistic is the size of the largest write operation during the period. The Average statistic is the average size of write operations during the period. The SampleCount statistic provides a count of write operations.

Units: * Bytes for Minimum, Maximum, Average, and Sum. * Count for SampleCount.

Valid statistics: Minimum, Maximum, Average, Sum, SampleCount

###
interface **EfsMetricChange**

`interface EfsMetricChange extends MetricChange`

####
property **color**

`color?: pulumi.Input<string>;`

The six-digit HTML hex color code to be used for this metric.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

####
property **dimensions**

`dimensions?: pulumi.Input<Record<string, any>>;`

The new dimension for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be cleared.

####
property **extendedStatistic**

`extendedStatistic?: pulumi.Input<number>;`

The new percentile statistic for the metric associated with the alarm. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

####
property **fileSystem**

`fileSystem?: aws.efs.FileSystem;`

Filters down events to the specified [FileSystem].

####
property **label**

`label?: pulumi.Input<string>;`

The label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

####
property **period**

`period?: pulumi.Input<number>;`

The new period in seconds over which the specified `stat`

is applied. If this object is
missing this property, then no change will be made. However, if the property is there by set
to [undefined] then the value will be set to the default (300s).

####
property **statistic**

`statistic?: pulumi.Input<MetricStatistic>;`

The new statistic to apply to the alarm’s associated metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

####
property **unit**

`unit?: pulumi.Input<MetricUnit>;`

The new unit for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

####
property **visible**

`visible?: pulumi.Input<boolean>;`

Set this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

####
property **yAxis**

`yAxis?: pulumi.Input<"left" | "right">;`

Where on the graph to display the y-axis for this metric. The default is left.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

###
type **EfsMetricName**

`type EfsMetricName = "BurstCreditBalance" | "ClientConnections" | "DataReadIOBytes" | "DataWriteIOBytes" | "MetadataIOBytes" | "PercentIOLimit" | "PermittedThroughput" | "TotalIOBytes";`

###
function **metadataIOBytes**

`metadataIOBytes(change?: EfsMetricChange): Metric`

The number of bytes for each metadata operation.

The Sum statistic is the total number of bytes associated with metadata operations. The Minimum statistic is the size of the smallest metadata operation during the period. The Maximum statistic is the size of the largest metadata operation during the period. The Average statistic is the size of the average metadata operation during the period. The SampleCount statistic provides a count of metadata operations.

Units: * Bytes for Minimum, Maximum, Average, and Sum. * Count for SampleCount.

Valid statistics: Minimum, Maximum, Average, Sum, SampleCount

###
function **metric**

`metric(metricName: EfsMetricName, change: EfsMetricChange): Metric`

Creates an AWS/EFS metric with the requested [metricName]. See https://docs.aws.amazon.com/efs/latest/ug/monitoring-cloudwatch.html for list of all metric-names.

Note, individual metrics can easily be obtained without supplying the name using the other [metricXXX] functions.

You can monitor file systems using Amazon CloudWatch, which collects and processes raw data from Amazon EFS into readable, near real-time metrics. These statistics are recorded for a period of 15 months, so that you can access historical information and gain a better perspective on how your web application or service is performing. By default, Amazon EFS metric data is automatically sent to CloudWatch at 1-minute periods.

Amazon EFS metrics use the EFS namespace and provides metrics for a single dimension, “FileSystemId”. A file system’s ID can be found in the Amazon EFS management console, and it takes the form of fs-XXXXXXXX.

###
function **percentIOLimit**

`percentIOLimit(change?: EfsMetricChange): Metric`

Shows how close a file system is to reaching the I/O limit of the General Purpose performance mode. If this metric is at 100% more often than not, consider moving your application to a file system using the Max I/O performance mode.

Note: This metric is only submitted for file systems using the General Purpose performance mode.

Units: Percent

###
function **permittedThroughput**

`permittedThroughput(change?: EfsMetricChange): Metric`

The maximum amount of throughput a file system is allowed. For file systems in the Provisioned Throughput mode, if the amount of storage allows your file system to drive a higher amount of throughput than you provisioned, this metric will reflect the higher throughput instead of the provisioned amount. For file systems in the Bursting Throughput mode, this value is a function of the file system size and BurstCreditBalance. For more information, see Amazon EFS Performance.

The Minimum statistic is the smallest throughput permitted for any minute during the period. The Maximum statistic is the highest throughput permitted for any minute during the period. The Average statistic is the average throughput permitted during the period.

Units: Bytes per second

Valid statistics: Minimum, Maximum, Average

###
function **totalIOBytes**

`totalIOBytes(change?: EfsMetricChange): Metric`

The number of bytes for each file system operation, including data read, data write, and metadata operations.

The Sum statistic is the total number of bytes associated with all file system operations. The Minimum statistic is the size of the smallest operation during the period. The Maximum statistic is the size of the largest operation during the period. The Average statistic is the average size of an operation during the period. The SampleCount statistic provides a count of all operations.

Note: To calculate the average operations per second for a period, divide the SampleCount statistic by the number of seconds in the period. To calculate the average throughput (Bytes per second) for a period, divide the Sum statistic by the number of seconds in the period.

Units: Bytes for Minimum, Maximum, Average, and Sum statistics. Count for SampleCount.

Valid statistics: Minimum, Maximum, Average, Sum, SampleCount