Criando um perfil de configuração de formato livre no AWS AppConfig - AWS AppConfig

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

Criando um perfil de configuração de formato livre no AWS AppConfig

Um perfil de configuração inclui, entre outras coisas, um URI que permite AWS AppConfig localizar seus dados de configuração em seu local armazenado e um tipo de perfil. AWS AppConfig suporta dois tipos de perfil de configuração: sinalizadores de recursos e configurações de forma livre. Os perfis de configuração do sinalizador de recursos armazenam seus dados no armazenamento de configuração AWS AppConfig hospedado e o URI é simpleshosted. Para perfis de configuração de formato livre, você pode armazenar seus dados no repositório de configuração AWS AppConfig hospedado ou em qualquer um dos seguintes AWS serviços e recursos do Systems Manager:

Local Tipos de arquivos compatíveis

AWS AppConfig armazenamento de configuração hospedado

YAML, JSON e texto, se adicionados usando o. AWS Management Console Qualquer tipo de arquivo, se adicionado usando a ação AWS AppConfig CreateHostedConfigurationVersionda API.

Amazon Simple Storage Service (Amazon S3)

Any

AWS CodePipeline

Pipeline (conforme definido pelo serviço)

AWS Secrets Manager

Segredo (conforme definido pelo serviço)

AWS Systems Manager Parameter Store

Parâmetros de string padrão e seguros (conforme definido pelo Parameter Store)

AWS Systems Manager armazenamento de documentos (documentos SSM)

YAML, JSON, texto

Um perfil de configuração também pode incluir validadores opcionais para garantir que seus dados de configuração estejam sintática e semanticamente corretos. AWS AppConfig executa uma verificação usando os validadores quando você inicia uma implantação. Se algum erro for detectado, a implantação será interrompida antes de fazer qualquer alteração nos destinos da configuração.

nota

Se possível, recomendamos hospedar seus dados de configuração no armazenamento de configuração AWS AppConfig hospedado, pois ele oferece mais recursos e aprimoramentos.

Para configurações de formato livre armazenadas no repositório de configurações AWS AppConfig hospedado ou nos documentos SSM, você pode criar a configuração de forma livre usando o console do Systems Manager ao criar um perfil de configuração. O processo está descrito posteriormente neste tópico.

Para configurações de formato livre armazenadas no Parameter Store, Secrets Manager ou Amazon S3, você deve primeiro criar o parâmetro, segredo ou objeto e armazená-lo no respectivo armazenamento de configuração. Depois de armazenar os dados de configuração, use o procedimento neste tópico para criar o perfil de configuração.

Sobre cotas e limitações do armazenamento de configuração

Os repositórios de configuração suportados pelo AWS AppConfig têm as seguintes cotas e limitações.

AWS AppConfig armazenamento de configuração hospedado Amazon S3 Systems Manager Parameter Store AWS Secrets Manager Systems Manager Document Store AWS CodePipeline

Limite de tamanho da configuração

2 MB padrão, 4 MB no máximo

2 MB

Aplicado por AWS AppConfig, não pelo S3

4 KB (nível gratuito) / 8 KB (parâmetros avançados)

64 KB

64 KB

2 MB

Imposta por AWS AppConfig, não CodePipeline

Limite de armazenamento de recursos

1 GB

Ilimitado

10.000 parâmetros (nível gratuito) / 100.000 parâmetros (parâmetros avançados)

500.000

500 documentos

Limitado pelo número de perfis de configuração por aplicativo (100 perfis por aplicativo)

Criptografia do lado do servidor

Sim

SSE-S3, SSE-KMS

Sim

Sim

Não

Sim

AWS CloudFormation apoio

Sim

Não é para criar ou atualizar dados

Sim

Sim

Não

Sim

Definição de preço

Gratuito

Consulte Definição de preço do Amazon S3

Consulte Definição de preço do AWS Systems Manager

Consulte Definição de preço do AWS Secrets Manager

Gratuito

Consulte Definição de preço do AWS CodePipeline

Sobre o armazenamento de configuração AWS AppConfig hospedado

AWS AppConfig inclui um armazenamento de configuração interno ou hospedado. As configurações devem ter 2 MB ou menos. O armazenamento de configuração AWS AppConfig hospedado oferece os seguintes benefícios em relação a outras opções de armazenamento de configuração.

  • Não é necessário configurar outros serviços, como o Amazon Simple Storage Service (Amazon S3) ou o repositório de parâmetros.

  • Você não precisa configurar permissões AWS Identity and Access Management (IAM) para usar o armazenamento de configurações.

  • É possível armazenar configurações em YAML, JSON ou como documentos de texto.

  • Não há custo para usar o armazenamento.

  • É possível criar uma configuração e adicioná-la ao armazenamento ao criar um perfil de configuração.

Sobre configurações armazenadas no Amazon S3

Você pode armazenar configurações em um bucket do Amazon Simple Storage Service (Amazon S3). Ao criar o perfil de configuração, você especifica o URI para um único objeto do S3 em um bucket. Você também especifica o Amazon Resource Name (ARN) de uma função AWS Identity and Access Management (IAM) que dá AWS AppConfig permissão para obter o objeto. Antes de criar um perfil de configuração para um objeto do Amazon S3, lembre-se das restrições a seguir.

Restrição Detalhes

Tamanho

As configurações armazenadas como objetos do S3 podem ter um tamanho máximo de 1 MB.

Object encryption

Um perfil de configuração pode ter como alvo objetos criptografados SSE-S3 e SSE-KMS.

Classes de armazenamento

AWS AppConfig suporta as seguintes classes de armazenamento S3: STANDARDINTELLIGENT_TIERING,REDUCED_REDUNDANCY,STANDARD_IA, e. ONEZONE_IA As classes a seguir não são compatíveis: todas as classes do S3 Glacier (GLACIER e DEEP_ARCHIVE).

Versionamento

AWS AppConfig exige que o objeto S3 use o controle de versão.

Configuração de permissões para uma configuração armazenada como um objeto do Amazon S3

Ao criar um perfil de configuração para uma configuração armazenada como um objeto do S3, você deve especificar um ARN para uma função do IAM que AWS AppConfig dê permissão para obter o objeto. A função deve incluir as seguintes permissões:

Permissões para acessar o objeto do S3

  • s3: GetObject

  • s3: Versão GetObject

Permissões para listar buckets do S3

s3: ListAll MyBuckets

Permissões para acessar o bucket do S3 em que o objeto está armazenado

  • s3: Localização GetBucket

  • s3: GetBucket Controle de versão

  • s3: ListBucket

  • s3: Versões ListBucket

Conclua o procedimento a seguir para criar uma função que permita AWS AppConfig obter uma configuração armazenada em um objeto do S3.

Criação da política do IAM para acessar um objeto do S3

Use o procedimento a seguir para criar uma política do IAM que permita AWS AppConfig obter uma configuração armazenada em um objeto do S3.

Para criar uma política do IAM para acessar um objeto do S3
  1. Abra o console do IAM em https://console.aws.amazon.com/iam/.

  2. No painel de navegação, escolha Políticas e, em seguida, Criar política.

  3. Na página Criar política, escolha a guia JSON.

  4. Atualize a política de exemplo a seguir com informações sobre o bucket do S3 e o objeto de configuração. Depois, cole a política no campo de texto na guia JSON . Substitua os valores do espaço reservado por suas próprias informações.

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "arn:aws:s3:::DOC-EXAMPLE-BUCKET/my-configurations/my-configuration.json" }, { "Effect": "Allow", "Action": [ "s3:GetBucketLocation", "s3:GetBucketVersioning", "s3:ListBucketVersions", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::DOC-EXAMPLE-BUCKET" ] }, { "Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": "*" } ] }
  5. Escolha Revisar política.

  6. Na página Review policy (Revisar política), digite um nome na caixa Name (Nome) e, depois, uma descrição.

  7. Escolha Criar política. O sistema faz com que você retorne para a página Roles.

Criação do perfil do IAM para acessar um objeto do S3

Use o procedimento a seguir para criar uma função do IAM que permita AWS AppConfig obter uma configuração armazenada em um objeto do S3.

Para criar um perfil do IAM para acessar um objeto do Amazon S3
  1. Abra o console do IAM em https://console.aws.amazon.com/iam/.

  2. No painel de navegação, escolha Roles e Create role.

  3. Na seção Selecionar tipo de entidade confiável, escolha Serviço da AWS .

  4. Na seção Choose a case use (Escolher um caso de uso) em Common use cases (Casos de uso comuns), escolha EC2 e, depois, escolha Next: Permissions (Próximo: Permissões).

  5. Na página Attach permissions policy (Anexar política de permissões), na caixa de pesquisa, insira o nome da política criada no procedimento anterior.

  6. Selecione essa política e escolha Next: Tags (Próximo: Tags).

  7. Na página Adicionar tags (opcional), insira uma chave e um valor opcional e escolha Próximo: revisão.

  8. Na página Review (Revisar), digite um nome na caixa Role name (Nome da função) e, depois, uma descrição.

  9. Selecione Create role (Criar função). O sistema faz com que você retorne para a página Roles.

  10. Na página Roles (Funções), escolha a função que você acabou de criar para abrir a página Summary (Resumo). Anote os valores de Role Name (Nome da função) e Role ARN (ARN da função). Você especificará o ARN da função ao criar o perfil de configuração posteriormente neste tópico.

Criar um relacionamento de confiança

Use o procedimento a seguir para configurar a função que você acabou de criar para confiar no AWS AppConfig.

Como adicionar um relacionamento de confiança
  1. Na página Summary da função que você acabou de criar, escolha a guia Trust Relationships e, em seguida, Edit Trust Relationship.

  2. Exclua "ec2.amazonaws.com" e adicione "appconfig.amazonaws.com", conforme mostrado no exemplo a seguir.

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "appconfig.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }
  3. Escolha Update Trust Policy.

Criação de uma configuração de formato livre e um perfil de configuração

Esta seção descreve como criar uma configuração de formato livre e um perfil de configuração. Antes de começar, anote as informações a seguir.

  • O procedimento a seguir requer que você especifique um perfil de serviço do IAM para que o AWS AppConfig possa acessar os dados de configuração no armazenamento de configuração escolhido. Essa função não é necessária se você usar o armazenamento de configuração AWS AppConfig hospedado. Se você escolher o S3, o Parameter Store ou o armazenamento de documentos do Systems Manager, será necessário escolher um perfil do IAM existente ou a opção para que o sistema crie automaticamente o perfil para você. Para obter mais informações sobre essa função, consulte Sobre o perfil do IAM de configuração.

  • O procedimento a seguir também oferece a opção de associar uma extensão a um perfil de configuração do sinalizador de recurso. Uma extensão aumenta sua capacidade de injetar lógica ou comportamento em diferentes pontos durante o AWS AppConfig fluxo de trabalho de criação ou implantação de uma configuração. Para ter mais informações, consulte Sobre AWS AppConfig extensões.

  • Se desejar criar um perfil de configuração para configurações armazenadas no S3, será necessário configurar permissões. Para obter mais informações sobre permissões e outros requisitos para usar o S3 como um armazenamento de configuração, consulte Sobre configurações armazenadas no Amazon S3.

  • Se você deseja usar validadores, revise os detalhes e os requisitos para usá-los. Para ter mais informações, consulte Sobre validadores.

Criação de um perfil AWS AppConfig de configuração de formato livre (console)

Use o procedimento a seguir para criar um perfil de configuração de AWS AppConfig forma livre e (opcionalmente) uma configuração de forma livre usando o console. AWS Systems Manager

Para criar um perfil de configuração de formato livre
  1. Abra o AWS Systems Manager console em https://console.aws.amazon.com/systems-manager/appconfig/.

  2. No painel de navegação, escolha Aplicativos e, em seguida, escolha um aplicativo no Como criar um namespace para seu aplicativo no AWS AppConfig qual você criou.

  3. Escolha a guia Perfis de configuração e sinalizadores de recursos e, em seguida, escolha Criar configuração.

  4. Na seção Opções de configuração, escolha Configuração de forma livre.

  5. Em Nome do perfil de configuração, insira um nome para o perfil de configuração.

  6. (Opcional) Expanda Descrição e insira uma descrição.

  7. (Opcional) Expanda Opções adicionais e conclua o seguinte, conforme necessário.

    1. Na seção Associar extensões, escolha uma extensão na lista.

    2. Na seção Tags, escolha Adicionar nova tag e, em seguida, especifique uma chave e um valor opcional.

  8. Selecione Next (Próximo).

  9. Na página Especificar dados de configuração, na seção Definição de configuração, escolha uma opção.

  10. Preencha os campos da opção selecionada, conforme descrito na tabela a seguir.

    Opção selecionada Detalhes

    AWS AppConfig configuração hospedada

    Escolha Texto, JSON ou YAML e insira sua configuração no campo. Vá para a Etapa 12 neste procedimento.

    Objeto Amazon S3

    Insira o URI do objeto no campo Fonte do objeto S3 e vá para a Etapa 11 neste procedimento.

    AWS CodePipeline

    Escolha Avançar e vá para a Etapa 12 neste procedimento.

    Segredo do Secrets Manager

    Escolha o segredo na lista, vá para a Etapa 11 neste procedimento.

    AWS Systems Manager parameter

    Escolha o parâmetro na lista e vá para a Etapa 11 neste procedimento.

    AWS Systems Manager document

    1. Escolha um documento na lista ou escolha Criar novo documento.

    2. Se você escolher Criar novo documento, em Nome do documento, insira um nome. Opcionalmente, expanda Nome da versão e insira um nome para a versão do documento.

    3. Para Esquema de configuração do aplicativo, escolha o esquema JSON na lista ou escolha Criar esquema. Se escolher Criar esquema, o Systems Manager abrirá a página Criar esquema. Insira os detalhes do esquema e escolha Criar esquema de configuração do aplicativo.

    4. Na seção Content (Conteúdo) escolha YAML ou JSON e insira os dados de configuração no campo.

  11. Na seção Função de serviço, escolha Nova função de serviço para AWS AppConfig criar a função do IAM que fornece acesso aos dados de configuração. AWS AppConfig preenche automaticamente o campo Nome da função com base no nome que você inseriu anteriormente. Ou escolha Função de serviço existente. Escolha a função usando a lista Role ARN (ARN de função).

  12. Opcionalmente, na página Adicionar validadores, escolha Esquema JSON ou. AWS Lambda Se você escolher JSON Schema (Esquema JSON), insira o esquema JSON no campo. Se você escolher AWS Lambda, escolha o nome de recurso da Amazon (ARN) da função e a versão na lista.

    Importante

    Os dados de configuração armazenados em documentos do SSM devem ser validados em relação a um esquema JSON associado antes que você possa adicionar a configuração ao sistema. Os parâmetros SSM não exigem um método de validação, mas recomendamos que você crie uma verificação de validação para configurações de parâmetros SSM novas ou atualizadas usando. AWS Lambda

  13. Selecione Next (Próximo).

  14. Na página Revisar e salvar, escolha Salvar e continuar com a implantação.

Importante

Se você criou um perfil de configuração para AWS CodePipeline, deverá criar um pipeline CodePipeline que especifique AWS AppConfig como o provedor de implantação. Você não precisa executar Implantação de sinalizadores de atributos e dados de configuração no AWS AppConfig. No entanto, você deve configurar um cliente para receber atualizações de configuração do aplicativo conforme descrito em Recuperação de configurações chamando diretamente as APIs. Para obter informações sobre a criação de um pipeline que especifica AWS AppConfig como provedor de implantação, consulte Tutorial: Criar um pipeline usado AWS AppConfig como provedor de implantação no Guia do AWS CodePipeline usuário.

Vá para Implantação de sinalizadores de atributos e dados de configuração no AWS AppConfig.

Criação de um perfil AWS AppConfig de configuração de formato livre (linha de comando)

O procedimento a seguir descreve como usar o AWS CLI (no Linux ou no Windows) ou AWS Tools for PowerShell criar um perfil de configuração de AWS AppConfig formato livre. Se preferir, você pode usar AWS CloudShell para executar os comandos listados abaixo. Para obter mais informações, consulte O que é o AWS CloudShell? no Guia do usuário do AWS CloudShell .

nota

Para configurações de formato livre hospedadas no repositório de configurações AWS AppConfig hospedado, você especifica o hosted URI de localização.

Para criar um perfil de configuração usando o AWS CLI
  1. Abra AWS CLI o.

  2. Execute o comando a seguir para criar um perfil de configuração de formato livre.

    Linux
    aws appconfig create-configuration-profile \ --application-id The_application_ID \ --name A_name_for_the_configuration_profile \ --description A_description_of_the_configuration_profile \ --location-uri A_URI_to_locate_the_configuration or hosted \ --retrieval-role-arn The_ARN_of_the_IAM_role_with_permission_to_access_the_configuration_at_the_specified_LocationUri \ --tags User_defined_key_value_pair_metadata_of_the_configuration_profile \ --validators "Content=JSON_Schema_content_or_the_ARN_of_an_AWS Lambda_function,Type=JSON_SCHEMA or LAMBDA"
    Windows
    aws appconfig create-configuration-profile ^ --application-id The_application_ID ^ --name A_name_for_the_configuration_profile ^ --description A_description_of_the_configuration_profile ^ --location-uri A_URI_to_locate_the_configuration or hosted ^ --retrieval-role-arn The_ARN_of_the_IAM_role_with_permission_to_access_the_configuration_at_the_specified_LocationUri ^ --tags User_defined_key_value_pair_metadata_of_the_configuration_profile ^ --validators "Content=JSON_Schema_content_or_the_ARN_of_an_AWS Lambda_function,Type=JSON_SCHEMA or LAMBDA"
    PowerShell
    New-APPCConfigurationProfile ` -Name A_name_for_the_configuration_profile ` -ApplicationId The_application_ID ` -Description Description_of_the_configuration_profile ` -LocationUri A_URI_to_locate_the_configuration or hosted ` -RetrievalRoleArn The_ARN_of_the_IAM_role_with_permission_to_access_the_configuration_at_the_specified_LocationUri ` -Tag Hashtable_type_user_defined_key_value_pair_metadata_of_the_configuration_profile ` -Validators "Content=JSON_Schema_content_or_the_ARN_of_an_AWS Lambda_function,Type=JSON_SCHEMA or LAMBDA"
Importante

Observe as seguintes informações importantes:

Vá para Implantação de sinalizadores de atributos e dados de configuração no AWS AppConfig.