CreateLocationEfs - AWS DataSync
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosExemplosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

CreateLocationEfs

Criar um local de transferência para um sistema de arquivos Amazon EFS. O AWS DataSync pode usar esse local como origem ou de destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync acessa os sistemas de arquivos do Amazon EFS.

Sintaxe da Solicitação

{
   "AccessPointArn": "string",
   "Ec2Config": { 
      "SecurityGroupArns": [ "string" ],
      "SubnetArn": "string"
   },
   "EfsFilesystemArn": "string",
   "FileSystemAccessRoleArn": "string",
   "InTransitEncryption": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Parâmetros da solicitação

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

AccessPointArn

Especifica o Amazon Resource Name (ARN) do ponto DataSync de acesso usado para montar seu sistema de arquivos Amazon EFS.

Para obter mais informações, consulte Acesso a sistemas de arquivos restritos.

Tipo: string

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$

Obrigatório: não

Ec2Config

Especifica a sub-rede e os grupos de segurança DataSync usados para se conectar a um dos destinos de montagem do seu sistema de arquivos Amazon EFS.

Tipo: objeto Ec2Config

Obrigatório: sim

EfsFilesystemArn

Especifica o ARN do sistema de arquivos Amazon EFS.

Tipo: string

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$

Exigido: Sim

FileSystemAccessRoleArn

Especifica uma função AWS Identity and Access Management (IAM) que permite DataSync acessar seu sistema de arquivos Amazon EFS.

Para obter informações sobre como criar essa função, consulte Criação de uma função DataSync do IAM para acesso ao sistema de arquivos.

Tipo: string

Restrições de tamanho: tamanho máximo de 2048.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$

Obrigatório: não

InTransitEncryption

Especifica se você deseja usar DataSync a criptografia Transport Layer Security (TLS) 1.2 ao transferir dados para ou do seu sistema de arquivos Amazon EFS.

Se você especificar um ponto de acesso usando AccessPointArn ou um perfil do IAM usando FileSystemAccessRoleArn, deverá definir esse parâmetro como TLS1_2.

Tipo: string

Valores Válidos: NONE | TLS1_2

Obrigatório: não

Subdirectory

Especifica um caminho de montagem para seu sistema de arquivos do Amazon EFS. É aqui que DataSync lê ou grava dados em seu sistema de arquivos (dependendo se esse é um local de origem ou destino).

Por padrão, DataSync usa o diretório raiz (ou ponto de acesso, se você fornecer um usandoAccessPointArn). Você também pode incluir subdiretórios usando barras (por exemplo, /path/to/folder).

Tipo: string

Restrições de tamanho: tamanho máximo de 4.096.

Padrão: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

Obrigatório: não

Tags

Especifica o par de chave-valor que representa uma etiqueta que você deseja adicionar ao recurso. O valor pode ser uma string vazia. Esse valor ajuda você a gerenciar, filtrar e pesquisar seus recursos. Recomendamos que você crie uma tag de nome para a sua localização.

Tipo: matriz de objetos TagListEntry

Membros da Matriz: número mínimo de 0 itens. Número máximo de 50 itens.

Obrigatório: Não

Sintaxe da Resposta

{
   "LocationArn": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

LocationArn

O nome de recurso da Amazon (ARN) do local do sistema de arquivos do Amazon EFS que você criar.

Tipo: string

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro no serviço AWS DataSync .

Código de status HTTP: 500

InvalidRequestException

Essa exceção é lançada quando o cliente envia uma solicitação malformada.

Código de status HTTP: 400

Exemplos

Exemplo de solicitação

O exemplo a seguir cria um local para um sistema de arquivos do Amazon EFS.

{
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2"
        ]
    },
    "EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}

Solicitação de amostra: criar um local para um sistema de arquivos restrito do Amazon EFS

O exemplo a seguir cria um local para um sistema de arquivos do Amazon EFS configurado para acesso restrito. Nesse tipo de cenário, talvez você precise especificar valores para AccessPointArn, FileSystemAccessRoleArn e InTransitEncryption na sua solicitação.

{
    "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0",
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
        ]
    },
    "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew",
    "InTransitEncryption": "TLS1_2",
    "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
    "LocationUri": "efs://us-east-2.fs-021345abcdef6789/",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}

Resposta da amostra

Uma resposta retorna o ARN de localização do sistema de arquivos do Amazon EFS.

{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678"
}

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: