Trabalhar com documentos
Esta seção contém informações sobre como usar e trabalhar com documentos do SSM.
Conteúdo
- Usar documentos do SSM no State Manager Associations
- Comparar versões de documentos do SSM
- Criar um documento SSM (console)
- Criar um documento do SSM (linha de comando)
- Criar um documento do SSM (API)
- Excluir documentos do SSM personalizados
- Executar documentos do em locais remotos
- Compartilhar documentos do Systems Manager
- Pesquisando documentos do SSM
Usar documentos do SSM no State Manager Associations
Se criar um documento do State Manager para o AWS Systems Manager, você deverá associá-lo às suas instâncias gerenciadas depois que adicioná-lo ao sistema. Para ter mais informações, consulte Para obter informações, consulte Trabalhar com associações no Systems Manager..
Tenha em mente os detalhes a seguir ao usar documentos do State Manager em associações do State Manager.
-
Você pode atribuir vários documentos a um destino criando diferentes associações do State Manager que usam documentos distintos.
-
Se você criar um documento com plugins conflitantes (por exemplo, ingresso em domínio e remoção do domínio), o último plugin executado será o estado final. O State Manager não valida a sequência lógica ou o raciocínio dos comandos ou plugins no seu documento.
-
Ao processar documentos, as associações de instâncias são aplicadas primeiro e as próximas associações de grupo marcadas são aplicadas. Se uma instância fizer parte de vários grupos marcados, os documentos que fizerem parte do grupo marcado não serão executados em uma ordem específica. Se uma instância for visada diretamente em vários documentos por seu ID de instância, não haverá uma ordem de execução específica.
-
Se você alterar a versão padrão de um documento de Política do SSM para o State Manager, qualquer associação que usar esse documento começará a usar a nova versão padrão na próxima vez em que o Systems Manager aplicar a associação à instância.
-
Se você criar uma associação usando um documento SSM que foi compartilhado com você e, em seguida, o proprietário interromper esse compartilhamento, suas associações não terão mais acesso a ele. No entanto, se o proprietário compartilhar o mesmo documento SSM com você novamente mais tarde, suas associações serão automaticamente remapeadas para esse documento.
Comparar versões de documentos do SSM
Você pode comparar as diferenças de conteúdo entre versões doAWS Systems Manager(SSM) no console Documents do Systems Manager. Ao comparar versões de um documento SSM, as diferenças entre o conteúdo das versões são realçadas.
Para comparar o conteúdo do documento SSM (console)
Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/
. No painel de navegação, escolha Documents.
-
Na lista de documentos, escolha o documento cujo conteúdo você deseja comparar.
-
NoConteúdo, selecioneComparar versõesE escolha a versão do documento com a qual você deseja comparar o conteúdo.
Criar um documento SSM (console)
Depois que criar o conteúdo do documento SSM personalizado, conforme descrito em Escrever conteúdo de documento do , você poderá usar o console do Systems Manager para criar um documento do SSM usando seu conteúdo.
Para criar um documento SSM (console)
Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/
. No painel de navegação, escolha Documents.
-
Escolha Create command or session (Criar comando ou sessão).
-
Insira um nome descritivo para o documento
-
(Opcional) No Tipo de destino, especifique o tipo de recursos nos quais o documento pode ser executado.
-
Na lista Document type (Tipo de documento), escolha o tipo de documento que você deseja criar.
-
Exclua os parênteses no campo Content (Conteúdo) e cole o conteúdo do documento que você criou anteriormente.
-
(Opcional) Na seção Tags de documento, aplique um ou mais pares de nome/valor de chave de tag ao documento.
Tags são metadados opcionais que você atribui a um recurso. As tags permitem categorizar um recurso de diferentes formas, como por finalidade, proprietário ou ambiente. Por exemplo, você pode querer marcar um documento para identificar o tipo de tarefas que ele executa, o tipo de sistemas operacionais que ele direciona e o ambiente em que ele é executado. Nesse caso, você pode especificar os seguintes pares de nome/valor:
-
Key=TaskType,Value=MyConfigurationUpdate
-
Key=OS,Value=AMAZON_LINUX_2
-
Key=Environment,Value=Production
Para obter mais informações sobre como marcar um recurso do Systems Manager, consulte Marcar recursos do Systems Manager.
-
-
Escolha Create document (Criar documento) para salvar o documento.
Criar um documento do SSM (linha de comando)
Depois que criar o conteúdo para o documento do AWS Systems Manager personalizado, conforme descrito em Escrever conteúdo de documento do , você poderá usar a AWS Command Line Interface ou a AWS CLI para criar um documento do AWS Tools for PowerShell usando seu conteúdo. Isso é mostrado no comando a seguir.
Antes de começar
Instale e configure a AWS CLI ou o AWS Tools for PowerShell, caso ainda não o tenha feito. Para obter informações, consulte Instalar ou atualizar a versão mais recente da AWS CLI e Instalar o AWS Tools for PowerShell.
Execute o seguinte comando . Substitua cada espaço reservado para recurso de exemplo
por suas próprias informações.
Se houver êxito, o comando retornará uma resposta semelhante à seguinte.
{ "DocumentDescription":{ "CreatedDate":1.585061751738E9, "DefaultVersion":"1", "Description":"MyCustomDocument", "DocumentFormat":"JSON", "DocumentType":"Command", "DocumentVersion":"1", "Hash":"0d3d879b3ca072e03c12638d0255ebd004d2c65bd318f8354fcde820dEXAMPLE", "HashType":"Sha256", "LatestVersion":"1", "Name":"Example", "Owner":"111122223333", "Parameters":[ --truncated-- ], "PlatformTypes":[ "Windows", "Linux" ], "SchemaVersion":"0.3", "Status":"Creating", "Tags": [ { "Key": "Purpose", "Value": "Test" } ] } }
Criar um documento do SSM (API)
Depois que criar o conteúdo para o documento do AWS Systems Manager (SSM) personalizado, conforme descrito em Escrever conteúdo de documento do , você poderá usar a AWS Systems Manager ou a operação da API CreateDocument para criar um documento do SSM usando seu conteúdo. A string JSON ou YAML do parâmetro de solicitação Content
, em geral, é lida de um arquivo. As funções de amostra a seguir criam um documento do usando os SDKs para Python, Go e Java.
Para obter mais informações sobre como criar documentos personalizados, consulte Elementos e parâmetros de dados.
Excluir documentos do SSM personalizados
Se não quiser mais usar um documento SSM personalizado, você poderá excluí-lo usando a AWS Command Line Interface (AWS CLI) ou o console do AWS Systems Manager.
Para excluir um documento do SSM (AWS CLI)
-
Antes de excluir o documento, recomendamos que você desassocie todas as instâncias associadas ao documento.
Execute o comando a seguir para desassociar uma instância de um documento.
aws ssm delete-association --instance-id "123456789012" --name "
documentName
"Não haverá saída se o comando for bem-sucedido.
-
Execute o seguinte comando . Substitua cada
espaço reservado para recurso de exemplo
por suas próprias informações.Não haverá saída se o comando for bem-sucedido.
Importante
Se a
document-version
ou aversion-name
não forem fornecidas, todas as versões do documento serão excluídas.
Para excluir um documento do SSM (console)
Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/
. No painel de navegação, escolha Documents.
-
Selecione a função que você deseja excluir.
-
SelectExcluir. Quando solicitado a excluir o documento, selecioneExcluir.