Chave KMS | Atualização (revisão obrigatória) - Referência avançada de tipo de alteração do AMS
Detalhes do tipo de alteraçãoInformações adicionaisParâmetros de entrada de execuçãoExemplo: parâmetros obrigatóriosExemplo: Todos os parâmetros

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

Chave KMS | Atualização (revisão obrigatória)

Solicite uma atualização de uma chave KMS.

Classificação completa: Gerenciamento | Componentes avançados da pilha | Chave KMS | Atualização (revisão necessária)

Detalhes do tipo de alteração

ID do tipo de alteração

ct-3ovo7px2vsa6n

Versão atual

3.0

Duração esperada da execução

240 minutos

Aprovação da AWS

Obrigatório

Aprovação do cliente

Não é necessário se o remetente

Modo de execução

Manual

Informações adicionais

Atualizar a chave KMS (revisão necessária)

Captura de tela desse tipo de alteração no console AMS:

Update KMS Key interface showing ID, execution mode, version, and classification details.

Como funciona:

  1. Navegue até a página Criar RFC: No painel de navegação esquerdo do console AMS, clique RFCspara abrir a página da RFCs lista e, em seguida, clique em Criar RFC.

  2. Escolha um tipo de alteração popular (CT) na visualização padrão Procurar tipos de alteração ou selecione uma CT na visualização Escolher por categoria.

    • Navegar por tipo de alteração: você pode clicar em um CT popular na área de criação rápida para abrir imediatamente a página Executar RFC. Observe que você não pode escolher uma versão mais antiga do CT com a criação rápida.

      Para classificar CTs, use a área Todos os tipos de alteração na exibição Cartão ou Tabela. Em qualquer exibição, selecione uma CT e clique em Criar RFC para abrir a página Executar RFC. Se aplicável, a opção Criar com uma versão mais antiga aparece ao lado do botão Criar RFC.

    • Escolha por categoria: selecione uma categoria, subcategoria, item e operação e a caixa de detalhes do CT será aberta com a opção Criar com uma versão mais antiga, se aplicável. Clique em Criar RFC para abrir a página Executar RFC.

  3. Na página Executar RFC, abra a área do nome do CT para ver a caixa de detalhes do CT. É necessário um Assunto (preenchido se você escolher seu CT na visualização Procurar tipos de alteração). Abra a área Configuração adicional para adicionar informações sobre o RFC.

    Na área Configuração de execução, use as listas suspensas disponíveis ou insira valores para os parâmetros necessários. Para configurar parâmetros de execução opcionais, abra a área Configuração adicional.

  4. Ao terminar, clique em Executar. Se não houver erros, a página RFC criada com sucesso será exibida com os detalhes da RFC enviada e a saída inicial de execução.

  5. Abra a área Parâmetros de execução para ver as configurações que você enviou. Atualize a página para atualizar o status de execução do RFC. Opcionalmente, cancele a RFC ou crie uma cópia dela com as opções na parte superior da página.

Como funciona:

  1. Use o Inline Create (você emite um create-rfc comando com todos os parâmetros de RFC e execução incluídos) ou o Template Create (você cria dois arquivos JSON, um para os parâmetros RFC e outro para os parâmetros de execução) e emita o create-rfc comando com os dois arquivos como entrada. Ambos os métodos são descritos aqui.

  2. Envie o aws amscm submit-rfc --rfc-id ID comando RFC: com o ID RFC retornado.

    Monitore o aws amscm get-rfc --rfc-id ID comando RFC:.

Para verificar a versão do tipo de alteração, use este comando:

aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID
nota

Você pode usar qualquer CreateRfc parâmetro com qualquer RFC, independentemente de eles fazerem parte do esquema para o tipo de alteração. Por exemplo, para receber notificações quando o status da RFC mudar, adicione essa linha --notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}" à parte dos parâmetros da RFC da solicitação (não aos parâmetros de execução). Para obter uma lista de todos os CreateRfc parâmetros, consulte a Referência da API de gerenciamento de alterações do AMS.

CRIAÇÃO EM LINHA:

Execute o comando create RFC com os parâmetros de execução fornecidos em linha (aspas de escape ao fornecer parâmetros de execução em linha) e, em seguida, envie a ID de RFC retornada. Por exemplo, você pode substituir o conteúdo por algo assim:

aws amscm create-rfc --change-type-id "ct-3ovo7px2vsa6n" --change-type-version "3.0" --title "TITLE" --execution-parameters "{\"KeyDescription\": \"Example description\", \"KeyPermissions\": \"key permissions\", \"PolicyAction\": \"Replace\", \"Operation\": \"Update\"}"

CRIAÇÃO DE MODELO:

  1. Exiba os parâmetros de execução do esquema JSON para esse tipo de alteração em um arquivo; este exemplo o chama de .json: UpdateKmsKeyParams

    aws amscm get-change-type-version --change-type-id "ct-3ovo7px2vsa6n" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateKmsKeyParams.json

  2. Modifique e salve o UpdateKmsKeyParams arquivo. Por exemplo, você pode substituir o conteúdo por algo assim:

    {
"KeyDescription": "KMS key request",
"PolicyAction": "Replace",
"KeyPermissions": {"Id":"key-consolepolicy-3","Version": "2012-10-17",		 	 	 "Statement":[{"Sid":"Allow use of the key","Effect":"Allow","Principal":{"AWS":["arn:aws:iam::111122223333:role/KMSRole"]},"Action":["kms:Encrypt","kms:Decrypt","kms:ReEncrypt*","kms:GenerateDataKey*","kms:DescribeKey"],"Resource":"*"}]},
"Operation": "Update"
}

  3. Envie o arquivo JSON do modelo RFC para um arquivo; este exemplo o chama de .json: UpdateKmsKeyRfc

    aws amscm create-rfc --generate-cli-skeleton > UpdateKmsKeyRfc.json

  4. Modifique e salve o UpdateKmsKeyRfc arquivo.json. Por exemplo, você pode substituir o conteúdo por algo assim:

    {
"ChangeTypeVersion":    "3.0",
"ChangeTypeId":         "ct-3ovo7px2vsa6n",
"Title":                "KmsKey-Update-RFC"
}

  5. Crie o RFC, especificando o arquivo UpdateKmsKey Rfc e o arquivo: UpdateKmsKeyParams 

    aws amscm create-rfc --cli-input-json file://UpdateKmsKeyRfc.json  --execution-parameters file://UpdateKmsKeyParams.json

    Você recebe a ID da nova RFC na resposta e pode usá-la para enviar e monitorar a RFC. Até que você o envie, o RFC permanece no estado de edição e não inicia.

nota

Esse tipo de alteração foi movido para a v2.0 com a adição de novas opções de parâmetros para o KeyStatus parâmetro. Agora você pode optar por cancelar uma operação de exclusão da chave KMS e ativar ou desativar a chave.

Esse é um tipo de alteração de “revisão obrigatória” (um operador de AMS deve revisar e executar a CT), o que significa que a RFC pode levar mais tempo para ser executada e talvez você precise se comunicar com o AMS por meio da opção de correspondência da página de detalhes da RFC. Além disso, se você agendar uma RFC do tipo de alteração de “revisão obrigatória”, aguarde pelo menos 24 horas. Se a aprovação não ocorrer antes do horário de início programado, a RFC será rejeitada automaticamente.

Para saber mais sobre as chaves do AWS KMS, consulte AWS Key Management Service (KMS), AWS Key Management Service e AWS Key Management FAQs Service Concepts.

Parâmetros de entrada de execução

Para obter informações detalhadas sobre os parâmetros de entrada de execução, consulteEsquema para o tipo de alteração ct-3ovo7px2vsa6n.

Exemplo: parâmetros obrigatórios

{
  "TargetKeyARN": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
  "Operation": "Update"
}

Exemplo: Todos os parâmetros

{
  "KeyDescription": "Exmample description of the key to be created.",
  "TargetKeyARN": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
  "AliasName": "kms_key_name",
  "KeyStatus": "Enabled",
  "KeyRotation": true,
  "KeyPermissions": "KMS Key permissions to add: kms:Get",
  "Tags": [
    {
      "Key": "foo",
      "Value": "bar"
    },
    {
      "Key": "testkey",
      "Value": "testvalue"
    }
  ],
  "Operation": "Update",
  "Priority": "Medium"
}