aws-elixir

v0.0.9

aws-elixir v0.0.9 AWS.SSM

Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instance. Using SSM, you can run scripts or commands using either EC2 Run Command or SSM Config. (SSM Config is currently available only for Windows instances.)

Run Command Run Command provides an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the Commands page in the Amazon EC2 console, AWS Tools for Windows PowerShell, or the AWS CLI.

Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (Linux or Windows).

SSM Config SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see Managing Windows Instance Configuration.

SSM Config and Run Command include the following pre-defined documents.

Amazon Pre-defined SSM Documents Name Description Platform AWS-RunShellScript Run shell scripts Linux AWS-UpdateSSMAgent Update the Amazon SSM agent Linux AWS-JoinDirectoryServiceDomain Join an AWS Directory Windows AWS-RunPowerShellScript Run PowerShell commands or scripts Windows AWS-UpdateEC2Config Update the EC2Config service Windows AWS-ConfigureWindowsUpdate Configure Windows Update settings Windows AWS-InstallApplication Install, repair, or uninstall software using an MSI package Windows AWS-InstallPowerShellModule Install PowerShell modules Windows AWS-ConfigureCloudWatch Configure Amazon CloudWatch Logs to monitor applications and systems Windows
The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to SSM and Run Command judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command at your own risk. As a security best practice, we recommend that you assign access to "AWS-*" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.

Summary

Functions

cancel_command(client, input, options \\ [])

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped

create_association(client, input, options \\ [])

Associates the specified SSM document with the specified instance

create_association_batch(client, input, options \\ [])

Associates the specified SSM document with the specified instances

create_document(client, input, options \\ [])

Creates an SSM document

delete_association(client, input, options \\ [])

Disassociates the specified SSM document from the specified instance

delete_document(client, input, options \\ [])

Deletes the SSM document and all instance associations to the document

describe_association(client, input, options \\ [])

Describes the associations for the specified SSM document or instance

describe_document(client, input, options \\ [])

Describes the specified SSM document

describe_instance_information(client, input, options \\ [])

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error

get_document(client, input, options \\ [])

Gets the contents of the specified SSM document

list_associations(client, input, options \\ [])

Lists the associations for the specified SSM document or instance

list_command_invocations(client, input, options \\ [])

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution

list_commands(client, input, options \\ [])

Lists the commands requested by users of the AWS account

list_documents(client, input, options \\ [])

Describes one or more of your SSM documents

send_command(client, input, options \\ [])

Executes commands on one or more remote instances

update_association_status(client, input, options \\ [])

Updates the status of the SSM document associated with the specified instance

Functions

cancel_command(client, input, options \\ [])

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

create_association(client, input, options \\ [])

Associates the specified SSM document with the specified instance.

When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

create_association_batch(client, input, options \\ [])

Associates the specified SSM document with the specified instances.

When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

create_document(client, input, options \\ [])

Creates an SSM document.

After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.

delete_association(client, input, options \\ [])

Disassociates the specified SSM document from the specified instance.

When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

delete_document(client, input, options \\ [])

Deletes the SSM document and all instance associations to the document.

Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

describe_association(client, input, options \\ [])

Describes the associations for the specified SSM document or instance.

describe_document(client, input, options \\ [])

Describes the specified SSM document.

describe_instance_information(client, input, options \\ [])

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

get_document(client, input, options \\ [])

Gets the contents of the specified SSM document.

list_associations(client, input, options \\ [])

Lists the associations for the specified SSM document or instance.

list_command_invocations(client, input, options \\ [])

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

list_commands(client, input, options \\ [])

Lists the commands requested by users of the AWS account.

list_documents(client, input, options \\ [])

Describes one or more of your SSM documents.

send_command(client, input, options \\ [])

Executes commands on one or more remote instances.

update_association_status(client, input, options \\ [])

Updates the status of the SSM document associated with the specified instance.