Início rápido do Amazon DocumentDB usando o CloudFormation - Amazon DocumentDB
Pré-requisitosIniciar uma pilha CloudFormation do Amazon DocumentDBAcessar o cluster do Amazon DocumentDBProteção contra encerramento e exclusão

Início rápido do Amazon DocumentDB usando o CloudFormation

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

Estas instruções usam um modelo do AWS CloudFormation para criar um cluster e instâncias na 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 pilha do CloudFormation 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. É possível excluir a pilha ao terminar de usá-la para interromper as cobranças.

Essa pilha do CloudFormation serve apenas como 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 do Amazon DocumentDB, você deve fazer 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 CloudFormation:

Políticas gerenciadas pela AWS

  • AWSCloudFormationReadOnlyAccess

  • AmazonDocDBFullAccess

Permissões do IAM adicionais

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

Nos exemplos a seguir, substitua cada espaço reservado para entrada do usuário pelas informações do seu recurso.

Pares de chave do Amazon EC2

É necessário ter um par de chaves (e o arquivo PEM) disponível na Região em que criará a pilha do CloudFormation. Se precisar criar um par de chaves, consulte Criar um par de chaves usando o Amazon EC2 no Guia do usuário do Amazon EC2.

Iniciar uma pilha CloudFormation do Amazon DocumentDB

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

  1. Faça login no Console de gerenciamento da AWS em https://console.aws.amazon.com/.

  2. A tabela a seguir lista os modelos de pilha do Amazon DocumentDB para cada Região da AWS. Escolha Executar pilha para a Região da AWS na qual você deseja executar sua pilha.

    Região Visualizar modelo Visualizar no Designer início
    Leste dos EUA (Ohio) Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.
    Leste dos EUA (Norte da Virgínia) Visualizar modelo Visualizar no Designer

    Orange button labeled "Launch Stack" with an arrow icon.

    Oeste dos EUA (Oregon)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Ásia-Pacífico (Mumbai)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Ásia-Pacífico (Seul)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Ásia-Pacífico (Singapura)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Ásia-Pacífico (Sydney)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Ásia-Pacífico (Tóquio)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Canadá (Central)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Europa (Frankfurt)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Europa (Irlanda)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Europa (Londres)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

    Europa (Paris)

    		 Visualizar modelo Visualizar no Designer Orange button labeled "Launch Stack" with an arrow icon.

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

    Quando você executa uma pilha do CloudFormation, a proteção contra exclusão para o cluster do 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 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 Designer do CloudFormation resultante 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 Designer do CloudFormation, consulte O que é o Designer do CloudFormation?.

      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 Criar pilha ( Cloud icon with arrow pointing to it, representing cloud upload or storage. ) 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 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:

      • DBClusterName - insira um nome para o cluster do 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, Amazon Neptune e Amazon DocumentDB por Conta da AWS, por região.

      • DBInstanceClass - na lista suspensa, selecione a classe de instância do cluster do Amazon DocumentDB.

      • DBInstanceName - insira um nome para a 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 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 todas as instâncias no Amazon RDS, Neptune e Amazon DocumentDB por Conta da AWS, por região.

      • 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 pode conter apenas 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. É possível adicionar até 50 tags exclusivas para cada pilha.

    • Permissões: opcionais. Escolha um perfil do IAM para definir explicitamente como o CloudFormation poderá criar, modificar ou excluir recursos na pilha. Se você não escolher um perfil, o CloudFormation usará permissões com base nas 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 um perfil de serviço, o CloudFormation sempre usa esse perfil para todas as operações que serã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 os alarmes do CloudFormation para monitoramento pelo ao criar e atualizar a pilha. Se a operação violar um limiar de alarme, o CloudFormation fará a reversão.

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

      • Opções de criação de pilha: opcionais. É possível 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

          A proteção contra encerramento do CloudFormation é diferente do conceito do Amazon DocumentDB de proteção contra exclusão. Para obter 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.

Acessar o cluster do Amazon DocumentDB

Depois que a pilha do CloudFormation tiver sido concluída, você pode usar uma instância do Amazon EC2 para se conectar ao seu cluster do Amazon DocumentDB. Para obter informações sobre como se conectar a uma instância do Amazon EC2, consulte Conectar-se à sua instância do Linux 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.

Proteção contra encerramento e exclusão

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

  • Proteção contra encerramento - você pode impedir que uma pilha seja excluída acidentalmente habilitando a proteção contra encerramento para sua pilha do CloudFormation. 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 é desabilitada por padrão quando você cria uma pilha usando o CloudFormation. É possível ativar a proteção de encerramento em uma pilha ao criá-la. Para obter mais informações, consulte Configurar opções de pilha do CloudFormation.

  • 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 habilitada, protege contra exclusões acidentais no Console de gerenciamento da AWS do Amazon DocumentDB, na AWS CLI e no 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.