Sintaxis de la solicitud Parámetros de solicitud del URI Cuerpo de la solicitud Sintaxis de la respuesta Elementos de respuesta Errores Ejemplos Véase también

CreateFileSystem

Crea un nuevo sistema de archivos vacío. La operación requiere un token de creación en la solicitud que Amazon EFS usa para garantizar la creación idempotent (llamar a la operación con el mismo token de creación no tiene ningún efecto). Si actualmente no existe un sistema de archivos que pertenece a la Cuenta de AWS del intermediario con el token de creación especificado, el token de esta operación hace lo siguiente:

Crea un nuevo sistema de archivos vacío. El sistema de archivos tendrá un ID de Amazon EFS asignado y un estado de ciclo de vida inicial de creating.
Se devuelve con la descripción del sistema de archivos creado.

De lo contrario, esta operación devuelve un error FileSystemAlreadyExists con el ID del sistema de archivos existente.

nota

Para casos de uso básicos, puede utilizar un UUID generado de forma aleatoria para el token de creación.

La operación idempotent le permite volver a intentar una llamada CreateFileSystem sin riesgo de crear un sistema de archivos adicional. Esto puede ocurrir cuando una llamada inicial produce un error de forma que queda la incertidumbre de si se creó o no un sistema de archivos. Por ejemplo, se agotó el tiempo de espera de nivel de transporte o se restableció la conexión. Siempre que utilice el mismo token de creación, si la llamada inicial hubiera realizado con éxito la creación de un sistema de archivos, el cliente puede deducir su existencia a partir del error FileSystemAlreadyExists.

Para obtener más información, consulte Creación de recursos para Amazon EFS en la Guía del usuario de Amazon EFS.

nota

La llamada CreateFileSystem realiza devuelve información mientras el estado de ciclo de vida del sistema de archivos siga siendo creating. Puede comprobar el estado de creación del sistema de archivos llamando a la operación DescribeFileSystems, que entre otras cosas devuelve el estado del sistema de archivos.

Esta operación también tiene un parámetro PerformanceMode opcional que elige para su sistema de archivos. Se recomienda generalPurpose PerformanceMode para todos los sistemas de archivos. El modo maxIO es un tipo de rendimiento de la generación anterior que está diseñado para cargas de trabajo altamente paralelizadas que pueden tolerar latencias más altas que el modo generalPurpose. El modo MaxIO no es compatible con los sistemas de archivos One Zone o sistemas de archivos que utilicen rendimiento elástico.

El PerformanceMode no se puede cambiar después de haber creado el sistema de archivos. Para obtener más información, consulte Amazon EFS: Modos de rendimiento.

El modo de rendimiento del sistema de archivos se puede configurar mediante el parámetro ThroughputMode.

Una vez que se ha creado totalmente el sistema de archivos, Amazon EFS establece su estado de ciclo de vida en available. A partir de ese momento puede crear uno o varios destinos de montaje para el sistema de archivos en la VPC. Para obtener más información, consulte CreateMountTarget. Monte su sistema de archivos de Amazon EFS en instancias EC2 en su VPC a través de los destinos de montaje. Para obtener más información, consulte Amazon EFS: cómo funciona.

Esta operación necesita permisos para la acción elasticfilesystem:CreateFileSystem.

Los sistemas de archivos se pueden etiquetar al crearlos. Si se especifican etiquetas en la acción de creación, IAM realiza una autorización adicional en la acción elasticfilesystem:TagResource para verificar que los usuarios tengan permisos para crear etiquetas. Por lo tanto, usted debe conceder permisos explícitos para utilizar la acción elasticfilesystem:TagResource. Para obtener más información, consulte Conceder permisos para etiquetar recursos durante la creación.

Sintaxis de la solicitud


POST /2015-02-01/file-systems HTTP/1.1
Content-type: application/json

{
   "AvailabilityZoneName": "string",
   "Backup": boolean,
   "CreationToken": "string",
   "Encrypted": boolean,
   "KmsKeyId": "string",
   "PerformanceMode": "string",
   "ProvisionedThroughputInMibps": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ThroughputMode": "string"
}

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

AvailabilityZoneName

Para los sistemas de archivos One Zone, especifique la zona de disponibilidad AWS en la que se creará el sistema de archivos. Utilice el formato us-east-1a para especificar la zona de disponibilidad. Para obtener más información acerca de los sistemas de archivos One Zone, consulte Tipos de sistemas de archivos EFS en la Guía del usuario de Amazon EFS.

nota

Los sistemas de archivos One Zone no están disponibles en todas las zonas de disponibilidad en las Regiones de AWS en las que Amazon EFS está disponible.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: .+

Obligatorio: no

Backup

Especifica si las copias de seguridad automáticas están habilitadas en el sistema de archivos que está creando. Establezca el valor en true para habilitar copias de seguridad automáticas. Si va a crear un sistema de archivos One Zone, las copias de seguridad automáticas están habilitadas de forma predeterminada. Para obtener más información, consulte Copias de seguridad automáticas en la Guía del usuario de Amazon EFS.

El valor predeterminado es false. Sin embargo, si especifica una AvailabilityZoneName, el valor predeterminado es true.

nota

AWS Backup no está disponible en todas las Regiones de AWS donde Amazon EFS está disponible.

Tipo: Booleano

Obligatorio: no

CreationToken

Una cadena de hasta 64 caracteres ASCII. Amazon EFS la utiliza para garantizar la creación de idempotentes.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: .+

Obligatorio: sí

Encrypted

Un valor booleano que, si es verdadero, crea un sistema de archivos cifrado. Cuando se crea un sistema de archivos cifrados, tiene la opción de especificar una clave AWS Key Management Service existente (clave KMS). Si no especifica una clave KMS, se utilizará la clave KMS por defecto para Amazon EFS, /aws/elasticfilesystem, se utiliza para proteger el sistema de archivos cifrado.

Tipo: Booleano

Obligatorio: no

KmsKeyId

El ID de la clave KMS que se va a utilizar para proteger el sistema de archivos cifrado. Este parámetro solo es necesario si quiere utilizar una clave KMS que no sea la predeterminada. Si no se especifica este parámetro, se utiliza la clave KMS de forma predeterminada para Amazon EFS. Puede usar los siguientes formatos para especificar este ID de clave KMS.

ID de clave: un identificador único de la clave, por ejemplo 1234abcd-12ab-34cd-56ef-1234567890ab.
ARN: un nombre de recurso de Amazon (ARN) para la clave, por ejemplo arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias de clave: un nombre de visualización creado con anterioridad para una clave, por ejemplo alias/projectKey1.
ARN de alias de clave: un ARN para un alias de clave, por ejemplo arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Si usa KmsKeyId, debe establecer el parámetro CreateFileSystem:Encrypted en true.

importante

EFS solo acepta claves KMS simétricas. No puede utilizar claves KMS asimétricas con sistemas de archivos de Amazon EFS.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 2048 caracteres.

Patrón: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

Obligatorio: no

PerformanceMode

El modo de desempeño del sistema de archivos. Recomendamos el modo de rendimiento generalPurpose para todos los sistemas de archivos. Los sistemas de archivos que utilizan el modo de rendimiento maxIO pueden escalar a niveles superiores de rendimiento total y operaciones por segundo, con la contrapartida de que la latencia es un poco mayor en la mayoría de las operaciones con archivos. El modo de rendimiento no se puede cambiar después de haber creado el sistema de archivos. El modo maxIO no es compatible con los sistemas de archivos One Zone.

importante

Debido a las latencias por operación más altas con una E/S máx., recomendamos utilizar el modo de rendimiento de uso general para todos los sistemas de archivos.

El valor predeterminado es generalPurpose.

Tipo: cadena

Valores válidos: generalPurpose | maxIO

Obligatorio: no

ProvisionedThroughputInMibps

El rendimiento, medido en mebibytes por segundo (MiB/s), que desea aprovisionar para el sistema de archivos que está creando. Obligatorio si ThroughputMode se establece en provisioned. Los valores válidos son de 1 a 3414 Mibps, y el límite máximo depende de la región. Para aumentar este límite, póngase en contacto con AWS Support. Para obtener más información, consulte Cuotas de Amazon EFS que puede incrementar en la Guía del usuario de Amazon EFS.

Tipo: Doble

Rango válido: valor mínimo de 1.0.

Obligatorio: no

Tags

Se utiliza para crear una o varias etiquetas asociadas al sistema de archivos. Las etiquetas son pares clave-valor que define el usuario. Asigne un nombre al sistema de archivos en el momento de su creación mediante la inclusión de un par clave-valor "Key":"Name","Value":"{value}". Cada clave debe ser única. Para obtener más información, consulte Etiquetado de recursos de AWS en la Guía de referencia general de AWS.

Tipo: matriz de objetos Tag

Obligatorio: no

ThroughputMode

Especifica el modo de rendimiento del sistema de archivos. El modo puede ser bursting, provisioned o elastic. Si establece ThroughputMode en provisioned, también debe establecer un valor para ProvisionedThroughputInMibps. Después de crear el sistema de archivos, puede disminuir el rendimiento aprovisionado del sistema de archivos o alternar los modos de rendimiento, con ciertas restricciones de tiempo. Para obtener más información, consulte Especificación del rendimiento con el modo aprovisionado en la Guía del usuario de Amazon EFS.

El valor predeterminado es bursting.

Tipo: cadena

Valores válidos: bursting | provisioned | elastic

Obligatorio: no

Sintaxis de la respuesta


HTTP/1.1 201
Content-type: application/json

{
   "AvailabilityZoneId": "string",
   "AvailabilityZoneName": "string",
   "CreationTime": number,
   "CreationToken": "string",
   "Encrypted": boolean,
   "FileSystemArn": "string",
   "FileSystemId": "string",
   "FileSystemProtection": { 
      "ReplicationOverwriteProtection": "string"
   },
   "KmsKeyId": "string",
   "LifeCycleState": "string",
   "Name": "string",
   "NumberOfMountTargets": number,
   "OwnerId": "string",
   "PerformanceMode": "string",
   "ProvisionedThroughputInMibps": number,
   "SizeInBytes": { 
      "Timestamp": number,
      "Value": number,
      "ValueInArchive": number,
      "ValueInIA": number,
      "ValueInStandard": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ThroughputMode": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 201.

El servicio devuelve los datos siguientes en formato JSON.

AvailabilityZoneId

El identificador único y coherente de la zona de disponibilidad en la que se encuentra el sistema de archivos y solo es válido para los sistemas de archivos One Zone. Por ejemplo, use1-az1 es un ID de zona de disponibilidad para la Región de AWS us-east-1 y está en la misma ubicación en todas las Cuenta de AWS.

Tipo: cadena

AvailabilityZoneName

Describe la zona de disponibilidad AWS en la que se encuentra el sistema de archivos y solo es válido para los sistemas de archivos One Zone. Para obtener más información, consulte Uso de clases de almacenamiento de EFS en la Guía del usuario de Amazon EFS.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: .+

CreationTime

Hora en que se creó el sistema de archivos, en segundos (desde 1970-01-01T 00:00:00 Z).

Tipo: marca temporal

CreationToken

La cadena opaca especificada en la solicitud.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: .+

Encrypted

Un valor booleano que, si es verdadero, indica que el sistema de archivos está cifrado.

Tipo: Booleano

FileSystemArn

Nombre de recurso de Amazon (ARN) para el sistema de archivos de EFS en el formato arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id. Ejemplo con datos de muestra: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

Tipo: cadena

FileSystemId

El ID del sistema de archivos, asignado por Amazon EFS.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

FileSystemProtection

Describe la protección del sistema de archivos.

Tipo: objeto FileSystemProtectionDescription

KmsKeyId

El ID de una AWS KMS key que se va a utilizar para proteger el sistema de archivos cifrado.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 2048 caracteres.

LifeCycleState

La fase del ciclo de vida del sistema de archivos.

Tipo: cadena

Name

Puede añadir etiquetas a un sistema de archivos, incluida una etiqueta Name. Para obtener más información, consulte CreateFileSystem. Si el sistema de archivos tiene una etiqueta Name, Amazon EFS devuelve el valor de este campo.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

NumberOfMountTargets

El número actual de destinos de montaje que tiene el sistema de archivos. Para obtener más información, consulte CreateMountTarget.

Tipo: entero

Rango válido: valor mínimo de 0.

OwnerId

La Cuenta de AWS que creó el sistema de archivos.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 255 caracteres.

Patrón: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

El modo de desempeño del sistema de archivos.

Tipo: cadena

Valores válidos: generalPurpose | maxIO

ProvisionedThroughputInMibps

Define el rendimiento aprovisionado, medido en MiB/s, para el sistema de archivos. Válido para los sistemas de archivos que utilizan ThroughputMode establecido en provisioned.

Tipo: Doble

Rango válido: valor mínimo de 0.0.

SizeInBytes

El último tamaño medido conocido (en bytes) de los datos almacenados en el sistema de archivos, en su campo Value, y el momento en que se determinó ese tamaño en su campo Timestamp. El valor de Timestamp es el número entero de segundos transcurridos desde 1970-01-01T 00:00:00 Z. El valor de SizeInBytes no representa el tamaño de una instantánea coherente del sistema de archivos, pero en última instancia es coherente cuando no hay escrituras en el sistema de archivos. Es decir, SizeInBytes representa el tamaño real solo si el sistema de archivos no se modifica durante un período superior a un par de horas. De lo contrario, el valor no es el tamaño exacto que tenía el sistema de archivos en ningún momento.

Tipo: objeto FileSystemSize

Tags

Las etiquetas asociadas al sistema de archivos, presentadas como un conjunto de objetos Tag.

Tipo: matriz de objetos Tag

ThroughputMode

Muestra el modo de rendimiento de un sistema de archivos. Para obtener más información, consulte Modos de rendimiento en la Guía del usuario de Amazon EFS.

Tipo: cadena

Valores válidos: bursting | provisioned | elastic

Errores

BadRequest

Se devuelve si la solicitud tiene un formato incorrecto o contiene un error, como un valor de parámetro no válido, o falta un parámetro obligatorio.

Código de estado HTTP: 400

FileSystemAlreadyExists

Se devuelve si el sistema de archivos que está intentando crear ya existe, con el token de creación que proporcionó.

Código de estado HTTP: 409

FileSystemLimitExceeded

Se devuelve si Cuenta de AWS ya ha creado el número máximo de sistemas de archivos permitidos por cuenta.

Código de estado HTTP: 403

InsufficientThroughputCapacity

Se devuelve si no hay suficiente capacidad para aprovisionar un rendimiento adicional. Este valor puede devolverse al intentar crear un sistema de archivos en el modo de rendimiento aprovisionado, al intentar aumentar el rendimiento aprovisionado de un sistema de archivos existente o al intentar cambiar un sistema de archivos existente del modo de rendimiento de ráfaga al de rendimiento aprovisionado. Inténtelo de nuevo más tarde.

Código de estado HTTP: 503

InternalServerError

Se devuelve si se ha producido un error en el servidor.

Código de estado HTTP: 500

ThroughputLimitExceeded

Se devuelve si el modo de rendimiento o la cantidad de rendimiento aprovisionada no se pueden cambiar porque se ha alcanzado el límite de rendimiento de 1024 MiB/s.

Código de estado HTTP: 400

UnsupportedAvailabilityZone

Se devuelve si la funcionalidad de Amazon EFS solicitada no está disponible en la zona de disponibilidad especificada.

Código de estado HTTP: 400

Ejemplos

Crear un sistema de archivos de EFS cifrado

El siguiente ejemplo envía una solicitud POST para crear un sistema de archivos en la región us-west-2 con las copias de seguridad automáticas habilitadas. La solicitud especifica myFileSystem1 como token de creación de la idempotencia.

Solicitud de muestra


POST /2015-02-01/file-systems HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T215117Z
Authorization: <...>
Content-Type: application/json
Content-Length: 42

{
  "CreationToken" : "myFileSystem1",
  "PerformanceMode" : "generalPurpose",
  "Backup": true,
  "Encrypted": true,
  "Tags":[
      {
         "Key": "Name",
         "Value": "Test Group1"
      }
   ]
}

Respuesta de ejemplo


HTTP/1.1 201 Created
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 319

{
   "ownerId":"251839141158",
   "CreationToken":"myFileSystem1",
   "Encrypted": true,
   "PerformanceMode" : "generalPurpose",
   "fileSystemId":"fs-01234567",
   "CreationTime":"1403301078",
   "LifeCycleState":"creating",
   "numberOfMountTargets":0,
   "SizeInBytes":{
       "Timestamp": 1403301078,
       "Value": 29313618372,
       "ValueInArchive": 201156,
       "ValueInIA": 675432,
       "ValueInStandard": 29312741784
   },
   "Tags":[
      {
        "Key": "Name",
        "Value": "Test Group1"
      }
   ],
   "ThroughputMode": "elastic"
}

Crear un sistema de archivos EFS cifrado con disponibilidad One Zone

El siguiente ejemplo envía una solicitud POST para crear un sistema de archivos en la región us-west-2 con las copias de seguridad automáticas habilitadas. El sistema de archivos tendrá almacenamiento One Zone en la zona de disponibilidad us-west-2b.

Solicitud de muestra


POST /2015-02-01/file-systems HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T215117Z
Authorization: <...>
Content-Type: application/json
Content-Length: 42

{
  "CreationToken" : "myFileSystem2",
  "PerformanceMode" : "generalPurpose",
  "Backup": true,
  "AvailabilityZoneName": "us-west-2b",
  "Encrypted": true,
  "ThroughputMode": "elastic",
  "Tags":[
      {
         "Key": "Name",
         "Value": "Test Group1"
      }
   ]
}

Respuesta de ejemplo


HTTP/1.1 201 Created
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 319

{
   "ownerId":"251839141158",
   "CreationToken":"myFileSystem1",
   "Encrypted": true,
   "AvailabilityZoneId": "usew2-az2", 
   "AvailabilityZoneName": "us-west-2b",
   "PerformanceMode" : "generalPurpose",
   "fileSystemId":"fs-01234567",
   "CreationTime":"1403301078",
   "LifeCycleState":"creating",
   "numberOfMountTargets":0,
   "SizeInBytes":{
       "Timestamp": 1403301078,
       "Value": 29313618372,
       "ValueInArchive": 201156,
       "ValueInIA": 675432,
       "ValueInStandard": 29312741784
   },
   "Tags":[
      {
        "Key": "Name",
        "Value": "Test Group1"
      }
   ],
   "ThroughputMode": "elastic"
}

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

CreateAccessPoint

CreateMountTarget