CreateLocationS3 - AWS DataSync

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á.

CreateLocationS3

Um local é um endpoint para um bucket do Amazon S3. AWS DataSyncpode usar o local como origem ou destino para copiar dados.

Para obter mais informações, consulte Criação de um local do Amazon S3.

Sintaxe da solicitação

{ "AgentArns": [ "string" ], "S3BucketArn": "string", "S3Config": { "BucketAccessRoleArn": "string" }, "S3StorageClass": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Parâmetros de solicitação

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

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

AgentArns

Se você estiver usando DataSync em um AWS posto avançado, especifique os nomes de recursos da Amazon (ARNs) dos DataSync agentes implantados em seu posto avançado. Para obter mais informações sobre como lançar um DataSync agente em um AWS posto avançado, consulte Implantar seu DataSync agente em. AWS Outposts

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

S3BucketArn

O ARN do bucket do Amazon S3. Se o bucket estiver em um AWS posto avançado, deve ser um ARN de ponto de acesso.

Tipo: String

Restrições de comprimento: comprimento máximo de 156.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$

Obrigatório: Sim

S3Config

O nome do recurso da Amazon (ARN) de uma função do AWS Identity and Access Management (IAM) usada para acessar o bucket do Amazon S3.

Para obter informações detalhadas sobre como usar essa função, consulte Criar um local para o Amazon S3 no Guia do usuário do AWS DataSync.

Tipo: objeto S3Config

Obrigatório: Sim

S3StorageClass

A classe de armazenamento do Amazon S3 na qual você deseja armazenar seus arquivos quando esse local é usado como destino de tarefa. Para buckets nasRegiões da AWS, a classe de armazenamento é padrão como Standard. Para buckets ativadosAWS Outposts, a classe de armazenamento é padrão como S3 Outposts. AWS

Para obter mais informações sobre classes de armazenamento do S3, consulte Classes de armazenamento do Amazon S3. Algumas classes de armazenamento têm comportamentos que podem afetar o custo de armazenamento do S3. Para obter informações detalhadas, consulte Considerações ao trabalhar com classes de armazenamento do S3 no. DataSync

Tipo: String

Valores válidos: STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL

Obrigatório: não

Subdirectory

Um subdiretório no bucket do Amazon S3. Esse subdiretório no Amazon S3 é usado para ler dados do local de origem do S3 ou gravar dados no destino do S3.

Tipo: String

Restrições de comprimento: comprimento máximo de 4096.

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

Obrigatório: não

Tags

O par de chave-valor que representa a tag que você deseja adicionar ao local. O valor pode ser uma string vazia. Recomendamos usar tags para nomear os recursos.

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 reenviará 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 bucket do Amazon S3 de origem criado.

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 a todas as ações, consulteErros comuns.

InternalException

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

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

Etapa 1. Permita assumir a função do IAM necessária para gravar no bucket

O exemplo a seguir mostra a política mais simples que concede as permissões necessárias AWS DataSync para acessar um bucket Amazon S3 de destino, seguida por uma função do IAM à qual a create-location-s3-iam-role política foi anexada.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "datasync.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }
"Role": { "Path": "/", "RoleName": "MyBucketAccessRole", "RoleId": "role-id", "Arn": "arn:aws:iam::account-id:role/MyBucketAccessRole", "CreateDate": "2018-07-27T02:49:23.117Z", "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "datasync.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } } }

Etapa 2. Permitir que a função de IAM criada grave no bucket

Anexe à função uma política que tenha permissões suficientes para acessar o bucket. Um exemplo dessa política é a política AWSDataSyncFullAccess gerenciada.

Para obter mais informações, consulte AWSDataSyncFullAccessno console do IAM.

Não é necessário criar essa política. Ele é gerenciado porAWS, então tudo o que você precisa fazer é especificar seu ARN no attach-role-policy comando.

IAM_POLICY_ARN='arn:aws:iam::aws:policy/AWSDataSyncFullAccess'

Etapa 3. Crie um endpoint para um bucket do Amazon S3

O exemplo a seguir cria um endpoint para um bucket do Amazon S3.

Quando o endpoint do S3 é criado, uma resposta semelhante ao segundo exemplo a seguir retorna o Amazon Resource Name (ARN) para a nova localização do Amazon S3.

Exemplo de solicitação

{ "S3BucketArn": "arn:aws:s3:::MyBucket", "S3Config": { "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/MyBucketAccessRole", }, "S3StorageClass": "STANDARD", "Subdirectory": "/MyFolder", "Tags": [ { "Key": "Name", "Value": "s3Bucket-1" } ] }

Exemplo de resposta

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

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: