Início rápido do uso do Amazon DocumentDB AWS CloudFormation

Esta seção contém etapas e outras informações para ajudá-lo a começar a usar rapidamente o Amazon DocumentDB (compativel com MongoDB) usando o AWS CloudFormation. Para obter informações gerais sobre o Amazon DocumentDB, consulte. O que é Amazon DocumentDB (compativel com MongoDB)

Essas instruções usam um AWS CloudFormation modelo para criar um cluster e instâncias em sua Amazon VPC padrão. Para obter instruções sobre a criação desses recursos por conta própria, consulte Conceitos básicos do Amazon DocumentDB.

Importante

A AWS CloudFormation pilha criada por esse modelo cria vários recursos, incluindo recursos no Amazon DocumentDB (por exemplo, um cluster e instâncias) e no Amazon Elastic Compute Cloud (por exemplo, um grupo de sub-redes).

Alguns desses recursos não são recursos de nível gratuito. Para obter informações de precificação, consulte Precificação do Amazon DocumentDB e Precificação do Amazon EC2. Você pode excluir a pilha ao terminar de usá-la para interromper as cobranças.

Essa AWS CloudFormation pilha é destinada apenas para fins de tutorial. Se você usar esse modelo para um ambiente de produção, recomendamos que use segurança e políticas do IAM mais rigorosas. Para obter informações sobre a proteção de recursos, consulte Segurança do Amazon VPC e Segurança e rede do Amazon EC2.

Pré-requisitos

Antes de criar um cluster Amazon DocumentDB, você deve ter o seguinte:

• Uma Amazon VPC padrão

• As permissões necessárias do IAM

Permissões obrigatórias do IAM

As permissões a seguir permitem que você crie recursos para a pilha do AWS CloudFormation :

AWS Políticas gerenciadas

• AWSCloudFormationReadOnlyAccess

• AmazonDocDBFullAccess

Permissões do IAM adicionais

A política a seguir descreve as permissões adicionais necessárias para criar e excluir essa AWS CloudFormation pilha.

{
   "Version": "2012-10-17",
   "Statement": [
       {
            "Effect": "Allow",
            "Action": [
                "iam:GetSSHPublicKey",
                "iam:ListSSHPublicKeys",
                "iam:CreateRole",
                "iam:CreatePolicy",
                "iam:PutRolePolicy",
                "iam:CreateInstanceProfile",
                "iam:AddRoleToInstanceProfile",
                "iam:GetAccountSummary",
                "iam:ListAccountAliases",
                "iam:GetRole",
                "iam:DeleteRole",
                "iam:RemoveRoleFromInstanceProfile",
                "iam:DeleteRolePolicy",
                "iam:DeleteInstanceProfile",
                "cloudformation:*Stack",
                "ec2:DescribeKeyPairs",
                "ec2:*Vpc",
                "ec2:DescribeInternetGateways",
                "ec2:*InternetGateway",
                "ec2:createTags",
                "ec2:*VpcAttribute",
                "ec2:DescribeRouteTables",
                "ec2:*RouteTable",
                "ec2:*Subnet",
                "ec2:*SecurityGroup",
                "ec2:AuthorizeSecurityGroupIngress",
                "ec2:DescribeVpcEndpoints",
                "ec2:*VpcEndpoint",
                "ec2:*SubnetAttribute",
                "ec2:*Route",
                "ec2:*Instances",
                "ec2:DeleteVpcEndpoints"
            ],
            "Resource": "*"
        },
        {
            "Sid": "iamPassRole",
            "Effect": "Allow",
            "Action": "iam:PassRole",
            "Resource": "*",
            "Condition": {
                "StringEquals": {
                    "iam:PassedToService": "rds.amazonaws.com"
                }
            }
        }
   ]
}

nota

As permissões em negrito na política anterior só são necessárias para excluir uma pilha: iam:DeleteRole, iam:RemoveRoleFromInstanceProfile, iam:DeleteRolePolicy, iam:DeleteInstanceProfile e ec2:DeleteVpcEndpoints. Observe também que ec2:*Vpc concede ec2:DeleteVpc permissões.

Pares de chave do Amazon EC2

Você deve ter um par de chaves (e o arquivo PEM) disponível na região em que você criará a AWS CloudFormation pilha. Se você precisar criar um par de chaves, consulte Criação de um par de chaves usando o Amazon EC2 no Guia do usuário do Amazon EC2.

Início de uma pilha AWS CloudFormation do Amazon DocumentDB

Esta seção descreve como executar e configurar uma pilha AWS CloudFormation do Amazon DocumentDB.

1. Faça login no AWS Management Console athttps://console.aws.amazon.com/.

2. A tabela a seguir lista os modelos de pilha do Amazon DocumentDB para cada Região da AWS. Escolha Launch Stack para o local em que Região da AWS você deseja lançar sua pilha.

   Região	Visualizar modelo	Visualizar no Designer	Executar
   Leste dos EUA (Ohio)	Visualizar modelo	Visualizar no Designer
   Leste dos EUA (Norte da Virgínia)	Visualizar modelo	Visualizar no Designer
   Oeste dos EUA (Oregon)	Visualizar modelo	Visualizar no Designer
   Ásia-Pacífico (Mumbai)	Visualizar modelo	Visualizar no Designer
   Ásia-Pacífico (Seul)	Visualizar modelo	Visualizar no Designer
   Ásia-Pacífico (Singapura)	Visualizar modelo	Visualizar no Designer
   Ásia-Pacífico (Sydney)	Visualizar modelo	Visualizar no Designer
   Ásia-Pacífico (Tóquio)	Visualizar modelo	Visualizar no Designer
   Canadá (Central)	Visualizar modelo	Visualizar no Designer
   Europa (Frankfurt)	Visualizar modelo	Visualizar no Designer
   Europa (Irlanda)	Visualizar modelo	Visualizar no Designer
   Europa (Londres)	Visualizar modelo	Visualizar no Designer
   Europa (Paris)	Visualizar modelo	Visualizar no Designer

3. Criar pilha - descreve o modelo do Amazon DocumentDB selecionado. Cada pilha é baseada em um modelo — um arquivo JSON ou YAML — que contém a configuração sobre os AWS recursos que você deseja incluir na pilha. Como você optou por iniciar uma pilha a partir dos modelos fornecidos acima, seu modelo já foi configurado para criar uma pilha Amazon DocumentDB para Região da AWS a pilha que você escolheu.

   Quando você executa uma AWS CloudFormation pilha, a proteção contra exclusão do seu cluster Amazon DocumentDB é desativada por padrão. Se desejar habilitar a proteção contra exclusão para o cluster, conclua as etapas a seguir. Caso contrário, escolha Next (Próximo) para seguir para a próxima etapa.

   Para habilitar a proteção contra exclusão para o cluster do Amazon DocumentDB:

   1. Escolha Visualizar no Designer, no canto inferior direito da página Criar pilha.

   2. Modifique o modelo usando o editor JSON e YAML integrado na página resultante do AWS CloudFormation Designer do console. Role até a seção Resources e modifique-a para incluir DeletionProtection, conforme segue. Para obter mais informações sobre como usar o AWS CloudFormation Designer, consulte O que é o AWS CloudFormation Designer? .

      JSON:

      "Resources": {
          "DBCluster": {
              "Type": "AWS::DocDB::DBCluster",
              "DeletionPolicy": "Delete",
              "Properties": {
                  "DBClusterIdentifier": {
                      "Ref": "DBClusterName"
                  },
                  "MasterUsername": {
                      "Ref": "MasterUser"
                  },
                  "MasterUserPassword": { 
                      "Ref": "MasterPassword"
                  }, 
                  "DeletionProtection": "true"
              }
          },

      YAML:

      Resources:
        DBCluster:
          Type: 'AWS::DocDB::DBCluster'
          DeletionPolicy: Delete
          Properties:
            DBClusterIdentifier: !Ref DBClusterName
            MasterUsername: !Ref MasterUser
            MasterUserPassword: !Ref MasterPassword
            DeletionProtection: 'true'

   3. Escolha Create Stack (Criar Pilha) ( ) no canto superior esquerdo da página para salvar as alterações e criar uma pilha com essas alterações ativadas.

   4. Depois de salvar as alterações, você será redirecionado para a página Create stack (Criar pilha).

   5. Escolha Próximo para continuar.

4. Especificar detalhes da pilha - insira o nome e os parâmetros da pilha do modelo. Os parâmetros são definidos em seu modelo e permitem que você insira valores personalizados ao criar ou atualizar uma pilha.

   • Em Nome da pilha, insira um nome para a pilha ou aceite o nome fornecido. O nome da pilha pode incluir letras (A – Z e a –z), números (0 – 9) e traços (–).

   • Em Parâmetros, insira os seguintes detalhes:

     • DB ClusterName — Insira um nome para seu cluster Amazon DocumentDB ou aceite o nome fornecido.

       Restrições de nomeação de cluster:

       • O comprimento é de [1 a 63] letras, números ou hífens.

       • O primeiro caractere deve ser uma letra.

       • Não podem terminar com um hífen ou conter dois hífens consecutivos.

       • Deve ser exclusivo para todos os clusters no Amazon RDS, Neptune e Amazon DocumentDB por região. Conta da AWS

     • DB InstanceClass — Na lista suspensa, selecione a classe de instância para seu cluster Amazon DocumentDB.

     • DB InstanceName — Insira um nome para sua instância do Amazon DocumentDB ou aceite o nome fornecido.

       Restrições de nomenclatura da instância:

       • O comprimento é de [1 a 63] letras, números ou hifens.

       • O primeiro caractere deve ser uma letra.

       • Não podem terminar com um hífen ou conter dois hífens consecutivos.

       • Deve ser exclusivo para todas as instâncias do Amazon RDS, Neptune e Amazon DocumentDB por região. Conta da AWS

     • MasterPassword— A senha da conta de administrador do banco de dados.

     • MasterUser— O nome de usuário da conta de administrador do banco de dados. O MasterUser deve começar com uma letra e só pode conter caracteres alfanuméricos.

   Escolha Próximo para salvar as alterações e continuar.

5. Configurar opções de pilha - configure as tags, permissões e opções adicionais da pilha.

   • Tags - especifique os pares de tags (chave/valor) a serem aplicados aos recursos na pilha. Você pode adicionar até 50 tags exclusivas para cada pilha.

   • Permissões: opcionais. Escolha uma função do IAM para definir explicitamente como AWS CloudFormation criar, modificar ou excluir recursos na pilha. Se você não escolher uma função, AWS CloudFormation use as permissões com base nas suas credenciais de usuário. Antes de especificar um perfil de serviço, certifique-se de ter permissão para aprová-la (iam:PassRole). A permissão iam:PassRole especifica quais perfis você pode usar.

     nota

     Quando você especifica uma função de serviço, AWS CloudFormation sempre usa essa função para todas as operações que são executadas nessa pilha. Outros usuários com permissão para executar operações nessa pilha poderão usar esse perfil, mesmo que não tenham permissão para aprová-la. Se o perfil inclui permissões que o usuário não precisa, você pode ampliar involuntariamente as permissões de um usuário. Certifique-se de que o perfil conceda o privilégio mínimo.

   • Opções avançadas - você pode definir as seguintes opções avançadas:

     • Política de pilha: opcional. Define os recursos que você deseja proteger contra atualizações não intencionais durante uma atualização da pilha. Por padrão, todos os recursos podem ser atualizados durante uma atualização da pilha.

       É possível inserir a política de pilha diretamente como JSON ou fazer upload de um arquivo JSON que contém a política de pilha. Para obter mais informações, consulte Prevenir atualizações de recursos de pilha.

     • Configuração de reversão: opcional. Especifique CloudWatch os alarmes de registros AWS CloudFormation para monitorar ao criar e atualizar a pilha. Se a operação ultrapassar um limite de alarme, AWS CloudFormation reverta-a.

     • Opções de notificação: opcional. Especifique tópicos para o Simple Notification System (SNS).

     • Opções de criação de pilha: opcionais. Você pode especificar as seguintes opções:

       • Reversão em caso de falha - se a pilha deve ou não ser revertida em caso de falha na criação.

       • Tempo limite - o número de minutos antes da criação da pilha expirar.

       • Proteção contra encerramento - impede que a pilha seja excluída acidentalmente.

         nota

         AWS CloudFormation a proteção contra encerramento é diferente do conceito de proteção contra exclusão do Amazon DocumentDB. Para ter mais informações, consulte Proteção contra encerramento e exclusão.

   Escolha Próximo para continuar.

6. Analisar <stack-name> - analise o modelo, os detalhes e as opções de configuração da pilha. Você também pode abrir um link de quick-create na parte inferior da página para criar pilhas com estas mesmas configurações básicas.

   • Selecione Criar para criar a pilha.

   • Como alternativa, você pode escolher Criar conjunto de alterações. Um conjunto de alterações é uma pré-visualização de como esta pilha será configurada antes de sua criação. Isso permite que você examine diversas configurações antes de executar o conjunto de alterações.

Acesso ao cluster do Amazon DocumentDB

Depois que a AWS CloudFormation pilha for concluída, você poderá usar uma instância do Amazon EC2 para se conectar ao seu cluster Amazon DocumentDB. Para obter informações sobre como se conectar a uma instância do Amazon EC2 usando SSH, consulte Connect to Your Linux Instance no Guia do usuário do Amazon EC2.

Quando estiver conectado, consulte as seguintes seções, que contêm informações sobre o uso do Amazon DocumentDB.

• Etapa 4: instalar o shell do Mongo

• Excluindo um cluster do Amazon DocumentDB

Proteção contra encerramento e exclusão

É uma prática recomendada do Amazon DocumentDB habilitar a proteção contra exclusão e a proteção contra encerramento. CloudFormation a proteção contra encerramento é um recurso distintamente diferente do recurso de proteção contra exclusão do Amazon DocumentDB.

• Proteção contra encerramento — Você pode evitar que uma pilha seja excluída acidentalmente ativando a proteção contra encerramento para sua CloudFormation pilha. Se um usuário tentar excluir uma pilha com proteção contra encerramento habilitada, a exclusão falhará e a pilha, incluindo seu status, permanecerá inalterada. A proteção contra encerramento é desativada por padrão quando você cria uma pilha usando CloudFormation. Você pode ativar a proteção de encerramento em uma pilha ao criá-la. Para obter mais informações, consulte Como configurar as opções AWS CloudFormation de pilha.

• Proteção contra exclusão - o Amazon DocumentDB também oferece a capacidade de habilitar a proteção contra exclusão para um cluster. Se um usuário tentar excluir um cluster do Amazon DocumentDB com a proteção de exclusão habilitada, a exclusão falhará e o cluster permanecerá inalterado. A proteção contra exclusão, quando ativada, protege contra exclusões acidentais do Amazon DocumentDB, e. AWS Management Console AWS CLI CloudFormation Para obter mais informações sobre como habilitar e desabilitar a proteção contra exclusão para um cluster do Amazon DocumentDB, consulte Proteção contra exclusão.