/ 
Paws-0.22
River stage two • 9 direct dependents • 11 total dependents
⭐ Starred 171 GitHub stars
/ Paws::SSM

NAME

Paws::SSM - Perl Interface to AWS Amazon Simple Systems Management Service

SYNOPSIS

use Paws;

my $obj = Paws->service('SSM');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

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.

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.

METHODS

CancelCommand(CommandId => Str, [InstanceIds => ArrayRef[Str]])

Each argument is described in detail in: Paws::SSM::CancelCommand

Returns: a Paws::SSM::CancelCommandResult instance

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.

CreateAssociation(InstanceId => Str, Name => Str, [Parameters => Paws::SSM::Parameters])

Each argument is described in detail in: Paws::SSM::CreateAssociation

Returns: a Paws::SSM::CreateAssociationResult instance

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.

CreateAssociationBatch(Entries => ArrayRef[Paws::SSM::CreateAssociationBatchRequestEntry])

Each argument is described in detail in: Paws::SSM::CreateAssociationBatch

Returns: a Paws::SSM::CreateAssociationBatchResult instance

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.

CreateDocument(Content => Str, Name => Str)

Each argument is described in detail in: Paws::SSM::CreateDocument

Returns: a Paws::SSM::CreateDocumentResult instance

Creates an SSM document.

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

DeleteAssociation(InstanceId => Str, Name => Str)

Each argument is described in detail in: Paws::SSM::DeleteAssociation

Returns: a Paws::SSM::DeleteAssociationResult instance

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.

DeleteDocument(Name => Str)

Each argument is described in detail in: Paws::SSM::DeleteDocument

Returns: a Paws::SSM::DeleteDocumentResult instance

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.

DescribeAssociation(InstanceId => Str, Name => Str)

Each argument is described in detail in: Paws::SSM::DescribeAssociation

Returns: a Paws::SSM::DescribeAssociationResult instance

Describes the associations for the specified SSM document or instance.

DescribeDocument(Name => Str)

Each argument is described in detail in: Paws::SSM::DescribeDocument

Returns: a Paws::SSM::DescribeDocumentResult instance

Describes the specified SSM document.

DescribeInstanceInformation([InstanceInformationFilterList => ArrayRef[Paws::SSM::InstanceInformationFilter], MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::SSM::DescribeInstanceInformation

Returns: a Paws::SSM::DescribeInstanceInformationResult instance

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.

GetDocument(Name => Str)

Each argument is described in detail in: Paws::SSM::GetDocument

Returns: a Paws::SSM::GetDocumentResult instance

Gets the contents of the specified SSM document.

ListAssociations(AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter], [MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::SSM::ListAssociations

Returns: a Paws::SSM::ListAssociationsResult instance

Lists the associations for the specified SSM document or instance.

ListCommandInvocations([CommandId => Str, Details => Bool, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::SSM::ListCommandInvocations

Returns: a Paws::SSM::ListCommandInvocationsResult instance

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.

ListCommands([CommandId => Str, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::SSM::ListCommands

Returns: a Paws::SSM::ListCommandsResult instance

Lists the commands requested by users of the AWS account.

ListDocuments([DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::SSM::ListDocuments

Returns: a Paws::SSM::ListDocumentsResult instance

Describes one or more of your SSM documents.

SendCommand(DocumentName => Str, InstanceIds => ArrayRef[Str], [Comment => Str, OutputS3BucketName => Str, OutputS3KeyPrefix => Str, Parameters => Paws::SSM::Parameters, TimeoutSeconds => Int])

Each argument is described in detail in: Paws::SSM::SendCommand

Returns: a Paws::SSM::SendCommandResult instance

Executes commands on one or more remote instances.

UpdateAssociationStatus(AssociationStatus => Paws::SSM::AssociationStatus, InstanceId => Str, Name => Str)

Each argument is described in detail in: Paws::SSM::UpdateAssociationStatus

Returns: a Paws::SSM::UpdateAssociationStatusResult instance

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

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues