CreateLocationObjectStorage - AWS DataSync
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte 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á.

CreateLocationObjectStorage

Cria um local de transferência para um sistema de armazenamento de objetos. AWS DataSync pode usar esse local como origem ou destino para transferir dados. Você pode fazer transferências com ou sem um DataSyncagente.

Antes de começar, certifique-se de compreender os pré-requisitos para trabalhar com sistemas de DataSync armazenamento de objetos.

Sintaxe da Solicitação

{
   "AccessKey": "string",
   "AgentArns": [ "string" ],
   "BucketName": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "SecretKey": "string",
   "ServerCertificate": blob,
   "ServerHostname": "string",
   "ServerPort": number,
   "ServerProtocol": "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.

AccessKey

Especifica a chave de acesso (por exemplo, um nome de usuário) se as credenciais forem necessárias para autenticação no servidor de armazenamento de objetos.

Tipo: String

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.

Padrão: ^.*$

Obrigatório: Não

AgentArns

(Opcional) Especifica os nomes de recursos da Amazon (ARNs) dos DataSync agentes que podem se conectar ao seu sistema de armazenamento de objetos. Se você estiver configurando uma transferência entre nuvens sem agente, não precisará especificar um valor para esse parâmetro.

nota

Certifique-se de configurar esse parâmetro corretamente ao criar seu local de armazenamento pela primeira vez. Você não pode adicionar ou remover agentes de um local de armazenamento depois de criá-lo.

Tipo: matriz de strings

Membros da matriz: número mínimo de 1 item. Número máximo de 4 itens.

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}:agent/agent-[0-9a-z]{17}$

Obrigatório: Não

BucketName

Especifica o nome do bucket de armazenamento de objetos envolvido na transferência.

Tipo: String

Restrições de tamanho: comprimento mínimo de 3. Tamanho máximo de 63.

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

Exigido: Sim

CmkSecretConfig

Especifica as informações de configuração de um segredo DataSync gerenciado, que inclui o SecretKey que é DataSync usado para acessar um local específico de armazenamento de objetos, com um gerenciado pelo cliente. AWS KMS key

Ao incluir esse parâmetro como parte de uma CreateLocationObjectStorage solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com o valor que você especifica para o SecretKey parâmetro para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.

Verifique se DataSync ele tem permissão para acessar a chave KMS especificada.

nota

Você pode usar CmkSecretConfig (comSecretKey) ou CustomSecretConfig (semSecretKey) para fornecer credenciais para uma CreateLocationObjectStorage solicitação. Não forneça os dois parâmetros para a mesma solicitação.

Tipo: objeto CmkSecretConfig

Obrigatório: Não

CustomSecretConfig

Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que a chave secreta de um local específico de armazenamento de objetos é armazenada em texto sem formatação. Essa configuração inclui o ARN secreto e o ARN de uma função do IAM que fornece acesso ao segredo.

nota

Você pode usar CmkSecretConfig (comSecretKey) ou CustomSecretConfig (semSecretKey) para fornecer credenciais para uma CreateLocationObjectStorage solicitação. Não forneça os dois parâmetros para a mesma solicitação.

Tipo: objeto CustomSecretConfig

Obrigatório: Não

SecretKey

Especifica a chave secreta (por exemplo, uma senha) se as credenciais forem necessárias para autenticação no servidor de armazenamento de objetos.

nota

Se você fornecer um segredo usandoSecretKey, mas não fornecer detalhes de configuração secreta usando CmkSecretConfig ouCustomSecretConfig, então DataSync armazena o token usando o segredo do Secrets Manager da sua AWS conta.

Tipo: String

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.

Padrão: ^.*$

Obrigatório: Não

ServerCertificate

Especifica uma cadeia de certificados DataSync para autenticação em seu sistema de armazenamento de objetos se o sistema usar uma autoridade de certificação (CA) privada ou autoassinada. Você deve especificar um único arquivo .pem com uma cadeia de certificados completa (por exemplo, file:///home/user/.ssh/object_storage_certificates.pem).

A cadeia de certificados pode incluir:

  • O certificado do sistema de armazenamento de objetos

  • Todos os certificados intermediários (se for o caso)

  • O certificado-raiz da CA assinante

Você pode concatenar os certificados em um arquivo .pem (que pode ter até 32.768 bytes antes da codificação base64). O exemplo de comando cat a seguir cria um arquivo object_storage_certificates.pem que inclui três certificados:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

Para usar esse parâmetro, configure ServerProtocol para HTTPS.

Tipo: objeto de dados binários codificado pelo Base64

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

Obrigatório: Não

ServerHostname

Especifica o nome de domínio ou endereço IP versão 4 (IPv4) do servidor de armazenamento de objetos ao qual seu DataSync agente se conecta.

Tipo: String

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

Padrão: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

Exigido: Sim

ServerPort

Especifica a porta em que o servidor de armazenamento de objetos aceita o tráfego de rede de entrada (por exemplo, a porta 443).

Tipo: inteiro

Intervalo válido: valor mínimo de 1. Valor máximo de 65536.

Obrigatório: Não

ServerProtocol

Especifica o protocolo que o servidor de armazenamento de objetos utiliza para se comunicar. Se não for especificado, o valor padrão será HTTPS.

Tipo: String

Valores Válidos: HTTPS | HTTP

Obrigatório: Não

Subdirectory

Especifica o prefixo de objeto do servidor de armazenamento de objetos. Se esse for um local de origem, DataSync copiará somente objetos com esse prefixo. Se esse for um local de destino, DataSync grava todos os objetos com esse prefixo.

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. Tags ajudam a gerenciar, filtrar e procurar recursos. Recomendamos criar uma etiqueta 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

Especifica o ARN da localização do sistema de armazenamento de objetos que você cria.

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

Consulte Também

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