// Module included in the following assemblies:
//
// * storage/dynamic-provisioning.adoc

:_mod-docs-content-type: REFERENCE
[id="aws-definition_{context}"]
= AWS Elastic Block Store (EBS) StorageObject object definition

[role="_abstract"]
This AWS EBS storage class example shows how to configure volume type, IOPS performance, encryption settings, and filesystem type for dynamically provisioned persistent volumes.

.Example AWS EBS storage class YAML file
[source,yaml]
----
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: <storage-class-name>
provisioner: ebs.csi.aws.com
parameters:
  type: io1
  iopsPerGB: "10"
  encrypted: "true"
  kmsKeyId: keyvalue
  fsType: ext4
----
* `metadata.name`: Name of the storage class. The persistent volume claim uses this storage class for provisioning the associated persistent volumes.

* `parameters.type`: Select from `io1`, `gp3`, `sc1`, `st1`. The default is `gp3`. For valid Amazon Resource Name (ARN) values, see the AWS documentation, _Identify AWS resources with Amazon Resource Names (ARNs)_.

* Optional: `parameters.iopsPerGB`. Only for *io1* volumes. I/O operations per second per GiB.
+
The AWS volume plugin multiplies this with the size of the requested volume to compute IOPS of the volume. The maximum value is 20,000 IOPS, which
is the maximum supported by AWS. 
+
For more information, see the AWS documentation, _Identify AWS resources with Amazon Resource Names (ARNs)_.

* Optional: `parameters.encrypted`. Indicates whether to encrypt the EBS volume. Valid values are `true` or `false`.

* Optional: `parameters.kmsKeyId`. The full ARN of the key to use when encrypting the volume. If none is supplied, but `encypted` is set to `true`, then AWS generates a key. 
+
For valid ARN values, see the AWS documentation, _Identify AWS resources with Amazon Resource Names (ARNs)_.

* Optional: `parameters.fsType`. File system that is created on dynamically provisioned volumes. This value is copied to the `fsType` field of dynamically provisioned persistent volumes, and the file system is created when the volume is mounted for the first time. The default value is `ext4`.
