CreateFileSystem - Amazon Elastic File System
Sintaxis de la solicitudURIParámetros de solicitudCuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresEjemplosVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateFileSystem

Crea un nuevo sistema de archivos vacío. La operación requiere un token de creación en la solicitud que Amazon EFS utiliza para garantizar la creación idempotente (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 sea propiedad de la persona que llama Cuenta de AWS con el token de creación especificado, esta operación hace lo siguiente:

  • Crea un nuevo sistema de archivos vacío. El sistema de archivos tendrá un identificador EFS asignado por Amazon y un estado de ciclo de vida inicialcreating.

  • 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 los casos de uso básicos, puedes usar un token UUID de creación generado aleatoriamente.

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, consulta Cómo crear un sistema de archivos en la Guía del EFS usuario de Amazon.

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, consulta los modos de EFS rendimiento de Amazon.

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

Una vez creado el sistema de archivos por completo, Amazon EFS establece su estado de ciclo de vida enavailable, momento en el que puede crear uno o más destinos de montaje para el sistema de archivos de su dispositivoVPC. Para obtener más información, consulte CreateMountTarget. Para montar el sistema de EFS archivos de Amazon en una EC2 instancia suyaVPC, utilice el destino de montaje. Para obtener más información, consulta AmazonEFS: 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 otorga una autorización adicional a la elasticfilesystem:TagResource acción para verificar si los usuarios tienen 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"
}

URIParámetros de solicitud

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

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en JSON formato.

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 sobre los sistemas de archivos One Zone, consulta los tipos de sistemas de EFS archivos en la Guía del EFS usuario de Amazon.

nota

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

Tipo: string

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, consulta Copias de seguridad automáticas en la Guía del EFS usuario de Amazon.

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

nota

AWS Backup no está disponible en todos los Regiones de AWS lugares donde Amazon EFS está disponible.

Tipo: Booleano

Obligatorio: no

CreationToken

Cadena de hasta 64 ASCII caracteres. Amazon lo EFS utiliza para garantizar una creación idempotente.

Tipo: string

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. Al crear un sistema de archivos cifrados, tiene la opción de especificar una AWS Key Management Service clave existente (KMSclave). Si no especificas una KMS clave, se utilizará la KMS clave predeterminada de AmazonEFS,/aws/elasticfilesystem, para proteger el sistema de archivos cifrados.

Tipo: Booleano

Obligatorio: no

KmsKeyId

El ID de la KMS clave que quieres usar para proteger el sistema de archivos cifrados. Este parámetro solo es necesario si desea utilizar una KMS clave que no sea la predeterminada. Si no se especifica este parámetro, EFS se utiliza la KMS clave por defecto de Amazon. Puedes especificar un identificador de KMS clave mediante los siguientes formatos:

  • 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 ejemploarn: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.

  • Alias claveARN: un ARN alias clave, por ejemploarn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Si lo usaKmsKeyId, debe establecer el CreateFileSystemparámetro:Encrypted en true.

importante

EFSsolo acepta claves simétricasKMS. No puedes usar KMS claves asimétricas con los sistemas de EFS archivos de Amazon.

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 (MiBps), 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 superior depende de la región. Para aumentar este límite, póngase en contacto con. AWS Support Para obtener más información, consulta EFSlas cuotas de Amazon que puedes aumentar en la Guía del EFS usuario de Amazon.

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, consulta AWS los recursos de etiquetado en la Guía de referencia AWS general.

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, consulta Especificar el rendimiento con el modo aprovisionado en la Guía EFSdel usuario de Amazon.

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 de HTTP 201.

El servicio devuelve los siguientes datos en JSON formato.

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 identificador de zona de disponibilidad para el Región de AWS us-east-1 y tiene la misma ubicación en todas. Cuenta de AWS

Tipo: cadena

AvailabilityZoneName

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

Tipo: string

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: string

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

El nombre del recurso de Amazon (ARN) del sistema de EFS archivos, en el formatoarn: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 AmazonEFS.

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 un usuario AWS KMS key utilizado para proteger el sistema de archivos cifrados.

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/_-]+))))$

LifeCycleState

La fase del ciclo de vida del sistema de archivos.

Tipo: cadena

Valores válidos: creating | available | updating | deleting | deleted | error

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 Name etiqueta, 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

El 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

La cantidad de rendimiento aprovisionada, medida en MiBps, 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, consulta Modos de rendimiento en la Guía del EFS usuario de Amazon.

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.

HTTPCódigo de estado: 400

FileSystemAlreadyExists

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

HTTPCódigo de estado: 409

FileSystemLimitExceeded

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

HTTPCódigo de estado: 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.

HTTPCódigo de estado: 503

InternalServerError

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

HTTPCódigo de estado: 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.

HTTPCódigo de estado: 400

UnsupportedAvailabilityZone

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

HTTPCódigo de estado: 400

Ejemplos

Cree un sistema de EFS archivos cifrados

El siguiente ejemplo envía una POST solicitud para crear un sistema de archivos en la us-west-2 región con las copias de seguridad automáticas activadas. 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"
}

Cree un sistema de EFS archivos cifrados con disponibilidad en One Zone

El siguiente ejemplo envía una POST solicitud para crear un sistema de archivos en la us-west-2 región con las copias de seguridad automáticas activadas. 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 cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: