id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
systems-manager-ug-588
|
systems-manager-ug.pdf
| 588 |
Type, choose String, StringList, or SecureString. • If you choose String, the Data type field is displayed. If you're creating a parameter to hold the resource ID for an Amazon Machine Image (AMI), select aws:ec2:image. Otherwise, keep the default text selected. • If you choose SecureString, the KMS Key ID field is displayed. If you don't provide an AWS Key Management Service AWS KMS key ID, an AWS KMS key Amazon Resource Name (ARN), an alias name, or an alias ARN, then the system uses alias/aws/ssm, which is the AWS managed key for Systems Manager. If you don't want to use this key, then you can use a customer managed key. For more information about AWS managed keys and customer managed keys, see AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide. For more information about Parameter Store and AWS KMS encryption, see How AWS Systems Manager Parameter Store Uses AWS KMS. Important Parameter Store only supports symmetric encryption KMS keys. You can't use an asymmetric encryption KMS key to encrypt your parameters. For help determining whether a KMS key is symmetric or asymmetric, see Identifying symmetric and asymmetric KMS keys in the AWS Key Management Service Developer Guide Parameter Store 2027 AWS Systems Manager User Guide • When creating a SecureString parameter in the console by using the key-id parameter with either a customer managed key alias name or an alias ARN, specify the prefix alias/ before the alias. Following is an ARN example. arn:aws:kms:us-east-2:123456789012:alias/abcd1234-ab12-cd34-ef56-abcdeEXAMPLE Following is an alias name example. alias/MyAliasName 8. In the Value box, type a value. For example, type This is my first parameter or ami-0dbf5ea29aEXAMPLE. Note Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value. If you chose SecureString, the value of the parameter is masked by default ("******") when you view it later on the parameter Overview tab, as shown in the following illlustration. Choose Show to display the parameter value. 9. (Optional) In the Tags area, apply one or more tag key-value pairs to the parameter. Tags are optional metadata that you assign to a resource. Tags allow you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs: • Key=Resource,Value=S3bucket Parameter Store 2028 AWS Systems Manager User Guide • Key=OS,Value=Windows • Key=ParameterType,Value=LicenseKey 10. Choose Create parameter. 11. In the parameters list, choose the name of the parameter you just created. Verify the details on the Overview tab. If you created a SecureString parameter, choose Show to view the unencrypted value. Note You can’t change an advanced parameter to a standard parameter. If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, delete it and recreate it as a new standard parameter. Creating a Parameter Store parameter using the AWS CLI You can use the AWS Command Line Interface (AWS CLI) to create String, StringList, and SecureString parameter types. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value. Note Parameters are only available in the AWS Region where they were created. Topics • Creating a String parameter using the AWS CLI • Creating a StringList parameter using the AWS CLI • Creating a SecureString parameter using the AWS CLI • Creating a multi-line parameter using the AWS CLI Parameter Store 2029 AWS Systems Manager User Guide Creating a String parameter using the AWS CLI 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to create a String-type parameter. Replace each example resource placeholder with your own information. Linux & macOS aws ssm put-parameter \ --name "parameter-name" \ --value "parameter-value" \ --type String \ --tags "Key=tag-key,Value=tag-value" Windows aws ssm put-parameter ^ --name "parameter-name" ^ --value "parameter-value" ^ --type String ^ --tags "Key=tag-key,Value=tag-value" -or- Run the following command to create a parameter that contains an Amazon Machine Image (AMI) ID as the parameter value. Linux & macOS aws ssm put-parameter \ --name "parameter-name" \ --value "an-AMI-id" \ --type String \ --data-type "aws:ec2:image" \ --tags "Key=tag-key,Value=tag-value" Parameter Store 2030 AWS Systems Manager Windows User Guide aws ssm put-parameter ^ --name "parameter-name" ^ --value "an-AMI-id" ^ --type String ^ --data-type "aws:ec2:image" ^ --tags "Key=tag-key,Value=tag-value" The --name
|
systems-manager-ug-589
|
systems-manager-ug.pdf
| 589 |
put-parameter \ --name "parameter-name" \ --value "parameter-value" \ --type String \ --tags "Key=tag-key,Value=tag-value" Windows aws ssm put-parameter ^ --name "parameter-name" ^ --value "parameter-value" ^ --type String ^ --tags "Key=tag-key,Value=tag-value" -or- Run the following command to create a parameter that contains an Amazon Machine Image (AMI) ID as the parameter value. Linux & macOS aws ssm put-parameter \ --name "parameter-name" \ --value "an-AMI-id" \ --type String \ --data-type "aws:ec2:image" \ --tags "Key=tag-key,Value=tag-value" Parameter Store 2030 AWS Systems Manager Windows User Guide aws ssm put-parameter ^ --name "parameter-name" ^ --value "an-AMI-id" ^ --type String ^ --data-type "aws:ec2:image" ^ --tags "Key=tag-key,Value=tag-value" The --name option supports hierarchies. For information about hierarchies, see Working with parameter hierarchies in Parameter Store. The --data-type option must be specified only if you are creating a parameter that contains an AMI ID. It validates that the parameter value you enter is a properly formatted Amazon Elastic Compute Cloud (Amazon EC2) AMI ID. For all other parameters, the default data type is text and it's optional to specify a value. For more information, see Using native parameter support in Parameter Store for Amazon Machine Image IDs. Important If successful, the command returns the version number of the parameter. Exception: If you have specified aws:ec2:image as the data type, a new version number in the response doesn't mean that the parameter value has been validated yet. For more information, see Using native parameter support in Parameter Store for Amazon Machine Image IDs. The following example adds two key-value pair tags to a parameter. Linux & macOS aws ssm put-parameter \ --name parameter-name \ --value "parameter-value" \ --type "String" \ --tags '[{"Key":"Region","Value":"East"},{"Key":"Environment", "Value":"Production"}]' Parameter Store 2031 AWS Systems Manager Windows aws ssm put-parameter ^ --name parameter-name ^ --value "parameter-value" ^ --type "String" ^ User Guide --tags [{\"Key\":\"Region1\",\"Value\":\"East1\"},{\"Key\":\"Environment1\", \"Value\":\"Production1\"}] The following example uses a parameter hierarchy in the name to create a plaintext String parameter. It returns the version number of the parameter. For more information about parameter hierarchies, see Working with parameter hierarchies in Parameter Store. Linux & macOS Parameter not in a hierarchy aws ssm put-parameter \ --name "golden-ami" \ --type "String" \ --value "ami-12345abcdeEXAMPLE" Parameter in a hierarchy aws ssm put-parameter \ --name "/amis/linux/golden-ami" \ --type "String" \ --value "ami-12345abcdeEXAMPLE" Windows Parameter not in a hierarchy aws ssm put-parameter ^ --name "golden-ami" ^ --type "String" ^ --value "ami-12345abcdeEXAMPLE" Parameter in a hierarchy Parameter Store 2032 AWS Systems Manager User Guide aws ssm put-parameter ^ --name "/amis/windows/golden-ami" ^ --type "String" ^ --value "ami-12345abcdeEXAMPLE" 3. Run the following command to view the latest parameter value and verify the details of your new parameter. aws ssm get-parameters --names "/Test/IAD/helloWorld" The system returns information like the following. { "InvalidParameters": [], "Parameters": [ { "Name": "/Test/IAD/helloWorld", "Type": "String", "Value": "My updated parameter value", "Version": 2, "LastModifiedDate": "2020-02-25T15:55:33.677000-08:00", "ARN": "arn:aws:ssm:us-east-2:123456789012:parameter/Test/IAD/ helloWorld" } ] } Run the following command to change the parameter value. It returns the version number of the parameter. aws ssm put-parameter --name "/Test/IAD/helloWorld" --value "My updated 1st parameter" --type String --overwrite Run the following command to view the parameter value history. aws ssm get-parameter-history --name "/Test/IAD/helloWorld" Run the following command to use this parameter in a command. Parameter Store 2033 AWS Systems Manager User Guide aws ssm send-command --document-name "AWS-RunShellScript" --parameters '{"commands": ["echo {{ssm:/Test/IAD/helloWorld}}"]}' --targets "Key=instanceids,Values=instance-ids" Run the following command if you only want to retrieve the parameter Value. aws ssm get-parameter --name testDataTypeParameter --query "Parameter.Value" Run the following command if you only want to retrieve the parameter Value using get- parameters. aws ssm get-parameters --names "testDataTypeParameter" --query "Parameters[*].Value" Run the following command to view the parameter metadata. aws ssm describe-parameters --filters "Key=Name,Values=/Test/IAD/helloWorld" Note Name must be capitalized. The system returns information like the following. { "Parameters": [ { "Name": "helloworld", "Type": "String", "LastModifiedUser": "arn:aws:iam::123456789012:user/JohnDoe", "LastModifiedDate": 1494529763.156, "Version": 1, "Tier": "Standard", "Policies": [] } ] } Creating a StringList parameter using the AWS CLI 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. Parameter Store 2034 AWS Systems Manager User Guide For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to create a parameter. Replace each example resource placeholder with your own information. Linux & macOS aws ssm put-parameter \ --name "parameter-name" \ --value "a-comma-separated-list-of-values" \ --type StringList \ --tags "Key=tag-key,Value=tag-value" Windows aws ssm put-parameter ^ --name "parameter-name" ^ --value "a-comma-separated-list-of-values" ^ --type StringList ^ --tags "Key=tag-key,Value=tag-value" Note If successful, the command returns the version number of the parameter. This example adds two key-value pair tags to a parameter. (Depending on the operating system type on your local machine, run one of the following commands. The version to run from a local Windows machine includes the escape characters ("\") that you need to run the command from your command line tool.) Here is a StringList example that uses
|
systems-manager-ug-590
|
systems-manager-ug.pdf
| 590 |
put-parameter \ --name "parameter-name" \ --value "a-comma-separated-list-of-values" \ --type StringList \ --tags "Key=tag-key,Value=tag-value" Windows aws ssm put-parameter ^ --name "parameter-name" ^ --value "a-comma-separated-list-of-values" ^ --type StringList ^ --tags "Key=tag-key,Value=tag-value" Note If successful, the command returns the version number of the parameter. This example adds two key-value pair tags to a parameter. (Depending on the operating system type on your local machine, run one of the following commands. The version to run from a local Windows machine includes the escape characters ("\") that you need to run the command from your command line tool.) Here is a StringList example that uses a parameter hierarchy. Linux & macOS aws ssm put-parameter \ --name /IAD/ERP/Oracle/addUsers \ --value "Milana,Mariana,Mark,Miguel" \ --type StringList Parameter Store 2035 AWS Systems Manager Windows User Guide aws ssm put-parameter ^ --name /IAD/ERP/Oracle/addUsers ^ --value "Milana,Mariana,Mark,Miguel" ^ --type StringList Note Items in a StringList must be separated by a comma (,). You can't use other punctuation or special characters to escape items in the list. If you have a parameter value that requires a comma, then use the String type. 3. Run the get-parameters command to verify the details of the parameter. For example: aws ssm get-parameters --name "/IAD/ERP/Oracle/addUsers" Creating a SecureString parameter using the AWS CLI Use the following procedure to create a SecureString parameter. Replace each example resource placeholder with your own information. Important Only the value of a SecureString parameter is encrypted. Parameter names, descriptions, and other properties aren't encrypted. Important Parameter Store only supports symmetric encryption KMS keys. You can't use an asymmetric encryption KMS key to encrypt your parameters. For help determining whether a KMS key is symmetric or asymmetric, see Identifying symmetric and asymmetric KMS keys in the AWS Key Management Service Developer Guide Parameter Store 2036 AWS Systems Manager User Guide 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run one of the following commands to create a parameter that uses the SecureString data type. Linux & macOS Create a SecureString parameter using the default AWS managed key aws ssm put-parameter \ --name "parameter-name" \ --value "parameter-value" \ --type "SecureString" Create a SecureString parameter that uses a customer managed key aws ssm put-parameter \ --name "parameter-name" \ --value "a-parameter-value, for example P@ssW%rd#1" \ --type "SecureString" --tags "Key=tag-key,Value=tag-value" Create a SecureString parameter that uses a custom AWS KMS key aws ssm put-parameter \ --name "parameter-name" \ --value "a-parameter-value, for example P@ssW%rd#1" \ --type "SecureString" \ --key-id "your-account-ID/the-custom-AWS KMS-key" \ --tags "Key=tag-key,Value=tag-value" Windows Create a SecureString parameter using the default AWS managed key aws ssm put-parameter ^ --name "parameter-name" ^ --value "parameter-value" ^ --type "SecureString" Parameter Store 2037 AWS Systems Manager User Guide Create a SecureString parameter that uses a customer managed key aws ssm put-parameter ^ --name "parameter-name" ^ --value "a-parameter-value, for example P@ssW%rd#1" ^ --type "SecureString" ^ --tags "Key=tag-key,Value=tag-value" Create a SecureString parameter that uses a custom AWS KMS key aws ssm put-parameter ^ --name "parameter-name" ^ --value "a-parameter-value, for example P@ssW%rd#1" ^ --type "SecureString" ^ --key-id " ^ --tags "Key=tag-key,Value=tag-value"account-ID/the-custom-AWS KMS-key" If you create a SecureString parameter by using the AWS managed key key in your account and Region, then you don't have to provide a value for the --key-id parameter. Note To use the AWS KMS key assigned to your AWS account and AWS Region, remove the key-id parameter from the command. For more information about AWS KMS keys, see AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide. To use a customer managed key instead of the AWS managed key assigned to your account, specify the key by using the --key-id parameter. The parameter supports the following KMS parameter formats. • Key Amazon Resource Name (ARN) example: arn:aws:kms:us-east-2:123456789012:key/key-id • Alias ARN example: arn:aws:kms:us-east-2:123456789012:alias/alias-name Parameter Store 2038 AWS Systems Manager • Key ID example: 12345678-1234-1234-1234-123456789012 • Alias Name example: alias/MyAliasName User Guide You can create a customer managed key by using the AWS Management Console or the AWS KMS API. The following AWS CLI commands create a customer managed key in the current AWS Region of your AWS account. aws kms create-key Use a command in the following format to create a SecureString parameter using the key you just created. The following example uses an obfuscated name (3l3vat3131) for a password parameter and an AWS KMS key. Linux & macOS aws ssm put-parameter \ --name /Finance/Payroll/3l3vat3131 \ --value "P@sSwW)rd" \ --type SecureString \ --key-id arn:aws:kms:us- east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e Windows aws ssm put-parameter ^ --name /Finance/Payroll/3l3vat3131 ^ --value "P@sSwW)rd" ^ --type SecureString ^ --key-id arn:aws:kms:us- east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e 3. Run the following command to verify the details of the parameter. Parameter Store 2039 AWS Systems Manager User Guide If you don't specify the with-decryption parameter, or if you specify the no-with-
|
systems-manager-ug-591
|
systems-manager-ug.pdf
| 591 |
the following format to create a SecureString parameter using the key you just created. The following example uses an obfuscated name (3l3vat3131) for a password parameter and an AWS KMS key. Linux & macOS aws ssm put-parameter \ --name /Finance/Payroll/3l3vat3131 \ --value "P@sSwW)rd" \ --type SecureString \ --key-id arn:aws:kms:us- east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e Windows aws ssm put-parameter ^ --name /Finance/Payroll/3l3vat3131 ^ --value "P@sSwW)rd" ^ --type SecureString ^ --key-id arn:aws:kms:us- east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e 3. Run the following command to verify the details of the parameter. Parameter Store 2039 AWS Systems Manager User Guide If you don't specify the with-decryption parameter, or if you specify the no-with- decryption parameter, the command returns an encrypted GUID. Linux & macOS aws ssm get-parameters \ --name "the-parameter-name-you-specified" \ --with-decryption Windows aws ssm get-parameters ^ --name "the-parameter-name-you-specified" ^ --with-decryption 4. Run the following command to view the parameter metadata. Linux & macOS aws ssm describe-parameters \ --filters "Key=Name,Values=the-name-that-you-specified" Windows aws ssm describe-parameters ^ --filters "Key=Name,Values=the-name-that-you-specified" 5. Run the following command to change the parameter value if you're not using a customer managed AWS KMS key. Linux & macOS aws ssm put-parameter \ --name "the-name-that-you-specified" \ --value "a-new-parameter-value" \ --type "SecureString" \ --overwrite Parameter Store 2040 AWS Systems Manager Windows User Guide aws ssm put-parameter ^ --name "the-name-that-you-specified" ^ --value "a-new-parameter-value" ^ --type "SecureString" ^ --overwrite -or- Run one of the following commands to change the parameter value if you are using a customer managed AWS KMS key. Linux & macOS aws ssm put-parameter \ --name "the-name-that-you-specified" \ --value "a-new-parameter-value" \ --type "SecureString" \ --key-id "the-KMSkey-ID" \ --overwrite aws ssm put-parameter \ --name "the-name-that-you-specified" \ --value "a-new-parameter-value" \ --type "SecureString" \ --key-id "account-alias/the-KMSkey-ID" \ --overwrite Windows aws ssm put-parameter ^ --name "the-name-that-you-specified" ^ --value "a-new-parameter-value" ^ --type "SecureString" ^ --key-id "the-KMSkey-ID" ^ --overwrite aws ssm put-parameter ^ Parameter Store 2041 AWS Systems Manager User Guide --name "the-name-that-you-specified" ^ --value "a-new-parameter-value" ^ --type "SecureString" ^ --key-id "account-alias/the-KMSkey-ID" ^ --overwrite 6. Run the following command to view the latest parameter value. Linux & macOS aws ssm get-parameters \ --name "the-name-that-you-specified" \ --with-decryption Windows aws ssm get-parameters ^ --name "the-name-that-you-specified" ^ --with-decryption 7. Run the following command to view the parameter value history. Linux & macOS aws ssm get-parameter-history \ --name "the-name-that-you-specified" Windows aws ssm get-parameter-history ^ --name "the-name-that-you-specified" Note You can manually create a parameter with an encrypted value. In this case, because the value is already encrypted, you don’t have to choose the SecureString parameter type. If you do choose SecureString, your parameter is doubly encrypted. Parameter Store 2042 AWS Systems Manager User Guide By default, all SecureString values are displayed as cipher-text. To decrypt a SecureString value, a user must have permission to call the AWS KMS Decrypt API operation. For information about configuring AWS KMS access control, see Authentication and Access Control for AWS KMS in the AWS Key Management Service Developer Guide. Important If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference AWS KMS. This only applies to the KMS key alias; the key ID that an alias attaches to stays the same unless you delete the whole key. Creating a multi-line parameter using the AWS CLI You can use the AWS CLI to create a parameter with line breaks. Use line breaks to break up the text in longer parameter values for better legibility or, for example, update multi-paragraph parameter content for a web page. You can include the content in a JSON file and use the --cli- input-json option, using line break characters like \n, as shown in the following example. 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to create a multi-line parameter. Linux & macOS aws ssm put-parameter \ --name "MultiLineParameter" \ --type String \ --cli-input-json file://MultiLineParameter.json Windows aws ssm put-parameter ^ --name "MultiLineParameter" ^ --type String ^ --cli-input-json file://MultiLineParameter.json Parameter Store 2043 AWS Systems Manager User Guide The following example shows the contents of the file MultiLineParameter.json. { "Value": "<para>Paragraph One</para>\n<para>Paragraph Two</para> \n<para>Paragraph Three</para>" } The saved parameter value is stored as follows. <para>Paragraph One</para> <para>Paragraph Two</para> <para>Paragraph Three</para> Creating a Parameter Store parameter using Tools for Windows PowerShell You can use AWS Tools for Windows PowerShell to create String, StringList, and SecureString parameter types. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value. Note Parameters are only available in the AWS Region where they were created. Topics • Creating a String parameter (Tools for Windows PowerShell) • Creating
|
systems-manager-ug-592
|
systems-manager-ug.pdf
| 592 |
stored as follows. <para>Paragraph One</para> <para>Paragraph Two</para> <para>Paragraph Three</para> Creating a Parameter Store parameter using Tools for Windows PowerShell You can use AWS Tools for Windows PowerShell to create String, StringList, and SecureString parameter types. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value. Note Parameters are only available in the AWS Region where they were created. Topics • Creating a String parameter (Tools for Windows PowerShell) • Creating a StringList parameter (Tools for Windows PowerShell) • Creating a SecureString parameter (Tools for Windows PowerShell) Creating a String parameter (Tools for Windows PowerShell) 1. Install and configure the AWS Tools for PowerShell (Tools for Windows PowerShell), if you haven't already. Parameter Store 2044 AWS Systems Manager User Guide For information, see Installing the AWS Tools for PowerShell. 2. Run the following command to create a parameter that contains a plain text value. Replace each example resource placeholder with your own information. Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "String" -or- Run the following command to create a parameter that contains an Amazon Machine Image (AMI) ID as the parameter value. Note To create a parameter with a tag, create the service.model.tag before hand as a variable. Here is an example. $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value" Write-SSMParameter ` -Name "parameter-name" ` -Value "an-AMI-id" ` -Type "String" ` -DataType "aws:ec2:image" ` -Tags $tag The -DataType option must be specified only if you are creating a parameter that contains an AMI ID. For all other parameters, the default data type is text. For more information, see Using native parameter support in Parameter Store for Amazon Machine Image IDs. Here is an example that uses a parameter hierarchy. Write-SSMParameter ` Parameter Store 2045 AWS Systems Manager User Guide -Name "/IAD/Web/SQL/IPaddress" ` -Value "99.99.99.999" ` -Type "String" ` -Tags $tag 3. Run the following command to verify the details of the parameter. (Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters Creating a StringList parameter (Tools for Windows PowerShell) 1. Install and configure the AWS Tools for PowerShell (Tools for Windows PowerShell), if you haven't already. For information, see Installing the AWS Tools for PowerShell. 2. Run the following command to create a StringList parameter. Replace each example resource placeholder with your own information. Note To create a parameter with a tag, create the service.model.tag before hand as a variable. Here is an example. $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value" Write-SSMParameter ` -Name "parameter-name" ` -Value "a-comma-separated-list-of-values" ` -Type "StringList" ` -Tags $tag If successful, the command returns the version number of the parameter. Here is an example. Parameter Store 2046 AWS Systems Manager User Guide Write-SSMParameter ` -Name "stringlist-parameter" ` -Value "Milana,Mariana,Mark,Miguel" ` -Type "StringList" ` -Tags $tag Note Items in a StringList must be separated by a comma (,). You can't use other punctuation or special characters to escape items in the list. If you have a parameter value that requires a comma, then use the String type. 3. Run the following command to verify the details of the parameter. (Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters Creating a SecureString parameter (Tools for Windows PowerShell) Before you create a SecureString parameter, read about the requirements for this type of parameter. For more information, see Creating a SecureString parameter using the AWS CLI. Important Only the value of a SecureString parameter is encrypted. Parameter names, descriptions, and other properties aren't encrypted. Important Parameter Store only supports symmetric encryption KMS keys. You can't use an asymmetric encryption KMS key to encrypt your parameters. For help determining whether a KMS key is symmetric or asymmetric, see Identifying symmetric and asymmetric KMS keys in the AWS Key Management Service Developer Guide 1. Install and configure the AWS Tools for PowerShell (Tools for Windows PowerShell), if you haven't already. Parameter Store 2047 AWS Systems Manager User Guide For information, see Installing the AWS Tools for PowerShell. 2. Run the following command to create a parameter. Replace each example resource placeholder with your own information. Note To create a parameter with a tag, first create the service.model.tag as a variable. Here is an example. $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value" Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "SecureString" ` -KeyId "an AWS KMS key ID, an AWS KMS key ARN, an alias name, or an alias ARN" ` -Tags $tag If successful, the command returns the version number of the parameter. Note To use the AWS managed key assigned to your account, remove the -KeyId parameter from the command. Here is an example that uses an obfuscated name (3l3vat3131) for a password parameter and an AWS managed key. Write-SSMParameter ` -Name
|
systems-manager-ug-593
|
systems-manager-ug.pdf
| 593 |
as a variable. Here is an example. $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value" Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "SecureString" ` -KeyId "an AWS KMS key ID, an AWS KMS key ARN, an alias name, or an alias ARN" ` -Tags $tag If successful, the command returns the version number of the parameter. Note To use the AWS managed key assigned to your account, remove the -KeyId parameter from the command. Here is an example that uses an obfuscated name (3l3vat3131) for a password parameter and an AWS managed key. Write-SSMParameter ` -Name "/Finance/Payroll/3l3vat3131" ` -Value "P@sSwW)rd" ` -Type "SecureString"` Parameter Store 2048 AWS Systems Manager -Tags $tag User Guide 3. Run the following command to verify the details of the parameter. (Get-SSMParameterValue -Name "the-parameter-name-you-specified" –WithDecryption $true).Parameters By default, all SecureString values are displayed as cipher-text. To decrypt a SecureString value, a user must have permission to call the AWS KMS Decrypt API operation. For information about configuring AWS KMS access control, see Authentication and Access Control for AWS KMS in the AWS Key Management Service Developer Guide. Important If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference AWS KMS. This only applies to the KMS key alias; the key ID that an alias attaches to stays the same unless you delete the whole key. Searching for Parameter Store parameters in Systems Manager When you have a lot of parameters in your account, it can be difficult to find information about a single or several parameters at a time. In this case, you can use filter tools to search for the ones you need information about, according to search criteria you specify. You can use the AWS Systems Manager console, the AWS Command Line Interface (AWS CLI), the AWS Tools for PowerShell, or the DescribeParameters API to search for parameters. Topics • Searching for a parameter using the console • Searching for a parameter using the AWS CLI Searching for a parameter using the console 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. Parameter Store 2049 AWS Systems Manager User Guide 3. Select in the search box and choose how you want to search. For example, Type or Name. 4. Provide information for the search type you selected. For example: • If you're searching by Type, choose from String, StringList, or SecureString. • If you're searching by Name, choose contains, equals, or begins-with, and then enter all or part of a parameter name. Note In the console, the default search type for Name is contains. 5. Press Enter. The list of parameters is updated with the results of your search. Searching for a parameter using the AWS CLI Use the describe-parameters command to view information about one or more parameters in the AWS CLI. The following examples demonstrate various options you can use to view information about the parameters in your AWS account. For more information about these options, see describe- parameters in the AWS Command Line Interface User Guide. 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Replace the sample values in the following commands with values reflecting parameters that have been created in your account. Linux & macOS aws ssm describe-parameters \ --parameter-filters "Key=Name,Values=MyParameterName" Windows aws ssm describe-parameters ^ --parameter-filters "Key=Name,Values=MyParameterName" Parameter Store 2050 AWS Systems Manager Note User Guide For describe-parameters, the default search type for Name is Equals. In your parameter filters, specifying "Key=Name,Values=MyParameterName" is the same as specifying "Key=Name,Option=Equals,Values=MyParameterName". aws ssm describe-parameters \ --parameter-filters "Key=Name,Option=Contains,Values=Product" aws ssm describe-parameters \ --parameter-filters "Key=Type,Values=String" aws ssm describe-parameters \ --parameter-filters "Key=Path,Values=/Production/West" aws ssm describe-parameters \ --parameter-filters "Key=Tier,Values=Standard" aws ssm describe-parameters \ --parameter-filters "Key=tag:tag-key,Values=tag-value" aws ssm describe-parameters \ --parameter-filters "Key=KeyId,Values=key-id" Note In the last example, key-id represents the ID of an AWS Key Management Service (AWS KMS) key used to encrypt a SecureString parameter created in your account. Alternatively, you can enter alias/aws/ssm to use the default AWS KMS key for your account. For more information, see Creating a SecureString parameter using the AWS CLI. Parameter Store 2051 AWS Systems Manager User Guide If successful, the command returns output similar to the following. { "Parameters": [ { "Name": "/Production/West/Manager", "Type": "String", "LastModifiedDate": 1573438580.703, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "/Production/West/TeamLead", "Type": "String", "LastModifiedDate": 1572363610.175, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "/Production/West/HR", "Type": "String", "LastModifiedDate": 1572363680.503, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] } ] } Assigning parameter policies in Parameter Store Parameter policies help you manage a growing set of parameters
|
systems-manager-ug-594
|
systems-manager-ug.pdf
| 594 |
account. For more information, see Creating a SecureString parameter using the AWS CLI. Parameter Store 2051 AWS Systems Manager User Guide If successful, the command returns output similar to the following. { "Parameters": [ { "Name": "/Production/West/Manager", "Type": "String", "LastModifiedDate": 1573438580.703, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "/Production/West/TeamLead", "Type": "String", "LastModifiedDate": 1572363610.175, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "/Production/West/HR", "Type": "String", "LastModifiedDate": 1572363680.503, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] } ] } Assigning parameter policies in Parameter Store Parameter policies help you manage a growing set of parameters by allowing you to assign specific criteria to a parameter such as an expiration date or time to live. Parameter policies are especially helpful in forcing you to update or delete passwords and configuration data stored in Parameter Parameter Store 2052 AWS Systems Manager User Guide Store, a tool in AWS Systems Manager. Parameter Store offers the following types of policies: Expiration, ExpirationNotification, and NoChangeNotification. Note To implement password rotation lifecycles, use AWS Secrets Manager. You can rotate, manage, and retrieve database credentials, API keys, and other secrets throughout their lifecycle using Secrets Manager. For more information, see What is AWS Secrets Manager? in the AWS Secrets Manager User Guide. Parameter Store enforces parameter policies by using asynchronous, periodic scans. After you create a policy, you don't need to perform additional actions to enforce the policy. Parameter Store independently performs the action defined by the policy according to the criteria you specified. Note Parameter policies are available for parameters that use the advanced parameters tier. For more information, see Managing parameter tiers. A parameter policy is a JSON array, as shown in the following table. You can assign a policy when you create a new advanced parameter, or you can apply a policy by updating a parameter. Parameter Store supports the following types of parameter policies. Policy Expiration Details Examples This policy deletes the parameter. You can specify a specific date and time by using either the ISO_INSTANT format or the ISO_OFFSET_DATE_TI ME format. To change when you want the parameter to be deleted, update the policy. Updating a parameter doesn't affect the expiration date or { "Type": "Expirati on", "Version": "1.0", "Attributes": { "Timestamp": "2018-12-02T21:34: 33.000Z" } } Parameter Store 2053 AWS Systems Manager User Guide Policy Details Examples time of the policy attached to it. When the expiration date and time is reached, Parameter Store deletes the parameter. Note This example uses the ISO_INSTA NT format. You can also specify a date and time by using the ISO_OFFSE T_DATE_TIME format. Here is an example: 2019-11-0 1T22:13:4 8.87+10:30:00 . ExpirationNotification This policy initiates an event in Amazon EventBridge { "Type": "Expirati (EventBridge) that notifies onNotification", you about the expiration. By using this policy, you can receive notifications before the expiration time is reached, in units of days or hours. "Version": "1.0", "Attributes": { "Before": "15", "Unit": "Days" } } Parameter Store 2054 AWS Systems Manager User Guide Policy Details Examples NoChangeNotification This policy initiates an event in EventBridge if a parameter { "Type": "NoChange has not been modified for a Notification", specified period of time. This policy type is useful when, for example, a password needs to be changed within a period of time. "Version": "1.0", "Attributes": { "After": "20", "Unit": "Days" } } This policy determines when to send a notification by reading the LastModif iedTime attribute of the parameter. If you change or edit a parameter, the system resets the notificat ion time period based on the new value of LastModif iedTime . You can assign multiple policies to a parameter. For example, you can assign Expiration and ExpirationNotification policies so that the system initiates an EventBridge event to notify you about the impending deletion of a parameter. You can assign a maximum of ten (10) policies to a parameter. The following example shows the request syntax for a PutParameter API request that assigns four policies to a new SecureString parameter named ProdDB3. { "Name": "ProdDB3", "Description": "Parameter with policies", "Value": "P@ssW*rd21", "Type": "SecureString", "Overwrite": "True", "Policies": [ { Parameter Store 2055 AWS Systems Manager User Guide "Type": "Expiration", "Version": "1.0", "Attributes": { "Timestamp": "2018-12-02T21:34:33.000Z" } }, { "Type": "ExpirationNotification", "Version": "1.0", "Attributes": { "Before": "30", "Unit": "Days" } }, { "Type": "ExpirationNotification", "Version": "1.0", "Attributes": { "Before": "15", "Unit": "Days" } }, { "Type": "NoChangeNotification", "Version": "1.0", "Attributes": { "After": "20", "Unit": "Days" } } ] } Adding policies to an existing parameter This section includes information about how to add policies to an existing parameter by using the AWS Systems Manager console, the AWS Command Line Interface (AWS CLI), and AWS Tools for Windows PowerShell . For information about how to create a new parameter that includes policies, see Creating Parameter Store parameters in Systems
|
systems-manager-ug-595
|
systems-manager-ug.pdf
| 595 |
{ "Type": "ExpirationNotification", "Version": "1.0", "Attributes": { "Before": "30", "Unit": "Days" } }, { "Type": "ExpirationNotification", "Version": "1.0", "Attributes": { "Before": "15", "Unit": "Days" } }, { "Type": "NoChangeNotification", "Version": "1.0", "Attributes": { "After": "20", "Unit": "Days" } } ] } Adding policies to an existing parameter This section includes information about how to add policies to an existing parameter by using the AWS Systems Manager console, the AWS Command Line Interface (AWS CLI), and AWS Tools for Windows PowerShell . For information about how to create a new parameter that includes policies, see Creating Parameter Store parameters in Systems Manager. Topics • Adding policies to an existing parameter using the console Parameter Store 2056 AWS Systems Manager User Guide • Adding policies to an existing parameter using the AWS CLI • Adding policies to an existing parameter (Tools for Windows PowerShell) Adding policies to an existing parameter using the console Use the following procedure to add policies to an existing parameter by using the Systems Manager console. To add policies to an existing parameter 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the option next to the parameter that you want to update to include policies, and then choose Edit. 4. Choose Advanced. 5. (Optional) In the Parameter policies section, choose Enabled. You can specify an expiration date and one or more notification policies for this parameter. 6. Choose Save changes. Important • Parameter Store preserves policies on a parameter until you either overwrite the policies with new policies or remove the policies. • To remove all policies from an existing parameter, edit the parameter and apply an empty policy by using brackets and curly braces, as follows: [{}] • If you add a new policy to a parameter that already has policies, then Systems Manager overwrites the policies attached to the parameter. The existing policies are deleted. If you want to add a new policy to a parameter that already has one or more policies, copy and paste the original policies, type the new policy, and then save your changes. Adding policies to an existing parameter using the AWS CLI Use the following procedure to add policies to an existing parameter by using the AWS CLI. Parameter Store 2057 AWS Systems Manager User Guide To add policies to an existing parameter 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to add policies to an existing parameter. Replace each example resource placeholder with your own information. Linux & macOS aws ssm put-parameter --name "parameter name" \ --value 'parameter value' \ --type parameter type \ --overwrite \ --policies "[{policies-enclosed-in-brackets-and-curly-braces}]" Windows aws ssm put-parameter --name "parameter name" ^ --value 'parameter value' ^ --type parameter type ^ --overwrite ^ --policies "[{policies-enclosed-in-brackets-and-curly-braces}]" Here is an example that includes an expiration policy that deletes the parameter after 15 days. The example also includes a notification policy that generates an EventBridge event five (5) days before the parameter is deleted. Last, it includes a NoChangeNotification policy if no changes are made to this parameter after 60 days. The example uses an obfuscated name (3l3vat3131) for a password and an AWS Key Management Service AWS KMS key. For more information about AWS KMS keys, see AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide. Linux & macOS aws ssm put-parameter \ --name "/Finance/Payroll/3l3vat3131" \ Parameter Store 2058 AWS Systems Manager User Guide --value "P@sSwW)rd" \ --type "SecureString" \ --overwrite \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\": {\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification \",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}}, {\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After \":\"60\",\"Unit\":\"Days\"}}]" Windows aws ssm put-parameter ^ --name "/Finance/Payroll/3l3vat3131" ^ --value "P@sSwW)rd" ^ --type "SecureString" ^ --overwrite ^ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\": {\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification \",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}}, {\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After \":\"60\",\"Unit\":\"Days\"}}]" 3. Run the following command to verify the details of the parameter. Replace parameter name with your own information. Linux & macOS aws ssm describe-parameters \ --parameter-filters "Key=Name,Values=parameter name" Windows aws ssm describe-parameters ^ --parameter-filters "Key=Name,Values=parameter name" Important • Parameter Store retains policies for a parameter until you either overwrite the policies with new policies or remove the policies. Parameter Store 2059 AWS Systems Manager User Guide • To remove all policies from an existing parameter, edit the parameter and apply an empty policy of brackets and curly braces. Replace each example resource placeholder with your own information. For example: Linux & macOS aws ssm put-parameter \ --name parameter name \ --type parameter type \ --value 'parameter value' \ --policies "[{}]" Windows aws ssm put-parameter ^ --name parameter name ^ --type parameter type ^ --value 'parameter value' ^ --policies "[{}]" • If you add a new policy to a parameter that already has policies, then Systems Manager overwrites the policies attached to the parameter. The existing policies
|
systems-manager-ug-596
|
systems-manager-ug.pdf
| 596 |
• To remove all policies from an existing parameter, edit the parameter and apply an empty policy of brackets and curly braces. Replace each example resource placeholder with your own information. For example: Linux & macOS aws ssm put-parameter \ --name parameter name \ --type parameter type \ --value 'parameter value' \ --policies "[{}]" Windows aws ssm put-parameter ^ --name parameter name ^ --type parameter type ^ --value 'parameter value' ^ --policies "[{}]" • If you add a new policy to a parameter that already has policies, then Systems Manager overwrites the policies attached to the parameter. The existing policies are deleted. If you want to add a new policy to a parameter that already has one or more policies, copy and paste the original policies, type the new policy, and then save your changes. Adding policies to an existing parameter (Tools for Windows PowerShell) Use the following procedure to add policies to an existing parameter by using Tools for Windows PowerShell. Replace each example resource placeholder with your own information. To add policies to an existing parameter 1. Open Tools for Windows PowerShell and run the following command to specify your credentials. You must either have administrator permissions in Amazon Elastic Compute Cloud (Amazon EC2), or you must have been granted the appropriate permission in AWS Identity and Access Management (IAM). Set-AWSCredentials ` –AccessKey access-key-name ` Parameter Store 2060 AWS Systems Manager User Guide –SecretKey secret-key-name 2. Run the following command to set the Region for your PowerShell session. The example uses the US East (Ohio) Region (us-east-2). Set-DefaultAWSRegion ` -Region us-east-2 3. Run the following command to add policies to an existing parameter. Replace each example resource placeholder with your own information. Write-SSMParameter ` -Name "parameter name" ` -Value "parameter value" ` -Type "parameter type" ` -Policies "[{policies-enclosed-in-brackets-and-curly-braces}]" ` -Overwrite Here is an example that includes an expiration policy that deletes the parameter at midnight (GMT) on May 13, 2020. The example also includes a notification policy that generates an EventBridge event five (5) days before the parameter is deleted. Last, it includes a NoChangeNotification policy if no changes are made to this parameter after 60 days. The example uses an obfuscated name (3l3vat3131) for a password and an AWS managed key. Write-SSMParameter ` -Name "/Finance/Payroll/3l3vat3131" ` -Value "P@sSwW)rd" ` -Type "SecureString" ` -Policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\": {\"Timestamp\":\"2018-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification \",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type \":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\", \"Unit\":\"Days\"}}]" ` -Overwrite 4. Run the following command to verify the details of the parameter. Replace parameter name with your own information. (Get-SSMParameterValue -Name "parameter name").Parameters Parameter Store 2061 AWS Systems Manager Important User Guide • Parameter Store preserves policies on a parameter until you either overwrite the policies with new policies or remove the policies. • To remove all policies from an existing parameter, edit the parameter and apply an empty policy of brackets and curly braces. For example: Write-SSMParameter ` -Name "parameter name" ` -Value "parameter value" ` -Type "parameter type" ` -Policies "[{}]" • If you add a new policy to a parameter that already has policies, then Systems Manager overwrites the policies attached to the parameter. The existing policies are deleted. If you want to add a new policy to a parameter that already has one or more policies, copy and paste the original policies, type the new policy, and then save your changes. Working with parameter hierarchies in Parameter Store Managing dozens or hundreds of parameters as a flat list is time consuming and prone to errors. It can also be difficult to identify the correct parameter for a task. This means you might accidentally use the wrong parameter, or you might create multiple parameters that use the same configuration data. You can use parameter hierarchies to help you organize and manage parameters. A hierarchy is a parameter name that includes a path that you define by using forward slashes (/). Topics • Understanding parameter hierarchy through examples • Querying parameters in a hierarchy • Managing parameters using hierarchies using the AWS CLI Understanding parameter hierarchy through examples The following example uses three hierarchy levels in the name to identify the following: Parameter Store 2062 AWS Systems Manager User Guide /Environment/Type of computer/Application/Data /Dev/DBServer/MySQL/db-string13 You can create a hierarchy with a maximum of 15 levels. We suggest that you create hierarchies that reflect an existing hierarchical structure in your environment, as shown in the following examples: • Your Continuous integration and Continuous delivery environment (CI/CD workflows) /Dev/DBServer/MySQL/db-string /Staging/DBServer/MySQL/db-string /Prod/DBServer/MySQL/db-string • Your applications that use containers /MyApp/.NET/Libraries/my-password • Your business organization /Finance/Accountants/UserList /Finance/Analysts/UserList /HR/Employees/EU/UserList Parameter hierarchies standardize the way you create parameters and make it easier to manage parameters over time. A parameter hierarchy can also help you identify the correct parameter for a configuration task. This helps you to avoid creating multiple parameters with the same configuration data. You can create a hierarchy that allows
|
systems-manager-ug-597
|
systems-manager-ug.pdf
| 597 |
We suggest that you create hierarchies that reflect an existing hierarchical structure in your environment, as shown in the following examples: • Your Continuous integration and Continuous delivery environment (CI/CD workflows) /Dev/DBServer/MySQL/db-string /Staging/DBServer/MySQL/db-string /Prod/DBServer/MySQL/db-string • Your applications that use containers /MyApp/.NET/Libraries/my-password • Your business organization /Finance/Accountants/UserList /Finance/Analysts/UserList /HR/Employees/EU/UserList Parameter hierarchies standardize the way you create parameters and make it easier to manage parameters over time. A parameter hierarchy can also help you identify the correct parameter for a configuration task. This helps you to avoid creating multiple parameters with the same configuration data. You can create a hierarchy that allows you to share parameters across different environments, as shown in the following examples that use passwords in development and staging environment. /DevTest/MyApp/database/my-password You could then create a unique password for your production environment, as shown in the following example: /prod/MyApp/database/my-password Parameter Store 2063 AWS Systems Manager User Guide You aren't required to specify a parameter hierarchy. You can create parameters at level one. These are called root parameters. For backward compatibility, all parameters created in Parameter Store before hierarchies were released are root parameters. The systems treats both of the following parameters as root parameters. /parameter-name parameter-name Querying parameters in a hierarchy Another benefit of using hierarchies is the ability to query for all parameters under a certain level in a hierarchy by using the GetParametersByPath API operation. For example, if you run the following command from the AWS Command Line Interface (AWS CLI), the system returns all parameters under the Oncall level: aws ssm get-parameters-by-path --path /Dev/Web/Oncall Sample output: { "Parameters": [ { "Name": "/Dev/Web/Oncall/Week1", "Type": "String", "Value": "John Doe", "Version": 1, "LastModifiedDate": "2024-11-22T07:18:53.510000-08:00", "ARN": "arn:aws:ssm:us-east-2:123456789012:parameter/Dev/Web/Oncall/Week1", "DataType": "text" }, { "Name": "/Dev/Web/Oncall/Week2", "Type": "String", "Value": "Mary Major", "Version": 1, "LastModifiedDate": "2024-11-22T07:21:25.325000-08:00", "ARN": "arn:aws:ssm:us-east-2:123456789012:parameter/Dev/Web/Oncall/Week2", "DataType": "text" } ] Parameter Store 2064 AWS Systems Manager } User Guide To view decrypted SecureString parameters in a hierarchy, you specify the path and the -- with-decryption parameter, as shown in the following example. aws ssm get-parameters-by-path --path /Prod/ERP/SAP --with-decryption Managing parameters using hierarchies using the AWS CLI This procedure shows how to work with parameters and parameter hierarchies by using the AWS CLI. To manage parameters using hierarchies 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to create a parameter that uses the allowedPattern parameter and the String parameter type. The allowed pattern in this example means the value for the parameter must be between 1 and 4 digits long. Linux & macOS aws ssm put-parameter \ --name "/MyService/Test/MaxConnections" \ --value 100 --allowed-pattern "\d{1,4}" \ --type String Windows aws ssm put-parameter ^ --name "/MyService/Test/MaxConnections" ^ --value 100 --allowed-pattern "\d{1,4}" ^ --type String The command returns the version number of the parameter. 3. Run the following command to attempt to overwrite the parameter you just created with a new value. Parameter Store 2065 AWS Systems Manager Linux & macOS User Guide aws ssm put-parameter \ --name "/MyService/Test/MaxConnections" \ --value 10,000 \ --type String \ --overwrite Windows aws ssm put-parameter ^ --name "/MyService/Test/MaxConnections" ^ --value 10,000 ^ --type String ^ --overwrite The system returns the following error because the new value doesn't meet the requirements of the allowed pattern you specified in the previous step. An error occurred (ParameterPatternMismatchException) when calling the PutParameter operation: Parameter value, cannot be validated against allowedPattern: \d{1,4} 4. Run the following command to create a SecureString parameter that uses an AWS managed key. The allowed pattern in this example means the user can specify any character, and the value must be between 8 and 20 characters. Linux & macOS aws ssm put-parameter \ --name "/MyService/Test/my-password" \ --value "p#sW*rd33" \ --allowed-pattern ".{8,20}" \ --type SecureString Windows aws ssm put-parameter ^ --name "/MyService/Test/my-password" ^ --value "p#sW*rd33" ^ Parameter Store 2066 AWS Systems Manager User Guide --allowed-pattern ".{8,20}" ^ --type SecureString 5. Run the following commands to create more parameters that use the hierarchy structure from the previous step. Linux & macOS aws ssm put-parameter \ --name "/MyService/Test/DBname" \ --value "SQLDevDb" \ --type String aws ssm put-parameter \ --name "/MyService/Test/user" \ --value "SA" \ --type String aws ssm put-parameter \ --name "/MyService/Test/userType" \ --value "SQLuser" \ --type String Windows aws ssm put-parameter ^ --name "/MyService/Test/DBname" ^ --value "SQLDevDb" ^ --type String aws ssm put-parameter ^ --name "/MyService/Test/user" ^ --value "SA" ^ --type String aws ssm put-parameter ^ --name "/MyService/Test/userType" ^ --value "SQLuser" ^ --type String Parameter Store 2067 AWS Systems Manager User Guide 6. Run the following command to get the value of two parameters. Linux & macOS aws ssm get-parameters \ --names "/MyService/Test/user" "/MyService/Test/userType" Windows aws ssm get-parameters ^ --names "/MyService/Test/user" "/MyService/Test/userType" 7. Run the following command to query for all parameters under a single level. Linux
|
systems-manager-ug-598
|
systems-manager-ug.pdf
| 598 |
put-parameter \ --name "/MyService/Test/userType" \ --value "SQLuser" \ --type String Windows aws ssm put-parameter ^ --name "/MyService/Test/DBname" ^ --value "SQLDevDb" ^ --type String aws ssm put-parameter ^ --name "/MyService/Test/user" ^ --value "SA" ^ --type String aws ssm put-parameter ^ --name "/MyService/Test/userType" ^ --value "SQLuser" ^ --type String Parameter Store 2067 AWS Systems Manager User Guide 6. Run the following command to get the value of two parameters. Linux & macOS aws ssm get-parameters \ --names "/MyService/Test/user" "/MyService/Test/userType" Windows aws ssm get-parameters ^ --names "/MyService/Test/user" "/MyService/Test/userType" 7. Run the following command to query for all parameters under a single level. Linux & macOS aws ssm get-parameters-by-path \ --path "/MyService/Test" Windows aws ssm get-parameters-by-path ^ --path "/MyService/Test" 8. Run the following command to delete two parameters. Linux & macOS aws ssm delete-parameters \ --names "/IADRegion/Dev/user" "/IADRegion/Dev/userType" Windows aws ssm delete-parameters ^ --names "/IADRegion/Dev/user" "/IADRegion/Dev/userType" Preventing access to Parameter Store API operations Using service-specific conditions supported by Systems Manager for AWS Identity and Access Management (IAM) policies, you can explicity allow or deny access to Parameter Store API Parameter Store 2068 AWS Systems Manager User Guide operations and content. By using these conditions, you can allow only certain IAM Entities (users and roles) in your organization to call certain API actions, or prevent certain IAM Entities from running them. This includes actions run through the Parameter Store console, the AWS Command Line Interface (AWS CLI), and SDKs. Systems Manager currently supports three conditions that are specific to Parameter Store. Topics • Preventing changes to existing parameters using ssm:Overwrite • Preventing creation or updates to parameters that use a parameter policy using ssm:Policies • Preventing access to levels in a hierarchical parameter using ssm:Recursive Preventing changes to existing parameters using ssm:Overwrite Use the ssm:Overwrite condition to control whether IAM Entities can update existing parameters. In the following sample policy, the "Allow" statement grants permission to create parameters by running the PutParameter API operation in the AWS account 123456789012 in the US East (Ohio) Region (us-east-2). However, the "Deny" statement prevents Entities from changing values of existing parameters because the Overwrite option is explicitly denied for the PutParameter operation. Therefore, Entities that are assigned this policy can create parameters, but not make changes to existing parameters. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:PutParameter" ], "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/*" }, { "Effect": "Deny", "Action": [ Parameter Store 2069 AWS Systems Manager User Guide "ssm:PutParameter" ], "Condition": { "StringEquals": { "ssm:Overwrite": [ "true" ] } }, "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/*" } ] } Preventing creation or updates to parameters that use a parameter policy using ssm:Policies User the ssm:Policies condition to control whether Entities can create parameters that include a parameter policy and update existing parameters that include a parameter policy. In the following policy example, the "Allow" statement grants general permission to create and parameters, but the "Deny" statement prevents Entities from creating or updating parameters that include a parameter policy in the the AWS account 123456789012 in the US East (Ohio) Region (us-east-2). Entities can still create or update parameters that aren't assigned a parameter policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:PutParameter" ], "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/*" }, { "Effect": "Deny", "Action": [ "ssm:PutParameter" ], "Condition": { "StringEquals": { Parameter Store 2070 AWS Systems Manager User Guide "ssm:Policies": [ "true" ] } }, "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/*" } ] } Preventing access to levels in a hierarchical parameter using ssm:Recursive Use the ssm:Recursive condition to control whether IAM Entities can view or reference levels in a hierarchical parameter. You can provide or restrict access to all parameters beyond a specific level of a hierarchy. In the following example policy, the "Allow" statement provides access to Parameter Store operations on all parameters in the path /Code/Departments/Finance/* for the AWS account 123456789012 in the US East (Ohio) Region (us-east-2). After this, the "Deny" statement prevents IAM Entities from viewing or retrieving parameter data at or below the level of /Code/Departments/*. Entities can still, however, still create or update parameters in that path. The example has been constructed to illustrate that recursively denying access below a certain level in a parameter hierarchy takes precedence over more permissive access in the same policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:*" ], "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/*" }, { "Effect": "Deny", "Action": [ "ssm:GetParametersByPath" ], "Condition": { Parameter Store 2071 AWS Systems Manager User Guide "StringEquals": { "ssm:Recursive": [ "true" ] } }, "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/Code/Departments/ *" } ] } Important If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. This is true unless the user has explicitly been denied access in IAM for parameter /b, as illustrated above. Working with parameter
|
systems-manager-ug-599
|
systems-manager-ug.pdf
| 599 |
{ "Effect": "Allow", "Action": [ "ssm:*" ], "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/*" }, { "Effect": "Deny", "Action": [ "ssm:GetParametersByPath" ], "Condition": { Parameter Store 2071 AWS Systems Manager User Guide "StringEquals": { "ssm:Recursive": [ "true" ] } }, "Resource": "arn:aws:ssm:us-east-2:123456789012:parameter/Code/Departments/ *" } ] } Important If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. This is true unless the user has explicitly been denied access in IAM for parameter /b, as illustrated above. Working with parameter labels in Parameter Store A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, AWS Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter version when there are multiple versions. For example, let's say you have a parameter called /MyApp/DB/ConnectionString. The value of the parameter is a connection string to a MySQL server in a local database in a test environment. After you finish updating the application, you want the parameter to use a connection string for a production database. You change the value of /MyApp/DB/ConnectionString. Systems Manager automatically creates version two with the new connection string. To help you remember the purpose of each version, you attach a label to each parameter. For version one, you attach the label Test and for version two you attach the label Production. You can move labels from one version of a parameter to another version. For example, if you create version 3 of the /MyApp/DB/ConnectionString parameter with a connection string for a new production database, then you can move the Production label from version 2 of the parameter to version 3 of the parameter. Parameter Store 2072 AWS Systems Manager User Guide Parameter labels are a lightweight alternative to parameter tags. Your organization might have strict guidelines for tags that must be applied to different AWS resources. In contrast, a label is simply a text association for a specific version of a parameter. Similar to tags, you can query parameters by using labels. You can view a list of specific parameter versions that all use the same label if you query your parameter set by using the GetParametersByPath API operation, as described later in this section. Note If you run a command that specifies a version of a parameter that doesn't exist, the command fails. It doesn't fall back to the latest or default value of the parameter. Label requirements and restrictions Parameter labels have the following requirements and restrictions: • A version of a parameter can have a maximum of 10 labels. • You can't attach the same label to different versions of the same parameter. For example, if version 1 of the parameter has the label Production, then you can't attach Production to version 2. • You can move a label from one version of a parameter to another. • You can't create a label when you create a parameter. You must attach a label to a specific version of a parameter. • If you no longer want to use a parameter label, then you can move it to a different version of a parameter or delete it. • A label can have a maximum of 100 characters. • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). • Labels can't begin with a number, "aws", or "ssm" (not case sensitive). If a label doesn't meet these requirements, then the label isn't attached to the parameter version and the system displays it in the list of InvalidLabels. Topics • Working with parameter labels using the console Parameter Store 2073 AWS Systems Manager User Guide • Working with parameter labels using the AWS CLI Working with parameter labels using the console This section describes how to perform the following tasks by using the Systems Manager console. • Creating a parameter label using the console • Viewing labels attached to a parameter using the console • Moving a parameter label using the console • Deleting parameter labels using the console Creating a parameter label using the console The following procedure describes how to attach a label to a specific version of an existing parameter by using the Systems Manager console. You can't attach a label when you create a parameter. To attach a label to a parameter version 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter to open the details page for that parameter. 4. Choose the History tab. 5. Choose the parameter version for which you want to attach a label. 6.
|
systems-manager-ug-600
|
systems-manager-ug.pdf
| 600 |
Creating a parameter label using the console The following procedure describes how to attach a label to a specific version of an existing parameter by using the Systems Manager console. You can't attach a label when you create a parameter. To attach a label to a parameter version 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter to open the details page for that parameter. 4. Choose the History tab. 5. Choose the parameter version for which you want to attach a label. 6. Choose Manage labels. 7. Choose Add new label. 8. In the text box, enter the label name. To add more labels, choose Add new label. You can attach a maximum of ten labels. 9. When you're finished, choose Save changes. Viewing labels attached to a parameter using the console A parameter version can have a maximum of ten labels. The following procedure describes how to view all labels attached to a parameter version by using the Systems Manager console. Parameter Store 2074 AWS Systems Manager User Guide To view labels attached to a parameter version 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter to open the details page for that parameter. 4. Choose the History tab. 5. Locate the parameter version for which you want to view all attached labels. The Labels column shows all labels attached to the parameter version. Moving a parameter label using the console The following procedure describes how to move a parameter label to a different version of the same parameter by using the Systems Manager console. To move a label to a different parameter version 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter to open the details page for that parameter. 4. Choose the History tab. 5. Choose the parameter version for which you want to move the label. 6. Choose Manage labels. 7. Choose Add new label. 8. In the text box, enter the label name. 9. When you're finished, choose Save changes. Deleting parameter labels using the console The following procedure describes how to delete one or multiple parameter labels using the Systems Manager console. Parameter Store 2075 AWS Systems Manager User Guide To delete labels from a parameter 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter to open the details page for that parameter. 4. Choose the History tab. 5. Choose the parameter version for which you want to delete labels. 6. Choose Manage labels. 7. Choose Remove. next to each label you want to delete. 8. When you're finished, choose Save changes. 9. Confirm that your changes are correct, enter Confirm in the text box, and choose Confirm. Working with parameter labels using the AWS CLI This section describes how to perform the following tasks by using the AWS Command Line Interface (AWS CLI). • Creating a new parameter label using the AWS CLI • Viewing labels for a parameter using the AWS CLI • Viewing a list of parameters that are assigned a label using the AWS CLI • Moving a parameter label using the AWS CLI • Deleting parameter labels using the AWS CLI Creating a new parameter label using the AWS CLI The following procedure describes how to attach a label to a specific version of an existing parameter by using the AWS CLI. You can't attach a label when you create a parameter. To create a parameter label 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to view a list of parameters for which you have permission to attach a label. Parameter Store 2076 AWS Systems Manager Note User Guide Parameters are only available in the AWS Region where they were created. If you don't see a parameter for which you want to attach a label, then verify your Region. aws ssm describe-parameters Note the name of a parameter for which you want to attach a label. 3. Run the following command to view all versions of the parameter. aws ssm get-parameter-history --name "parameter-name" Note the parameter version for which you want to attach a label. 4. Run the following command to retrieve information about a parameter by version number. aws ssm get-parameters --names "parameter-name:version-number" Here is an example. aws ssm get-parameters --names "/Production/SQLConnectionString:3" 5. Run one of the following commands to attach a label to a version of a
|
systems-manager-ug-601
|
systems-manager-ug.pdf
| 601 |
you want to attach a label, then verify your Region. aws ssm describe-parameters Note the name of a parameter for which you want to attach a label. 3. Run the following command to view all versions of the parameter. aws ssm get-parameter-history --name "parameter-name" Note the parameter version for which you want to attach a label. 4. Run the following command to retrieve information about a parameter by version number. aws ssm get-parameters --names "parameter-name:version-number" Here is an example. aws ssm get-parameters --names "/Production/SQLConnectionString:3" 5. Run one of the following commands to attach a label to a version of a parameter. If you attach multiple labels, separate label names with a space. Attach a label to the latest version of a parameter aws ssm label-parameter-version --name parameter-name --labels label-name Attach a label to a specific version of a parameter aws ssm label-parameter-version --name parameter-name --parameter-version version- number --labels label-name Here are some examples. Parameter Store 2077 AWS Systems Manager User Guide aws ssm label-parameter-version --name /config/endpoint --labels production east- region finance aws ssm label-parameter-version --name /config/endpoint --parameter-version 3 -- labels MySQL-test Note If the output shows the label you created in the InvalidLabels list, then the label doesn't meet the requirements described earlier in this topic. Review the requirements and try again. If the InvalidLabels list is empty, then your label was successfully applied to the version of the parameter. 6. You can view the details of the parameter by using either a version number or a label name. Run the following command and specify the label you created in the previous step. aws ssm get-parameter --name parameter-name:label-name --with-decryption The command returns information like the following. { "Parameter": { "Version": version-number, "Type": "parameter-type", "Name": "parameter-name", "Value": "parameter-value", "Selector": ":label-name" } } Note Selector in the output is either the version number or the label that you specified in the Name input field. Parameter Store 2078 AWS Systems Manager User Guide Viewing labels for a parameter using the AWS CLI You can use the GetParameterHistory API operation to view the full history and all labels attached to a specified parameter. Or, you can use the GetParametersByPath API operation to view a list of all parameters that are assigned a specific label. To view labels for a parameter by using the GetParameterHistory API operation 1. Run the following command to view a list of parameters for which you can view labels. Note Parameters are only available in the Region where they were created. If you don't see a parameter for which you want to move a label, then verify your Region. aws ssm describe-parameters Note the name of the parameter you want to view the labels of. 2. Run the following command to view all versions of the parameter. aws ssm get-parameter-history --name parameter-name --with-decryption The system returns information like the following. { "Parameters": [ { "Name": "/Config/endpoint", "LastModifiedDate": 1528932105.382, "Labels": [ "Deprecated" ], "Value": "MyTestService-June-Release.example.com", "Version": 1, "LastModifiedUser": "arn:aws:iam::123456789012:user/test", "Type": "String" }, { "Name": "/Config/endpoint", Parameter Store 2079 AWS Systems Manager User Guide "LastModifiedDate": 1528932111.222, "Labels": [ "Current" ], "Value": "MyTestService-July-Release.example.com", "Version": 2, "LastModifiedUser": "arn:aws:iam::123456789012:user/test", "Type": "String" } ] } Viewing a list of parameters that are assigned a label using the AWS CLI You can use the GetParametersByPath API operation to view a list of all parameters in a path that are assigned a specific label. Run the following command to view a list of parameters in a path that are assigned a specific label. Replace each example resource placeholder with your own information. aws ssm get-parameters-by-path \ --path parameter-path \ --parameter-filters Key=Label,Values=label-name,Option=Equals \ --max-results a-number \ --with-decryption --recursive The system returns information like the following. For this example, the user searched under the / Config path. { "Parameters": [ { "Version": 3, "Type": "SecureString", "Name": "/Config/DBpwd", "Value": "MyS@perGr&pass33" }, { "Version": 2, "Type": "String", "Name": "/Config/DBusername", Parameter Store 2080 AWS Systems Manager User Guide "Value": "TestUserDB" }, { "Version": 2, "Type": "String", "Name": "/Config/endpoint", "Value": "MyTestService-July-Release.example.com" } ] } Moving a parameter label using the AWS CLI The following procedure describes how to move a parameter label to a different version of the same parameter. To move a parameter label 1. Run the following command to view all versions of the parameter. Replace parameter name with your own information. aws ssm get-parameter-history \ --name "parameter name" Note the parameter versions you want to move the label to and from. 2. Run the following command to assign an existing label to a different version of a parameter. Replace each example resource placeholder with your own information. aws ssm label-parameter-version \ --name parameter name \ --parameter-version version number \ --labels name-of-existing-label Note If you want to move an existing label to the latest version of a parameter, then remove --parameter-version from the command. Parameter Store 2081 AWS Systems Manager User Guide
|
systems-manager-ug-602
|
systems-manager-ug.pdf
| 602 |
of the parameter. Replace parameter name with your own information. aws ssm get-parameter-history \ --name "parameter name" Note the parameter versions you want to move the label to and from. 2. Run the following command to assign an existing label to a different version of a parameter. Replace each example resource placeholder with your own information. aws ssm label-parameter-version \ --name parameter name \ --parameter-version version number \ --labels name-of-existing-label Note If you want to move an existing label to the latest version of a parameter, then remove --parameter-version from the command. Parameter Store 2081 AWS Systems Manager User Guide Deleting parameter labels using the AWS CLI The following procedure describes how to delete parameter labels by using the AWS CLI. To delete a parameter label 1. Run the following command to view all versions of the parameter. Replace parameter name with your own information. aws ssm get-parameter-history \ --name "parameter name" The system returns information like the following. { "Parameters": [ { "Name": "foo", "DataType": "text", "LastModifiedDate": 1607380761.11, "Labels": [ "l3", "l2" ], "Value": "test", "Version": 1, "LastModifiedUser": "arn:aws:iam::123456789012:user/test", "Policies": [], "Tier": "Standard", "Type": "String" }, { "Name": "foo", "DataType": "text", "LastModifiedDate": 1607380763.11, "Labels": [ "l1" ], "Value": "test", "Version": 2, "LastModifiedUser": "arn:aws:iam::123456789012:user/test", "Policies": [], "Tier": "Standard", Parameter Store 2082 AWS Systems Manager User Guide "Type": "String" } ] } Note the parameter version for which you want to delete a label or labels. 2. Run the following command to delete the labels you choose from that parameter. Replace each example resource placeholder with your own information. aws ssm unlabel-parameter-version \ --name parameter name \ --parameter-version version \ --labels label 1,label 2,label 3 The system returns information like the following. { "InvalidLabels": ["invalid"], "DeletedLabels" : ["Prod"] } Working with parameter versions in Parameter Store Each time you edit the value of a parameter, Parameter Store, a tool in AWS Systems Manager creates a new version of the parameter and retains the previous versions. When you initially create a parameter, Parameter Store assigns version 1 to that parameter. When you change the value of the parameter, Parameter Store automatically increments the version number by one. You can view the details, including the values, of all versions in a parameter's history. You can also specify the version of a parameter to use in API commands and SSM documents; for example: ssm:MyParameter:3. You can specify a parameter name and a specific version number in API calls and SSM documents. If you don't specify a version number, the system automatically uses the latest version. If you specify the number for a version that doesn't exist, the system returns an error rather than falling back to the latest or default version of the parameter. You can use parameter versions to see the number of times a parameter changed over a period of time. Parameter versions also provide a layer of protection if a parameter value is accidentally changed. Parameter Store 2083 AWS Systems Manager User Guide You can create and maintain up to 100 versions of a parameter. After you have created 100 versions of a parameter, each time you create a new version, the oldest version of the parameter is removed from history to make room for the new version. An exception to this is when there are already 100 parameter versions in history, and a parameter label is assigned to the oldest version of a parameter. In this case, that version isn't removed from history, and the request to create a new parameter version fails. This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Moving a parameter label using the console and Moving a parameter label using the AWS CLI. The following procedures show you how to edit a parameter and then verify that you created a new version. You can use the get-parameter and get-parameters commands to view parameter versions. For examples on using these commands, see GetParameter and GetParameters in the AWS Systems Manager API Reference Topics • Creating a new version of a parameter using the console • Referencing a parameter version Creating a new version of a parameter using the console You can use the Systems Manager console to create a new version of a parameter and view the version history of a parameter. To create a new version of a parameter 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter that you created earlier. For information about creating a new parameter, see Creating Parameter Store parameters in Systems Manager. 4. Choose
|
systems-manager-ug-603
|
systems-manager-ug.pdf
| 603 |
new version of a parameter using the console • Referencing a parameter version Creating a new version of a parameter using the console You can use the Systems Manager console to create a new version of a parameter and view the version history of a parameter. To create a new version of a parameter 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the name of a parameter that you created earlier. For information about creating a new parameter, see Creating Parameter Store parameters in Systems Manager. 4. Choose Edit. 5. In the Value box, enter a new value, and then choose Save changes. 6. Choose the name of the parameter you just updated. On the Overview tab, verify that the version number incremented by 1, and verify the new value. Parameter Store 2084 AWS Systems Manager User Guide 7. To view the history of all versions of a parameter, choose the History tab. Referencing a parameter version You can reference specific parameter versions in commands, API calls, and SSM documents by using the following format: ssm:parameter-name:version-number. In the following example, the Amazon Elastic Compute Cloud (Amazon EC2) run-instances command uses version 3 of the parameter golden-ami. Linux & macOS aws ec2 run-instances \ --image-id resolve:ssm:/golden-ami:3 \ --count 1 \ --instance-type t2.micro \ --key-name my-key-pair \ --security-groups my-security-group Windows aws ec2 run-instances ^ --image-id resolve:ssm:/golden-ami:3 ^ --count 1 ^ --instance-type t2.micro ^ --key-name my-key-pair ^ --security-groups my-security-group Note Using resolve and a parameter value only works with the --image-id option and a parameter that contains an Amazon Machine Image (AMI) as its value. For more information, see Using native parameter support in Parameter Store for Amazon Machine Image IDs. Here is an example for specifying version 2 of a parameter named MyRunCommandParameter in an SSM document. Parameter Store 2085 AWS Systems Manager YAML --- User Guide schemaVersion: '2.2' description: Run a shell script or specify the commands to run. parameters: commands: type: String description: "(Required) Specify a shell script or a command to run." displayType: textarea default: "{{ssm:MyRunCommandParameter:2}}" mainSteps: - action: aws:runShellScript name: RunScript inputs: runCommand: - "{{commands}}" JSON { "schemaVersion": "2.2", "description": "Run a shell script or specify the commands to run.", "parameters": { "commands": { "type": "String", "description": "(Required) Specify a shell script or a command to run.", "displayType": "textarea", "default": "{{ssm:MyRunCommandParameter:2}}" } }, "mainSteps": [ { "action": "aws:runShellScript", "name": "RunScript", "inputs": { "runCommand": [ "{{commands}}" ] } } ] } Parameter Store 2086 AWS Systems Manager User Guide Working with shared parameters in Parameter Store Sharing advanced parameters simplifies configuration data management in a multi-account environment. You can centrally store and manage your parameters and share them with other AWS accounts that need to reference them. Parameter Store integrates with AWS Resource Access Manager (AWS RAM) to enable advanced parameter sharing. AWS RAM is a service that enables you to share resources with other AWS accounts or through AWS Organizations. With AWS RAM, you share resources that you own by creating a resource share. A resource share specifies the resources to share, permissions to grant, and the consumers with whom to share. Consumers can include: • Specific AWS accounts inside or outside of its organization in AWS Organizations • An organizational unit inside its organization in AWS Organizations • Its entire organization in AWS Organizations For more information about AWS RAM, see the AWS RAM User Guide. This topic explains how to share parameters that you own, and how to use parameters that are shared with you. Contents • Prerequisites for sharing parameters • Sharing a parameter • Stop sharing a shared parameter • Identifying shared parameters • Accessing shared parameters • Permissions sets for sharing parameters • Maximum throughput for shared parameters • Pricing for shared parameters • Cross-account access for closed AWS accounts Prerequisites for sharing parameters The following prerequisites must be met before you can share parameters from your account: Parameter Store 2087 AWS Systems Manager User Guide • To share a parameter, you must own it in your AWS account. You can't share a parameter that has been shared with you. • To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter. • To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through AWS Key Management Service. AWS managed keys cannot be shared. Parameters encrypted with the default AWS managed key can be updated to use a customer managed key instead. For AWS KMS key definitions, see AWS KMS concepts in the AWS Key Management Service Developer Guide.
|
systems-manager-ug-604
|
systems-manager-ug.pdf
| 604 |
parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter. • To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through AWS Key Management Service. AWS managed keys cannot be shared. Parameters encrypted with the default AWS managed key can be updated to use a customer managed key instead. For AWS KMS key definitions, see AWS KMS concepts in the AWS Key Management Service Developer Guide. • To share a parameter with your organization or an organizational unit in AWS Organizations, you must enable sharing with AWS Organizations. For more information, see Enable Sharing with AWS Organizations in the AWS RAM User Guide. Sharing a parameter To share a parameter, you must add it to a resource share. A resource share is an AWS RAM resource that lets you share your resources across AWS accounts. A resource share specifies the resources to share, and the consumers with whom they are shared. When you share a parameter that you own with other AWS accounts, you can choose from two AWS managed permissions to grant the consumers. For more information, see Permissions sets for sharing parameters. If you are part of an organization in AWS Organizations and sharing within your organization is enabled, you can grant consumers in your organization access from the AWS RAM console to the shared parameter. Otherwise, consumers receive an invitation to join the resource share and are granted access to the shared parameter after accepting the invitation. You can share a parameter that you own using the AWS RAM console, or the AWS CLI. Note While you can share a parameter using the Systems Manager PutResourcePolicy API operation, we recommend using AWS Resource Access Manager (AWS RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard Resource Share using the AWS RAM PromoteResourceShareCreatedFromPolicy Parameter Store 2088 AWS Systems Manager User Guide API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option. To share a parameter that you own using the AWS RAM console See Creating a resource share in AWS RAM in the AWS RAM User Guide. Make the following selections as you complete the procedure: • In the Step 1 page, for Resources, select Parameter Store Advanced Parameter, and then select the box of each parameter in the advanced parameter tier that you want to share. • In the Step 2 page, for Managed permissions, choose the permission to grant consumers, as described in Permissions sets for sharing parameters later in this topic. Choose other options based on your parameter sharing objectives. To share a parameter that you own using the AWS CLI Use the create-resource-share command to add parameters to a new resource share. Use the associate-resource-share command to add parameters to an existing resource share. The following example creates a new resource share to share parameters with consumers in an organization and in an individual account. aws ram create-resource-share \ --name "MyParameter" \ --resource-arns "arn:aws:ssm:us-east-2:123456789012:parameter/MyParameter" \ --principals "arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE" "987654321098" Stop sharing a shared parameter When you stop sharing a shared parameter, the consumer account can no longer access the parameter. To stop sharing a parameter that you own, you must remove it from the resource share. You can do this using the Systems Manager console, AWS RAM console, or the AWS CLI. To stop sharing a parameter that you own using the AWS RAM console Parameter Store 2089 AWS Systems Manager User Guide See Update a resource share in AWS RAM in the AWS RAM User Guide. To stop sharing a parameter that you own using the AWS CLI Use the disassociate-resource-share command. Identifying shared parameters Owners and consumers can identify shared parameters using the AWS CLI. To identify shared parameters using the AWS CLI To identify shared parameters using the AWS CLI, you can choose from the Systems Manager describe-parameters command and the AWS RAM list-resources command. When you use the --shared option with describe-parameters, the command returns the parameters that are shared with you. The following is an example: aws ssm describe-parameters --shared Accessing shared parameters Consumers can access shared parameters using the AWS command line tools, and AWS SDKs. For consumer accounts, parameters shared with that account aren't included in the My parameters page. CLI Example: Accessing shared parameter details using the AWS CLI To access shared parameter details using the AWS CLI, you can use the get-parameter or get- parameters commands. You must specify the full parameter ARN as the --name in order to retrieve the parameter from another account. The following is an example. aws ssm get-parameter \
|
systems-manager-ug-605
|
systems-manager-ug.pdf
| 605 |
shared with you. The following is an example: aws ssm describe-parameters --shared Accessing shared parameters Consumers can access shared parameters using the AWS command line tools, and AWS SDKs. For consumer accounts, parameters shared with that account aren't included in the My parameters page. CLI Example: Accessing shared parameter details using the AWS CLI To access shared parameter details using the AWS CLI, you can use the get-parameter or get- parameters commands. You must specify the full parameter ARN as the --name in order to retrieve the parameter from another account. The following is an example. aws ssm get-parameter \ --name arn:aws:ssm:us-east-2:123456789012:parameter/MySharedParameter Supported and unsupported integrations for shared parameters Currently, you can use shared parameters in the following integration scenarios: Parameter Store 2090 AWS Systems Manager User Guide • AWS CloudFormation template parameters • The AWS Parameters and Secrets Lambda extension • Amazon Elastic Compute Cloud (EC2) launch templates • Values for ImageID with the EC2 RunInstances command to create instances from an Amazon Machine Image (AMI) • Retrieving parameter values in runbooks for Automation, a tool in Systems Manager The following scenarios and integrated services do not currently support the use of shared parameters: • Parameters in commands in Run Command, a tool in Systems Manager • AWS CloudFormation dynamic references • The values of environment variables in AWS CodeBuild • The values of environment variables in AWS App Runner • The value of a secret in Amazon Elastic Container Service Permissions sets for sharing parameters Consumer accounts receive read-only access to the parameters you share with them. The consumer can't update or delete the parameter. The consumer can't share the parameter with a third account. When you create a resource share in AWS Resource Access Manager for sharing your parameters, you can choose from two AWS managed permission sets to grant this read-only access: AWSRAMDefaultPermissionSSMParameterReadOnly Allowed actions: DescribeParameters, GetParameter, GetParameters AWSRAMPermissionSSMParameterReadOnlyWithHistory Allowed actions: DescribeParameters, GetParameter, GetParameters, GetParameterHistory When you folllow the steps in Creating a resource share in AWS RAM in the AWS RAM User Guide, choose Parameter Store Advanced Parameters as the resource type and either of these managed permissions, depending on whether you want users to view parameter history or not. Parameter Store 2091 AWS Systems Manager Note User Guide If you're retrieving shared parameters programmatically (for example, using AWS Lambda) you might need to add the ssm:GetResourcePolicies and ssm:PutResourcePolicy permissions to any IAM roles calling AWS Resource Access Manager API actions. Maximum throughput for shared parameters Systems Manager limits the maximum throughput (transactions per second) for the GetParameter and GetParameters. operations. Throughput is enforced at the individual account level. Therefore, each account that consumes a shared parameter can use its maximum allowed throughput without being affected by other accounts. For more information about maximum throughput for parameters, see the following topics: • Increasing Parameter Store throughput • Systems Manager Service quotas in the Amazon Web Services General Reference. Pricing for shared parameters Cross-account sharing is only available in the advanced parameter tier. For advanced parameters, charges are incurred at the current price for the storage and API usage for each advanced parameter. The owning account is charged for storage of the advanced parameter. Any consuming account that makes an API call to a shared advanced parameter is charged for the parameter usage. For example, if Account A creates an advanced parameter, MyAdvancedParameter, that account is charged USD 0.05 per month to store the parameter. Account A then shares MyAdvancedParameter with Account B and Account C. During a month, the three accounts make calls to MyAdvancedParameter. The following table illustrates the charges they would incur for the number of calls each makes. Note The charges in the following table are for illustration only. To verify current pricing, see AWS Systems Manager Pricing for Parameter Store. Parameter Store 2092 AWS Systems Manager User Guide Account Number of calls Charges Account A (owning account) 10,000 calls Account B (consuming account) 20,000 calls Account C (consuming account) 30,000 calls • One month advanced parameter storage: USD 0.05 • 10,000 calls to MyAdvance dParameter : USD 0.05 • Total: USD 0.10 • 20,000 calls to MyAdvance dParameter : USD 0.10 • Total: USD 0.10 • 30,000 calls to MyAdvance dParameter : USD 0.15 • Total: USD 0.15 Cross-account access for closed AWS accounts If the AWS account that owns a shared parameter is closed, all consuming accounts lose access to the shared parameter. If the owning account is reopened within 90 days after the account is closed, consuming accounts regain access to the previously shared parameters. For more information about reopening an account during the Post-Closure Period, see Accessing your AWS account after you close it in the AWS Account Management Reference Guide. Working with parameters in Parameter Store using Run Command commands You can work with parameters in Run
|
systems-manager-ug-606
|
systems-manager-ug.pdf
| 606 |
: USD 0.15 • Total: USD 0.15 Cross-account access for closed AWS accounts If the AWS account that owns a shared parameter is closed, all consuming accounts lose access to the shared parameter. If the owning account is reopened within 90 days after the account is closed, consuming accounts regain access to the previously shared parameters. For more information about reopening an account during the Post-Closure Period, see Accessing your AWS account after you close it in the AWS Account Management Reference Guide. Working with parameters in Parameter Store using Run Command commands You can work with parameters in Run Command, a tool in AWS Systems Manager. For more information, see AWS Systems Manager Run Command. Running a String parameter using the console The following procedure walks you through the process of running a command that uses a String parameter. Parameter Store 2093 AWS Systems Manager User Guide To run a String parameter using Parameter Store 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Run Command. 3. Choose Run command. 4. 5. 6. In the Command document list, choose AWS-RunPowerShellScript (Windows) or AWS- RunShellScript (Linux). For Command parameters, enter echo {{ssm:parameter-name}}. For example: echo {{ssm:/Test/helloWorld}}. In the Targets section, choose the managed nodes on which you want to run this operation by specifying tags, selecting instances or edge devices manually, or specifying a resource group. Tip If a managed node you expect to see isn't listed, see Troubleshooting managed node availability for troubleshooting tips. 7. For Other parameters: • For Comment, enter information about this command. • For Timeout (seconds), specify the number of seconds for the system to wait before failing the overall command execution. 8. For Rate control: • For Concurrency, specify either a number or a percentage of managed nodes on which to run the command at the same time. Note If you selected targets by specifying tags applied to managed nodes or by specifying AWS resource groups, and you aren't certain how many managed nodes are targeted, then restrict the number of targets that can run the document at the same time by specifying a percentage. • For Error threshold, specify when to stop running the command on other managed nodes after it fails on either a number or a percentage of nodes. For example, if you specify three Parameter Store 2094 AWS Systems Manager User Guide errors, then Systems Manager stops sending the command when the fourth error is received. Managed nodes still processing the command might also send errors. 9. (Optional) For Output options, to save the command output to a file, select the Write command output to an S3 bucket box. Enter the bucket and prefix (folder) names in the boxes. Note The S3 permissions that grant the ability to write the data to an S3 bucket are those of the instance profile (for EC2 instances) or IAM service role (hybrid-activated machines) assigned to the instance, not those of the IAM user performing this task. For more information, see Configure instance permissions required for Systems Manager or Create an IAM service role for a hybrid environment. In addition, if the specified S3 bucket is in a different AWS account, make sure that the instance profile or IAM service role associated with the managed node has the necessary permissions to write to that bucket. 10. In the SNS notifications section, if you want notifications sent about the status of the command execution, select the Enable SNS notifications check box. For more information about configuring Amazon SNS notifications for Run Command, see Monitoring Systems Manager status changes using Amazon SNS notifications. 11. Choose Run. 12. In the Command ID page, in the Targets and outputs area, select the button next to the ID of a node where you ran the command, and then choose View output. Verify that the output of the command is the value you provided for the parameter, such as This is my first parameter. Running a parameter using the AWS CLI Example 1: Simple command The following example command includes a Systems Manager parameter named DNS-IP. The value of this parameter is simply the IP address of a node. This example uses an AWS Command Line Interface (AWS CLI) command to echo the parameter value. Parameter Store 2095 AWS Systems Manager Linux & macOS User Guide aws ssm send-command \ --document-name "AWS-RunShellScript" \ --document-version "1" \ --targets "Key=instanceids,Values=i-02573cafcfEXAMPLE" \ --parameters "commands='echo {{ssm:DNS-IP}}'" \ --timeout-seconds 600 \ --max-concurrency "50" \ --max-errors "0" \ --region us-east-2 Windows aws ssm send-command ^ --document-name "AWS-RunPowerShellScript" ^ --document-version "1" ^ --targets "Key=instanceids,Values=i-02573cafcfEXAMPLE" ^ --parameters "commands='echo {{ssm:DNS-IP}}'" ^ --timeout-seconds 600 ^ --max-concurrency "50" ^ --max-errors "0" ^ --region us-east-2 The command returns information like the following. { "Command": { "CommandId": "c70a4671-8098-42da-b885-89716EXAMPLE", "DocumentName": "AWS-RunShellScript", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2023-12-26T15:19:17.771000-05:00",
|
systems-manager-ug-607
|
systems-manager-ug.pdf
| 607 |
AWS Command Line Interface (AWS CLI) command to echo the parameter value. Parameter Store 2095 AWS Systems Manager Linux & macOS User Guide aws ssm send-command \ --document-name "AWS-RunShellScript" \ --document-version "1" \ --targets "Key=instanceids,Values=i-02573cafcfEXAMPLE" \ --parameters "commands='echo {{ssm:DNS-IP}}'" \ --timeout-seconds 600 \ --max-concurrency "50" \ --max-errors "0" \ --region us-east-2 Windows aws ssm send-command ^ --document-name "AWS-RunPowerShellScript" ^ --document-version "1" ^ --targets "Key=instanceids,Values=i-02573cafcfEXAMPLE" ^ --parameters "commands='echo {{ssm:DNS-IP}}'" ^ --timeout-seconds 600 ^ --max-concurrency "50" ^ --max-errors "0" ^ --region us-east-2 The command returns information like the following. { "Command": { "CommandId": "c70a4671-8098-42da-b885-89716EXAMPLE", "DocumentName": "AWS-RunShellScript", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2023-12-26T15:19:17.771000-05:00", "Parameters": { "commands": [ "echo {{ssm:DNS-IP}}" ] }, "InstanceIds": [], "Targets": [ { "Key": "instanceids", Parameter Store 2096 AWS Systems Manager User Guide "Values": [ "i-02573cafcfEXAMPLE" ] } ], "RequestedDateTime": "2023-12-26T14:09:17.771000-05:00", "Status": "Pending", "StatusDetails": "Pending", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 0, "CompletedCount": 0, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false }, "TimeoutSeconds": 600, "AlarmConfiguration": { "IgnorePollAlarmFailure": false, "Alarms": [] }, "TriggeredAlarms": [] } } After a command execution completes, you can view more information about it using the following commands: • get-command-invocation – View detailed information about the command execution. • list-command-invocations – View the command execution status on a specific managed node. • list-commands – View the command execution status across managed nodes. Parameter Store 2097 AWS Systems Manager User Guide Example 2: Decrypt a SecureString parameter value The next example command uses a SecureString parameter named SecurePassword. The command used in the parameters field retrieves and decrypts the value of the SecureString parameter, and then resets the local administrator password without having to pass the password in clear text. Linux aws ssm send-command \ --document-name "AWS-RunShellScript" \ --document-version "1" \ --targets "Key=instanceids,Values=i-02573cafcfEXAMPLE" \ --parameters '{"commands":["secure=$(aws ssm get-parameters --names SecurePassword --with-decryption --query Parameters[0].Value --output text --region us-east-2)","echo $secure | passwd myuser --stdin"]}' \ --timeout-seconds 600 \ --max-concurrency "50" \ --max-errors "0" \ --region us-east-2 Windows aws ssm send-command ^ --document-name "AWS-RunPowerShellScript" ^ --document-version "1" ^ --targets "Key=instanceids,Values=i-02573cafcfEXAMPLE" ^ --parameters "commands=['$secure = (Get-SSMParameterValue -Names SecurePassword -WithDecryption $True).Parameters[0].Value','net user administrator $secure']" ^ --timeout-seconds 600 ^ --max-concurrency "50" ^ --max-errors "0" ^ --region us-east-2 Example 3: Reference a parameter in an SSM document You can also reference Systems Manager parameters in the Parameters section of an SSM document, as shown in the following example. { Parameter Store 2098 User Guide AWS Systems Manager "schemaVersion":"2.0", "description":"Sample version 2.0 document v2", "parameters":{ "commands" : { "type": "StringList", "default": ["{{ssm:parameter-name}}"] } }, "mainSteps":[ { "action":"aws:runShellScript", "name":"runShellScript", "inputs":{ "runCommand": "{{commands}}" } } ] } Don't confuse the similar syntax for local parameters used in the runtimeConfig section of SSM documents with Parameter Store parameters. A local parameter isn't the same as a Systems Manager parameter. You can distinguish local parameters from Systems Manager parameters by the absence of the ssm: prefix. "runtimeConfig":{ "aws:runShellScript":{ "properties":[ { "id":"0.aws:runShellScript", "runCommand":"{{ commands }}", "workingDirectory":"{{ workingDirectory }}", "timeoutSeconds":"{{ executionTimeout }}" Note SSM documents don't support references to SecureString parameters. This means that to use SecureString parameters with, for example, Run Command, you have to retrieve the parameter value before passing it to Run Command, as shown in the following examples. Parameter Store 2099 AWS Systems Manager Linux & macOS User Guide value=$(aws ssm get-parameters --names parameter-name --with-decryption) aws ssm send-command \ --name AWS-JoinDomain \ --parameters password=$value \ --instance-id instance-id Windows aws ssm send-command ^ --name AWS-JoinDomain ^ --parameters password=$value ^ --instance-id instance-id Powershell $secure = (Get-SSMParameterValue -Names parameter-name -WithDecryption $True).Parameters[0].Value | ConvertTo-SecureString -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential - argumentlist user-name,$secure Using native parameter support in Parameter Store for Amazon Machine Image IDs When you create a String parameter, you can specify the data type as aws:ec2:image to ensure that the parameter value you enter is a valid Amazon Machine Image (AMI) ID format. Support for AMI ID formats allows you to avoid updating all your scripts and templates with a new ID each time the AMI that you want to use in your processes changes. You can create a parameter with the data type aws:ec2:image, and for its value, enter the ID of an AMI. This is the AMI you want to create new instances from. You then reference this parameter in your templates, commands, and scripts. For example, you can specify the parameter that contains your preferred AMI ID when you run the Amazon Elastic Compute Cloud (Amazon EC2) run-instances command. Parameter Store 2100 AWS Systems Manager Note User Guide The user who runs this command must have AWS Identity and Access Management (IAM) permissions that include the ssm:GetParameters API operation in order for the parameter value to be validated. Otherwise, the parameter creation process fails. Linux & macOS aws ec2 run-instances \ --image-id resolve:ssm:/golden-ami \ --count 1 \
|
systems-manager-ug-608
|
systems-manager-ug.pdf
| 608 |
want to create new instances from. You then reference this parameter in your templates, commands, and scripts. For example, you can specify the parameter that contains your preferred AMI ID when you run the Amazon Elastic Compute Cloud (Amazon EC2) run-instances command. Parameter Store 2100 AWS Systems Manager Note User Guide The user who runs this command must have AWS Identity and Access Management (IAM) permissions that include the ssm:GetParameters API operation in order for the parameter value to be validated. Otherwise, the parameter creation process fails. Linux & macOS aws ec2 run-instances \ --image-id resolve:ssm:/golden-ami \ --count 1 \ --instance-type t2.micro \ --key-name my-key-pair \ --security-groups my-security-group Windows aws ec2 run-instances ^ --image-id resolve:ssm:/golden-ami ^ --count 1 ^ --instance-type t2.micro ^ --key-name my-key-pair ^ --security-groups my-security-group You can also choose your preferred AMI when you create an instance using the Amazon EC2 console. For more information, see Using a Systems Manager parameter to find an AMI in the Amazon EC2 User Guide. When it's time to use a different AMI in your instance creation workflow, you need only update the parameter with the new AMI value, and Parameter Store again validates that you have entered an ID in the proper format. Granting permissions to create a parameter of aws:ec2:image data type Using AWS Identity and Access Management (IAM) policies, you can provide or restrict user access to Parameter Store API operations and content. To create an aws:ec2:image data type parameter, the user must have both ssm:PutParameter and ec2:DescribeImages permissions. Parameter Store 2101 AWS Systems Manager User Guide The following example policy grants users permission to call the PutParameter API operation for aws:ec2:image. This means that the user can add a parameter of data type aws:ec2:image to the system. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "ssm:PutParameter", "Resource": "*" }, { "Effect": "Allow", "Action": "ec2:DescribeImages", "Resource": "*" } ] } How AMI format validation works When you specify aws:ec2:image as the data type for a parameter, Systems Manager doesn't create the parameter immediately. It instead performs an asynchronous validation operation to ensure that the parameter value meets the formatting requirements for an AMI ID, and that the specified AMI is available in your AWS account. A parameter version number might be generated before the validation operation is complete. The operation might not be complete even if a parameter version number is generated. To monitor whether your parameters are created successfully, we recommend using Amazon EventBridge to send you notifications about your create and update parameter operations. These notifications report whether a parameter operation was successful or not. If an operation fails, the notification includes an error message that indicates the reason for the failure. { "version": "0", "id": "eed4a719-0fa4-6a49-80d8-8ac65EXAMPLE", "detail-type": "Parameter Store Change", "source": "aws.ssm", "account": "111122223333", Parameter Store 2102 AWS Systems Manager User Guide "time": "2020-05-26T22:04:42Z", "region": "us-east-2", "resources": [ "arn:aws:ssm:us-east-2:111122223333:parameter/golden-ami" ], "detail": { "exception": "Unable to Describe Resource", "dataType": "aws:ec2:image", "name": "golden-ami", "type": "String", "operation": "Create" } } For information about subscribing to Parameter Store events in EventBridge, see Setting up notifications or triggering actions based on Parameter Store events. Deleting parameters from Parameter Store This topic describes how to delete parameters that you have created in Parameter Store, a tool in AWS Systems Manager. Warning Deleting a parameter removes all versions of it. Once deleted, the parameter and its versions can't be restored. To delete a parameter using the console 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. On the My parameters tab, select the check box next to each parameter to delete. 4. Choose Delete. 5. On the confirmation dialog, choose Delete parameters. To delete a parameter using the AWS CLI • Run the following command: Parameter Store 2103 AWS Systems Manager User Guide aws ssm delete-parameter --name "my-parameter" Replace my-parameter with the name of your parameter to be deleted. For information about all options available for use with the delete-parameter command, see delete-parameter in the AWS Systems Manager section of the AWS CLI Command Reference. Working with public parameters in Parameter Store Some AWS services publish information about common artifacts as AWS Systems Manager public parameters. For example, the Amazon Elastic Compute Cloud (Amazon EC2) service publishes information about Amazon Machine Images (AMIs) as public parameters. Topics in this guide • Discovering public parameters in Parameter Store • Calling AMI public parameters in Parameter Store • Calling the ECS optimized AMI public parameter in Parameter Store • Calling the EKS optimized AMI public parameter in Parameter Store • Calling public parameters for AWS services, Regions, endpoints, Availability Zones, local zones, and Wavelength Zones in Parameter Store Related AWS blog posts • Query for AWS Regions, Endpoints, and More Using AWS Systems Manager Parameter Store • Query for the latest Amazon Linux AMI
|
systems-manager-ug-609
|
systems-manager-ug.pdf
| 609 |
Cloud (Amazon EC2) service publishes information about Amazon Machine Images (AMIs) as public parameters. Topics in this guide • Discovering public parameters in Parameter Store • Calling AMI public parameters in Parameter Store • Calling the ECS optimized AMI public parameter in Parameter Store • Calling the EKS optimized AMI public parameter in Parameter Store • Calling public parameters for AWS services, Regions, endpoints, Availability Zones, local zones, and Wavelength Zones in Parameter Store Related AWS blog posts • Query for AWS Regions, Endpoints, and More Using AWS Systems Manager Parameter Store • Query for the latest Amazon Linux AMI IDs using AWS Systems Manager Parameter Store • Query for the Latest Windows AMI Using AWS Systems Manager Parameter Store Discovering public parameters in Parameter Store You can search for public parameters using the Parameter Store console or the AWS Command Line Interface. A public parameter name begins with aws/service/list. The next part of the name corresponds to the service that owns that parameter. The following is a partial list of AWS services and other resources that provide public parameters: Parameter Store 2104 User Guide AWS Systems Manager • ami-amazon-linux-latest • ami-windows-latest • ec2-macos • appmesh • aws-for-fluent-bit • aws-sdk-pandas • bottlerocket • canonical • cloud9 • datasync • debian • deeplearning • ecs • eks • fis • freebsd • global-infrastructure • marketplace • neuron • powertools • sagemaker-distribution • storagegateway Not all public parameters are published to every AWS Region. Finding public parameters using the Parameter Store console You must have at least one parameter in your AWS account and AWS Region before you can search for public parameters using the console. Parameter Store 2105 AWS Systems Manager User Guide To find public parameters using the console 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Parameter Store. 3. Choose the Public parameters tab. 4. Choose the Select a service dropdown. Choose the service whose parameters you want to use. 5. (Optional) Filter the parameters owned by the service you selected by entering more information into the search bar. 6. Choose the public parameter you want to use. Finding public parameters using the AWS CLI Use describe-parameters for discovery of public parameters. Use get-parameters-by-path to get the actual path for a service listed under /aws/service/ list. To get the service's path, remove /list from the path. For example, /aws/service/list/ ecs becomes /aws/service/ecs. To retrieve a list of public parameters owned by different services in Parameter Store, run the following command. aws ssm get-parameters-by-path --path /aws/service/list The command returns information like the following. This example has been truncated for space. { "Parameters": [ { "Name": "/aws/service/list/ami-al-latest", "Type": "String", "Value": "/aws/service/ami-al-latest/", "Version": 1, "LastModifiedDate": "2021-01-29T10:25:10.902000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/list/ami-al-latest", "DataType": "text" }, { Parameter Store 2106 AWS Systems Manager User Guide "Name": "/aws/service/list/ami-windows-latest", "Type": "String", "Value": "/aws/service/ami-windows-latest/", "Version": 1, "LastModifiedDate": "2021-01-29T10:25:12.567000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/list/ami-windows- latest", "DataType": "text" }, { "Name": "/aws/service/list/aws-storage-gateway-latest", "Type": "String", "Value": "/aws/service/aws-storage-gateway-latest/", "Version": 1, "LastModifiedDate": "2021-01-29T10:25:09.903000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/list/aws-storage- gateway-latest", "DataType": "text" }, { "Name": "/aws/service/list/global-infrastructure", "Type": "String", "Value": "/aws/service/global-infrastructure/", "Version": 1, "LastModifiedDate": "2021-01-29T10:25:11.901000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/list/global- infrastructure", "DataType": "text" } ] } If you want to view parameters owned by a specific service, choose the service from the list that was produced after running the earlier command. Then, make a get-parameters-by-path call using the name of your desired service. For example, /aws/service/global-infrastructure. The path might be one-level (only calls parameters that match the exact values given) or recursive (contains elements in the path beyond what you have given). Parameter Store 2107 AWS Systems Manager Note User Guide The /aws/service/global-infrastructure path is not supported for queries in all Regions. For information, see Calling public parameters for AWS services, Regions, endpoints, Availability Zones, local zones, and Wavelength Zones in Parameter Store. If no results are returned for the service you specify, add the --recursive flag and run the command again. aws ssm get-parameters-by-path --path /aws/service/global-infrastructure This returns all parameters owned by global-infrastructure. The following is an example. { "Parameters": [ { "Name": "/aws/service/global-infrastructure/current-region", "Type": "String", "LastModifiedDate": "2019-06-21T05:15:34.252000-07:00", "Version": 1, "Tier": "Standard", "Policies": [], "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/version", "Type": "String", "LastModifiedDate": "2019-02-04T06:59:32.875000-08:00", "Version": 1, "Tier": "Standard", "Policies": [], "DataType": "text" } ] } You can also view parameters owned by a specific service by using the Option:BeginsWith filter. aws ssm describe-parameters --parameter-filters "Key=Name, Option=BeginsWith, Values=/ aws/service/ami-amazon-linux-latest" Parameter Store 2108 AWS Systems Manager User Guide The command returns information like the following. This example output has been truncated for space. { "Parameters": [ { "Name": "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-ebs", "Type": "String", "LastModifiedDate": "2021-01-26T13:39:40.686000-08:00", "Version": 25, "Tier": "Standard", "Policies": [], "DataType": "text" }, { "Name": "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-gp2", "Type": "String", "LastModifiedDate": "2021-01-26T13:39:40.807000-08:00", "Version": 25, "Tier": "Standard", "Policies": [], "DataType": "text" }, { "Name": "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-s3", "Type": "String", "LastModifiedDate": "2021-01-26T13:39:40.920000-08:00", "Version": 25, "Tier": "Standard", "Policies": [], "DataType": "text" } ] } Note The returned
|
systems-manager-ug-610
|
systems-manager-ug.pdf
| 610 |
also view parameters owned by a specific service by using the Option:BeginsWith filter. aws ssm describe-parameters --parameter-filters "Key=Name, Option=BeginsWith, Values=/ aws/service/ami-amazon-linux-latest" Parameter Store 2108 AWS Systems Manager User Guide The command returns information like the following. This example output has been truncated for space. { "Parameters": [ { "Name": "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-ebs", "Type": "String", "LastModifiedDate": "2021-01-26T13:39:40.686000-08:00", "Version": 25, "Tier": "Standard", "Policies": [], "DataType": "text" }, { "Name": "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-gp2", "Type": "String", "LastModifiedDate": "2021-01-26T13:39:40.807000-08:00", "Version": 25, "Tier": "Standard", "Policies": [], "DataType": "text" }, { "Name": "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-s3", "Type": "String", "LastModifiedDate": "2021-01-26T13:39:40.920000-08:00", "Version": 25, "Tier": "Standard", "Policies": [], "DataType": "text" } ] } Note The returned parameters might be different when you use Option=BeginsWith because it uses a different search pattern. Parameter Store 2109 AWS Systems Manager User Guide Calling AMI public parameters in Parameter Store Amazon Elastic Compute Cloud (Amazon EC2) Amazon Machine Image (AMI) public parameters are available for Amazon Linux 1, Amazon Linux 2, Amazon Linux 2023 (AL2023), macOS, and Windows Server from the following paths: • Amazon Linux 1, Amazon Linux 2, and Amazon Linux 2023: /aws/service/ami-amazon- linux-latest • macOS: /aws/service/ec2-macos • Windows Server: /aws/service/ami-windows-latest Calling AMI public parameters for Amazon Linux 1, Amazon Linux 2, and Amazon Linux 2023 You can view a list of all Amazon Linux 1, Amazon Linux 2, and Amazon Linux 2023 (AL2023) AMIs in the current AWS Region by using the following command in the AWS Command Line Interface (AWS CLI). Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/ami-amazon-linux-latest \ --query 'Parameters[].Name' Windows aws ssm get-parameters-by-path ^ --path /aws/service/ami-amazon-linux-latest ^ --query Parameters[].Name The command returns information like the following. [ "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64", "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-arm64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-x86_64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64", "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-gp2", Parameter Store 2110 AWS Systems Manager User Guide "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-s3", "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs", "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs", "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64", "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64", "/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-ebs", "/aws/service/ami-amazon-linux-latest/amzn-ami-minimal-hvm-x86_64-ebs", "/aws/service/ami-amazon-linux-latest/amzn-ami-minimal-hvm-x86_64-s3", "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-arm64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-arm64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-arm64-ebs", "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-x86_64-ebs" ] You can view details about these AMIs, including the AMI IDs and Amazon Resource Names (ARNs), by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path "/aws/service/ami-amazon-linux-latest" \ --region region Windows aws ssm get-parameters-by-path ^ --path "/aws/service/ami-amazon-linux-latest" ^ --region region region represents the identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. The command returns information like the following. This example output has been truncated for space. { "Parameters": [ Parameter Store 2111 AWS Systems Manager { User Guide "Name": "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64", "Type": "String", "Value": "ami-0b1b8b24a6c8e5d8b", "Version": 69, "LastModifiedDate": "2024-03-13T14:05:09.583000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-amazon-linux- latest/al2023-ami-kernel-6.1-arm64", "DataType": "text" }, { "Name": "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1- x86_64", "Type": "String", "Value": "ami-0e0bf53f6def86294", "Version": 69, "LastModifiedDate": "2024-03-13T14:05:09.890000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-amazon-linux- latest/al2023-ami-kernel-6.1-x86_64", "DataType": "text" }, { "Name": "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal- kernel-6.1-arm64", "Type": "String", "Value": "ami-09951bb66f9e5b5a5", "Version": 69, "LastModifiedDate": "2024-03-13T14:05:10.197000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-amazon-linux- latest/al2023-ami-minimal-kernel-6.1-arm64", "DataType": "text" } ] } You can view details of a specific AMI by using the GetParameters API operation with the full AMI name, including the path. Here is an example command. Linux & macOS aws ssm get-parameters \ --names /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64 \ --region us-east-2 Parameter Store 2112 AWS Systems Manager Windows User Guide aws ssm get-parameters ^ --names /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64 ^ --region us-east-2 The command returns the following information. { "Parameters": [ { "Name": "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64", "Type": "String", "Value": "ami-0b1b8b24a6c8e5d8b", "Version": 69, "LastModifiedDate": "2024-03-13T14:05:09.583000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-amazon-linux- latest/al2023-ami-kernel-6.1-arm64", "DataType": "text" } ], "InvalidParameters": [] } Calling AMI public parameters for macOS You can view a list of all macOS AMIs in the current AWS Region by using the following command in the AWS CLI. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/ec2-macos\ --query 'Parameters[].Name' Windows aws ssm get-parameters-by-path ^ --path /aws/service/ec2-macos ^ --query Parameters[].Name Parameter Store 2113 AWS Systems Manager User Guide The command returns information like the following. [ "/aws/service/ec2-macos/sonoma/x86_64_mac/latest/image_id", "/aws/service/ec2-macos/ventura/x86_64_mac/latest/image_id", "/aws/service/ec2-macos/monterey/x86_64_mac/latest/image_id", "/aws/service/ec2-macos/sonoma/arm64_mac/latest/image_id", "/aws/service/ec2-macos/ventura/arm64_mac/latest/image_id", "/aws/service/ec2-macos/monterey/arm64_mac/latest/image_id" ] You can view details about these AMIs, including the AMI IDs and Amazon Resource Names (ARNs), by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path "/aws/service/ec2-macos" \ --region region Windows aws ssm get-parameters-by-path ^ --path "/aws/service/ec2-macos" ^ --region region region represents the identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. The command returns information like the following. This example output has been truncated for space. { "Parameters": [ ...sample results pending... ] } Parameter Store 2114 AWS Systems Manager User Guide You can view details of a specific AMI by using the GetParameters API operation with the full AMI name, including the path. Here is an example command. Linux & macOS aws ssm get-parameters \ --names /aws/service/ec2-macos/...pending... \ --region us-east-2 Windows aws ssm get-parameters ^ --names /aws/service/ec2-macos/...pending... ^ --region us-east-2 The command returns the following information. { "Parameters":
|
systems-manager-ug-611
|
systems-manager-ug.pdf
| 611 |
in Systems Manager service endpoints in the Amazon Web Services General Reference. The command returns information like the following. This example output has been truncated for space. { "Parameters": [ ...sample results pending... ] } Parameter Store 2114 AWS Systems Manager User Guide You can view details of a specific AMI by using the GetParameters API operation with the full AMI name, including the path. Here is an example command. Linux & macOS aws ssm get-parameters \ --names /aws/service/ec2-macos/...pending... \ --region us-east-2 Windows aws ssm get-parameters ^ --names /aws/service/ec2-macos/...pending... ^ --region us-east-2 The command returns the following information. { "Parameters": [ ...sample results pending... ], "InvalidParameters": [] } Calling AMI public parameters for Windows Server You can view a list of all Windows Server AMIs in the current AWS Region by using the following command in the AWS CLI. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/ami-windows-latest \ --query 'Parameters[].Name' Windows aws ssm get-parameters-by-path ^ --path /aws/service/ami-windows-latest ^ --query Parameters[].Name Parameter Store 2115 AWS Systems Manager User Guide The command returns information like the following. This example output has been truncated for space. [ "/aws/service/ami-windows-latest/EC2LaunchV2-Windows_Server-2016-English-Full- Base", "/aws/service/ami-windows-latest/Windows_Server-2016-English-Full- SQL_2014_SP3_Enterprise", "/aws/service/ami-windows-latest/Windows_Server-2016-German-Full-Base", "/aws/service/ami-windows-latest/Windows_Server-2016-Japanese-Full- SQL_2016_SP3_Standard", "/aws/service/ami-windows-latest/Windows_Server-2016-Japanese-Full-SQL_2017_Web", "/aws/service/ami-windows-latest/Windows_Server-2019-English-Core- EKS_Optimized-1.25", "/aws/service/ami-windows-latest/Windows_Server-2019-Italian-Full-Base", "/aws/service/ami-windows-latest/Windows_Server-2022-Japanese-Full- SQL_2019_Enterprise", "/aws/service/ami-windows-latest/Windows_Server-2022-Portuguese_Brazil-Full-Base", "/aws/service/ami-windows-latest/amzn2-ami-hvm-2.0.20191217.0-x86_64-gp2-mono", "/aws/service/ami-windows-latest/Windows_Server-2016-English-Deep-Learning", "/aws/service/ami-windows-latest/Windows_Server-2016-Japanese-Full- SQL_2016_SP3_Web", "/aws/service/ami-windows-latest/Windows_Server-2016-Korean-Full-Base", "/aws/service/ami-windows-latest/Windows_Server-2019-English-STIG-Core", "/aws/service/ami-windows-latest/Windows_Server-2019-French-Full-Base", "/aws/service/ami-windows-latest/Windows_Server-2019-Japanese-Full- SQL_2017_Enterprise", "/aws/service/ami-windows-latest/Windows_Server-2019-Korean-Full-Base", "/aws/service/ami-windows-latest/Windows_Server-2022-English-Full-SQL_2022_Web", "/aws/service/ami-windows-latest/Windows_Server-2022-Italian-Full-Base", "/aws/service/ami-windows-latest/amzn2-x86_64-SQL_2019_Express", "/aws/service/ami-windows-latest/EC2LaunchV2-Windows_Server-2016-English-Core- Base", "/aws/service/ami-windows-latest/Windows_Server-2016-English-Full- SQL_2019_Enterprise", "/aws/service/ami-windows-latest/Windows_Server-2016-English-Full- SQL_2019_Standard", "/aws/service/ami-windows-latest/Windows_Server-2016-Portuguese_Portugal-Full- Base", "/aws/service/ami-windows-latest/Windows_Server-2019-English-Core- EKS_Optimized-1.24", "/aws/service/ami-windows-latest/Windows_Server-2019-English-Deep-Learning", "/aws/service/ami-windows-latest/Windows_Server-2019-English-Full-SQL_2017_Web", Parameter Store 2116 AWS Systems Manager User Guide "/aws/service/ami-windows-latest/Windows_Server-2019-Hungarian-Full-Base ] You can view details about these AMIs, including the AMI IDs and Amazon Resource Names (ARNs), by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path "/aws/service/ami-windows-latest" \ --region region Windows aws ssm get-parameters-by-path ^ --path "/aws/service/ami-windows-latest" ^ --region region region represents the identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. The command returns information like the following. This example output has been truncated for space. { "Parameters": [ { "Name": "/aws/service/ami-windows-latest/EC2LaunchV2-Windows_Server-2016- English-Full-Base", "Type": "String", "Value": "ami-0a30b2e65863e2d16", "Version": 36, "LastModifiedDate": "2024-03-15T15:58:37.976000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-windows-latest/ EC2LaunchV2-Windows_Server-2016-English-Full-Base", "DataType": "text" }, { "Name": "/aws/service/ami-windows-latest/Windows_Server-2016-English-Full- SQL_2014_SP3_Enterprise", Parameter Store 2117 AWS Systems Manager User Guide "Type": "String", "Value": "ami-001f20c053dd120ce", "Version": 69, "LastModifiedDate": "2024-03-15T15:53:58.905000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-windows-latest/ Windows_Server-2016-English-Full-SQL_2014_SP3_Enterprise", "DataType": "text" }, { "Name": "/aws/service/ami-windows-latest/Windows_Server-2016-German-Full- Base", "Type": "String", "Value": "ami-063be4935453e94e9", "Version": 102, "LastModifiedDate": "2024-03-15T15:51:12.003000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-windows-latest/ Windows_Server-2016-German-Full-Base", "DataType": "text" } ] } You can view details of a specific AMI by using the GetParameters API operation with the full AMI name, including the path. Here is an example command. Linux & macOS aws ssm get-parameters \ --names /aws/service/ami-windows-latest/EC2LaunchV2-Windows_Server-2016-English- Full-Base \ --region us-east-2 Windows aws ssm get-parameters ^ --names /aws/service/ami-windows-latest/EC2LaunchV2-Windows_Server-2016-English- Full-Base ^ --region us-east-2 The command returns the following information. Parameter Store 2118 AWS Systems Manager User Guide { "Parameters": [ { "Name": "/aws/service/ami-windows-latest/EC2LaunchV2-Windows_Server-2016- English-Full-Base", "Type": "String", "Value": "ami-0a30b2e65863e2d16", "Version": 36, "LastModifiedDate": "2024-03-15T15:58:37.976000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ami-windows-latest/ EC2LaunchV2-Windows_Server-2016-English-Full-Base", "DataType": "text" } ], "InvalidParameters": [] } Calling the ECS optimized AMI public parameter in Parameter Store The Amazon Elastic Container Service (Amazon ECS) service publishes the name of the latest Amazon ECS optimized Amazon Machine Images (AMIs) as public parameters. Users are encouraged to use this AMI when creating a new Amazon Elastic Compute Cloud (Amazon EC2) cluster for Amazon ECS because the optimized AMIs include bug fixes and feature updates. Use the following command to view the name of the latest Amazon ECS optimized AMI for Amazon Linux 2. To see commands for other operating systems, see Retrieving Amazon ECS-Optimized AMI metadata in the Amazon Elastic Container Service Developer Guide. Linux & macOS aws ssm get-parameters \ --names /aws/service/ecs/optimized-ami/amazon-linux-2/recommended Windows aws ssm get-parameters ^ --names /aws/service/ecs/optimized-ami/amazon-linux-2/recommended The command returns information like the following. Parameter Store 2119 AWS Systems Manager User Guide { "Parameters": [ { "Name": "/aws/service/ecs/optimized-ami/amazon-linux-2/recommended", "Type": "String", "Value": "{\"schema_version\":1,\"image_name\":\"amzn2-ami-ecs- hvm-2.0.20210929-x86_64-ebs\",\"image_id\":\"ami-0c38a2329ed4dae9a\",\"os\":\"Amazon Linux 2\",\"ecs_runtime_version\":\"Docker version 20.10.7\",\"ecs_agent_version\": \"1.55.4\"}", "Version": 73, "LastModifiedDate": "2021-10-06T16:35:10.004000-07:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/ecs/optimized-ami/ amazon-linux-2/recommended", "DataType": "text" } ], "InvalidParameters": [] } Calling the EKS optimized AMI public parameter in Parameter Store The Amazon Elastic Kubernetes Service (Amazon EKS) service publishes the name of the latest Amazon EKS optimized Amazon Machine Image (AMI) as a public parameter. We encourage you to use this AMI when adding nodes to an Amazon EKS cluster, as new releases include Kubernetes patches and security updates. Previously, to guarantee you were using the latest AMI meant checking the Amazon EKS documentation and manually updating any deployment templates or resources with the new AMI ID. Use the following command to view the name of the latest Amazon EKS optimized AMI for Amazon Linux 2. Linux & macOS aws ssm get-parameters \ --names /aws/service/eks/optimized-ami/1.14/amazon-linux-2/recommended Windows aws ssm get-parameters ^ --names /aws/service/eks/optimized-ami/1.14/amazon-linux-2/recommended Parameter Store 2120 AWS Systems Manager User Guide The command returns information like the following. { "Parameters": [
|
systems-manager-ug-612
|
systems-manager-ug.pdf
| 612 |
this AMI when adding nodes to an Amazon EKS cluster, as new releases include Kubernetes patches and security updates. Previously, to guarantee you were using the latest AMI meant checking the Amazon EKS documentation and manually updating any deployment templates or resources with the new AMI ID. Use the following command to view the name of the latest Amazon EKS optimized AMI for Amazon Linux 2. Linux & macOS aws ssm get-parameters \ --names /aws/service/eks/optimized-ami/1.14/amazon-linux-2/recommended Windows aws ssm get-parameters ^ --names /aws/service/eks/optimized-ami/1.14/amazon-linux-2/recommended Parameter Store 2120 AWS Systems Manager User Guide The command returns information like the following. { "Parameters": [ { "Name": "/aws/service/eks/optimized-ami/1.14/amazon-linux-2/recommended", "Type": "String", "Value": "{\"schema_version\":\"2\",\"image_id\":\"ami-08984d8491de17ca0\", \"image_name\":\"amazon-eks-node-1.14-v20201007\",\"release_version\": \"1.14.9-20201007\"}", "Version": 24, "LastModifiedDate": "2020-11-17T10:16:09.971000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/eks/optimized- ami/1.14/amazon-linux-2/recommended", "DataType": "text" } ], "InvalidParameters": [] } Calling public parameters for AWS services, Regions, endpoints, Availability Zones, local zones, and Wavelength Zones in Parameter Store You can call the AWS Region, service, endpoint, Availability, and Wavelength Zones of public parameters by using the following path. /aws/service/global-infrastructure Note Currently, the path /aws/service/global-infrastructure is supported for queries in the following AWS Regions only: • US East (N. Virginia) (us-east-1) • US East (Ohio) (us-east-2) • US West (N. California) (us-west-1) • US West (Oregon) (us-west-2) • Asia Pacific (Hong Kong) (ap-east-1) • Asia Pacific (Mumbai) (ap-south-1) • Asia Pacific (Seoul) (ap-northeast-2) Parameter Store 2121 AWS Systems Manager User Guide • Asia Pacific (Singapore) (ap-southeast-1) • Asia Pacific (Sydney) (ap-southeast-2) • Asia Pacific (Tokyo) (ap-northeast-1) • Canada (Central) (ca-central-1) • Europe (Frankfurt) (eu-central-1) • Europe (Ireland) (eu-west-1) • Europe (London) (eu-west-2) • Europe (Paris) (eu-west-3) • Europe (Stockholm) (eu-north-1) • South America (São Paulo) (sa-east-1) If you are working in a different commercial Region, you can specify a supported Region in your query to view results. For example, if you are working in the Canada West (Calgary) (ca-west-1) Region, you could specify Canada (Central) (ca-central-1) in your query: aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/regions \ --region ca-central-1 View active AWS Regions You can view a list of all active AWS Regions by using the following command in the AWS Command Line Interface (AWS CLI). Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/regions \ --query 'Parameters[].Name' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/regions ^ --query Parameters[].Name Parameter Store 2122 AWS Systems Manager User Guide The command returns information like the following. [ "/aws/service/global-infrastructure/regions/af-south-1", "/aws/service/global-infrastructure/regions/ap-east-1", "/aws/service/global-infrastructure/regions/ap-northeast-3", "/aws/service/global-infrastructure/regions/ap-south-2", "/aws/service/global-infrastructure/regions/ca-central-1", "/aws/service/global-infrastructure/regions/eu-central-2", "/aws/service/global-infrastructure/regions/eu-west-2", "/aws/service/global-infrastructure/regions/eu-west-3", "/aws/service/global-infrastructure/regions/us-east-1", "/aws/service/global-infrastructure/regions/us-gov-west-1", "/aws/service/global-infrastructure/regions/ap-northeast-2", "/aws/service/global-infrastructure/regions/ap-southeast-1", "/aws/service/global-infrastructure/regions/ap-southeast-2", "/aws/service/global-infrastructure/regions/ap-southeast-3", "/aws/service/global-infrastructure/regions/cn-north-1", "/aws/service/global-infrastructure/regions/cn-northwest-1", "/aws/service/global-infrastructure/regions/eu-south-1", "/aws/service/global-infrastructure/regions/eu-south-2", "/aws/service/global-infrastructure/regions/us-east-2", "/aws/service/global-infrastructure/regions/us-west-1", "/aws/service/global-infrastructure/regions/ap-northeast-1", "/aws/service/global-infrastructure/regions/ap-south-1", "/aws/service/global-infrastructure/regions/ap-southeast-4", "/aws/service/global-infrastructure/regions/ca-west-1", "/aws/service/global-infrastructure/regions/eu-central-1", "/aws/service/global-infrastructure/regions/il-central-1", "/aws/service/global-infrastructure/regions/me-central-1", "/aws/service/global-infrastructure/regions/me-south-1", "/aws/service/global-infrastructure/regions/sa-east-1", "/aws/service/global-infrastructure/regions/us-gov-east-1", "/aws/service/global-infrastructure/regions/eu-north-1", "/aws/service/global-infrastructure/regions/eu-west-1", "/aws/service/global-infrastructure/regions/us-west-2" ] View available AWS services You can view a complete list of all available AWS services and sort them into alphabetical order by using the following command. This example output has been truncated for space. Parameter Store 2123 AWS Systems Manager Linux & macOS User Guide aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/services \ --query 'Parameters[].Name | sort(@)' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/services ^ --query "Parameters[].Name | sort(@)" The command returns information like the following. This example has been truncated for space. [ "/aws/service/global-infrastructure/services/accessanalyzer", "/aws/service/global-infrastructure/services/account", "/aws/service/global-infrastructure/services/acm", "/aws/service/global-infrastructure/services/acm-pca", "/aws/service/global-infrastructure/services/ahl", "/aws/service/global-infrastructure/services/aiq", "/aws/service/global-infrastructure/services/amazonlocationservice", "/aws/service/global-infrastructure/services/amplify", "/aws/service/global-infrastructure/services/amplifybackend", "/aws/service/global-infrastructure/services/apigateway", "/aws/service/global-infrastructure/services/apigatewaymanagementapi", "/aws/service/global-infrastructure/services/apigatewayv2", "/aws/service/global-infrastructure/services/appconfig", "/aws/service/global-infrastructure/services/appconfigdata", "/aws/service/global-infrastructure/services/appflow", "/aws/service/global-infrastructure/services/appintegrations", "/aws/service/global-infrastructure/services/application-autoscaling", "/aws/service/global-infrastructure/services/application-insights", "/aws/service/global-infrastructure/services/applicationcostprofiler", "/aws/service/global-infrastructure/services/appmesh", "/aws/service/global-infrastructure/services/apprunner", "/aws/service/global-infrastructure/services/appstream", "/aws/service/global-infrastructure/services/appsync", "/aws/service/global-infrastructure/services/aps", "/aws/service/global-infrastructure/services/arc-zonal-shift", "/aws/service/global-infrastructure/services/artifact", "/aws/service/global-infrastructure/services/athena", Parameter Store 2124 AWS Systems Manager User Guide "/aws/service/global-infrastructure/services/auditmanager", "/aws/service/global-infrastructure/services/augmentedairuntime", "/aws/service/global-infrastructure/services/aurora", "/aws/service/global-infrastructure/services/autoscaling", "/aws/service/global-infrastructure/services/aws-appfabric", "/aws/service/global-infrastructure/services/awshealthdashboard", View supported Regions for an AWS service You can view a list of AWS Regions where a service is available. This example uses AWS Systems Manager (ssm). Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/services/ssm/regions \ --query 'Parameters[].Value' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/services/ssm/regions ^ --query Parameters[].Value The command returns information like the following. [ "ap-south-1", "eu-central-1", "eu-central-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-south-1", "us-east-2", "us-gov-west-1", "af-south-1", "ap-northeast-3", "ap-southeast-1", "ap-southeast-4", Parameter Store 2125 AWS Systems Manager User Guide "ca-central-1", "ca-west-1", "cn-north-1", "eu-north-1", "eu-south-2", "us-west-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-2", "ap-southeast-3", "cn-northwest-1", "eu-south-1", "me-central-1", "us-gov-east-1", "us-west-2", "ap-south-2", "sa-east-1", "us-east-1" ] View the Regional endpoint for a service You can view a Regional endpoint for a service by using the following command. This command queries the US East (Ohio) (us-east-2) Region. Linux & macOS aws ssm get-parameter \ --name /aws/service/global-infrastructure/regions/us-east-2/services/ssm/ endpoint \ --query 'Parameter.Value' Windows aws ssm get-parameter ^ --name /aws/service/global-infrastructure/regions/us-east-2/services/ssm/ endpoint ^ --query Parameter.Value The command returns information like the following. Parameter Store 2126 AWS Systems Manager User Guide "ssm.us-east-2.amazonaws.com" View complete Availability Zone details You can view Availability Zones by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/availability-zones/ Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/availability-zones/ The command returns information like the following. This example has been truncated for space. { "Parameters": [ { "Name": "/aws/service/global-infrastructure/availability-zones/afs1-az3", "Type": "String", "Value": "afs1-az3", "Version": 1, "LastModifiedDate": "2020-04-21T12:05:35.375000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ availability-zones/afs1-az3", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/availability-zones/aps1-az2", "Type": "String", "Value": "aps1-az2", "Version": 1, "LastModifiedDate": "2020-04-03T16:13:57.351000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ availability-zones/aps1-az2", "DataType": "text" }, { Parameter Store 2127 AWS Systems
|
systems-manager-ug-613
|
systems-manager-ug.pdf
| 613 |
like the following. Parameter Store 2126 AWS Systems Manager User Guide "ssm.us-east-2.amazonaws.com" View complete Availability Zone details You can view Availability Zones by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/availability-zones/ Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/availability-zones/ The command returns information like the following. This example has been truncated for space. { "Parameters": [ { "Name": "/aws/service/global-infrastructure/availability-zones/afs1-az3", "Type": "String", "Value": "afs1-az3", "Version": 1, "LastModifiedDate": "2020-04-21T12:05:35.375000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ availability-zones/afs1-az3", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/availability-zones/aps1-az2", "Type": "String", "Value": "aps1-az2", "Version": 1, "LastModifiedDate": "2020-04-03T16:13:57.351000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ availability-zones/aps1-az2", "DataType": "text" }, { Parameter Store 2127 AWS Systems Manager User Guide "Name": "/aws/service/global-infrastructure/availability-zones/apse3-az1", "Type": "String", "Value": "apse3-az1", "Version": 1, "LastModifiedDate": "2021-12-13T08:51:38.983000-05:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ availability-zones/apse3-az1", "DataType": "text" } ] } View Availability Zone names only You can view the names of Availability Zones only by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/availability-zones \ --query 'Parameters[].Name | sort(@)' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/availability-zones ^ --query "Parameters[].Name | sort(@)" The command returns information like the following. This example has been truncated for space. [ "/aws/service/global-infrastructure/availability-zones/afs1-az1", "/aws/service/global-infrastructure/availability-zones/afs1-az2", "/aws/service/global-infrastructure/availability-zones/afs1-az3", "/aws/service/global-infrastructure/availability-zones/ape1-az1", "/aws/service/global-infrastructure/availability-zones/ape1-az2", "/aws/service/global-infrastructure/availability-zones/ape1-az3", "/aws/service/global-infrastructure/availability-zones/apne1-az1", "/aws/service/global-infrastructure/availability-zones/apne1-az2", "/aws/service/global-infrastructure/availability-zones/apne1-az3", "/aws/service/global-infrastructure/availability-zones/apne1-az4" Parameter Store 2128 AWS Systems Manager User Guide View names of Availability Zones in a single Region You can view the names of the Availability Zones in one Region (us-east-2, in this example) using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/regions/us-east-2/availability-zones \ --query 'Parameters[].Name | sort(@)' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/regions/us-east-2/availability-zones ^ --query "Parameters[].Name | sort(@)" The command returns information like the following. [ "/aws/service/global-infrastructure/regions/us-east-2/availability-zones/use2-az1", "/aws/service/global-infrastructure/regions/us-east-2/availability-zones/use2-az2", "/aws/service/global-infrastructure/regions/us-east-2/availability-zones/use2-az3" View Availability Zone ARNs only You can view the Amazon Resource Names (ARNs) of Availability Zones only by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/availability-zones \ --query 'Parameters[].ARN | sort(@)' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/availability-zones ^ --query "Parameters[].ARN | sort(@)" Parameter Store 2129 AWS Systems Manager User Guide The command returns information like the following. This example has been truncated for space. [ "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/afs1-az1", "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/afs1-az2", "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/afs1-az3", "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/ape1-az1", "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/ape1-az2", "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/ape1-az3", "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/availability- zones/apne1-az1", View local zone details You can view local zones by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/local-zones Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/local-zones The command returns information like the following. This example has been truncated for space. { "Parameters": [ { "Name": "/aws/service/global-infrastructure/local-zones/afs1-los1-az1", "Type": "String", "Value": "afs1-los1-az1", Parameter Store 2130 AWS Systems Manager "Version": 1, User Guide "LastModifiedDate": "2023-01-25T11:53:11.690000-05:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/afs1-los1-az1", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/apne1-tpe1-az1", "Type": "String", "Value": "apne1-tpe1-az1", "Version": 1, "LastModifiedDate": "2024-03-15T12:35:41.076000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/apne1-tpe1-az1", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/aps1-ccu1-az1", "Type": "String", "Value": "aps1-ccu1-az1", "Version": 1, "LastModifiedDate": "2022-12-19T11:34:43.351000-05:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/aps1-ccu1-az1", "DataType": "text" } ] } View Wavelength Zone details You can view Wavelength Zones by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/wavelength-zones Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/wavelength-zones Parameter Store 2131 AWS Systems Manager User Guide The command returns information like the following. This example has been truncated for space. { "Parameters": [ { "Name": "/aws/service/global-infrastructure/wavelength-zones/apne1-wl1-nrt- wlz1", "Type": "String", "Value": "apne1-wl1-nrt-wlz1", "Version": 3, "LastModifiedDate": "2020-12-15T17:16:04.715000-05:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ wavelength-zones/apne1-wl1-nrt-wlz1", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/wavelength-zones/apne2-wl1-sel- wlz1", "Type": "String", "Value": "apne2-wl1-sel-wlz1", "Version": 1, "LastModifiedDate": "2022-05-25T12:29:13.862000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ wavelength-zones/apne2-wl1-sel-wlz1", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/wavelength-zones/cac1-wl1-yto- wlz1", "Type": "String", "Value": "cac1-wl1-yto-wlz1", "Version": 1, "LastModifiedDate": "2022-04-26T09:57:44.495000-04:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ wavelength-zones/cac1-wl1-yto-wlz1", "DataType": "text" } ] } View all parameters and values under a local zone You can view all parameter data for a local zone by using the following command. Parameter Store 2132 AWS Systems Manager Linux & macOS User Guide aws ssm get-parameters-by-path \ --path "/aws/service/global-infrastructure/local-zones/usw2-lax1-az1/" Windows aws ssm get-parameters-by-path ^ --path "/aws/service/global-infrastructure/local-zones/use1-bos1-az1" The command returns information like the following. This example has been truncated for space. { "Parameters": [ { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ geolocationCountry", "Type": "String", "Value": "US", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:17.641000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/geolocationCountry", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ geolocationRegion", "Type": "String", "Value": "US-MA", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:17.794000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/geolocationRegion", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ location", "Type": "String", "Value": "US East (Boston)", "Version": 1, Parameter Store 2133 AWS Systems Manager User Guide "LastModifiedDate": "2021-01-11T10:53:24.634000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/location", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ network-border-group", "Type": "String", "Value": "us-east-1-bos-1", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:20.641000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/network-border-group", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ parent-availability-zone", "Type": "String", "Value": "use1-az4", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:20.834000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/parent-availability-zone", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ parent-region", "Type": "String", "Value": "us-east-1", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:20.721000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/parent-region", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/zone- group", "Type": "String", "Value": "us-east-1-bos-1", "Version": 3, Parameter Store 2134 AWS Systems Manager User Guide "LastModifiedDate": "2020-12-15T14:16:17.983000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/zone-group", "DataType": "text" } ] } View local zone parameter names only You can view just the names of local zone parameters by using the following
|
systems-manager-ug-614
|
systems-manager-ug.pdf
| 614 |
"/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ network-border-group", "Type": "String", "Value": "us-east-1-bos-1", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:20.641000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/network-border-group", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ parent-availability-zone", "Type": "String", "Value": "use1-az4", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:20.834000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/parent-availability-zone", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/ parent-region", "Type": "String", "Value": "us-east-1", "Version": 3, "LastModifiedDate": "2020-12-15T14:16:20.721000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/parent-region", "DataType": "text" }, { "Name": "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/zone- group", "Type": "String", "Value": "us-east-1-bos-1", "Version": 3, Parameter Store 2134 AWS Systems Manager User Guide "LastModifiedDate": "2020-12-15T14:16:17.983000-08:00", "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/global-infrastructure/ local-zones/use1-bos1-az1/zone-group", "DataType": "text" } ] } View local zone parameter names only You can view just the names of local zone parameters by using the following command. Linux & macOS aws ssm get-parameters-by-path \ --path /aws/service/global-infrastructure/local-zones/usw2-lax1-az1 \ --query 'Parameters[].Name | sort(@)' Windows aws ssm get-parameters-by-path ^ --path /aws/service/global-infrastructure/local-zones/use1-bos1-az1 ^ --query "Parameters[].Name | sort(@)" The command returns information like the following. [ "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/geolocationCountry", "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/geolocationRegion", "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/location", "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/network-border- group", "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/parent-availability- zone", "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/parent-region", "/aws/service/global-infrastructure/local-zones/use1-bos1-az1/zone-group" ] Parameter Store 2135 AWS Systems Manager User Guide Parameter Store walkthroughs The walkthrough in this section shows you how to create, store, and run parameters with Parameter Store, a tool in AWS Systems Manager, in a test environment. This walkthrough shows you how to use Parameter Store with other Systems Manager tools. You can also use Parameter Store with other AWS services. For more information, see What is a parameter?. Contents • Creating a SecureString parameter in Parameter Store and joining a node to a Domain (PowerShell) Creating a SecureString parameter in Parameter Store and joining a node to a Domain (PowerShell) This walkthrough shows how to join a Windows Server node to a domain using AWS Systems Manager SecureString parameters and Run Command. The walkthrough uses typical domain parameters, such as the domain name and a domain user name. These values are passed as unencrypted string values. The domain password is encrypted using an AWS managed key and passed as an encrypted string. Prerequisites This walkthrough assumes that you already specified your domain name and DNS server IP address in the DHCP option set that is associated with your Amazon VPC. For information, see Working with DHCP Options Sets in the Amazon VPC User Guide. To create a SecureString parameter and join a node to a domain 1. Enter parameters into the system using AWS Tools for Windows PowerShell. In the following commands, replace each user input placeholder with your own information. Write-SSMParameter -Name "domainName" -Value "DOMAIN-NAME" -Type String Write-SSMParameter -Name "domainJoinUserName" -Value "DOMAIN\USERNAME" -Type String Write-SSMParameter -Name "domainJoinPassword" -Value "PASSWORD" -Type SecureString Parameter Store 2136 AWS Systems Manager User Guide Important Only the value of a SecureString parameter is encrypted. Parameter names, descriptions, and other properties aren't encrypted. 2. Attach the following AWS Identity and Access Management (IAM) policies to the IAM role permissions for your node: • AmazonSSMManagedInstanceCore – Required. This AWS managed policy allows a managed node to use Systems Manager service core functionality. • AmazonSSMDirectoryServiceAccess – Required. This AWS managed policy allows SSM Agent to access AWS Directory Service on your behalf for requests to join the domain by the managed node. • A custom policy for S3 bucket access – Required. SSM Agent, which is on your node and performs Systems Manager tasks, requires access to specific Amazon-owned Amazon Simple Storage Service (Amazon S3) buckets. In the custom S3 bucket policy that you create, you also provide access to S3 buckets of your own that are necessary for Systems Manager operations. Examples: You can write output for Run Command commands or Session Manager sessions to an S3 bucket, and then use this output later for auditing or troubleshooting. You store access scripts or custom patch baseline lists in an S3 bucket, and then reference the script or list when you run a command, or when a patch baseline is applied. For information about creating a custom policy for Amazon S3 bucket access, see Create a custom S3 bucket policy for an instance profile Note Saving output log data in an S3 bucket is optional, but we recommend setting it up at the beginning of your Systems Manager configuration process if you have decided to use it. For more information, see Create a Bucket in the Amazon Simple Storage Service User Guide. • CloudWatchAgentServerPolicy – Optional. This AWS managed policy allows you to run the CloudWatch agent on managed nodes. This policy makes it possible to read information on a Parameter Store 2137 AWS Systems Manager User Guide node and write it to Amazon CloudWatch. Your instance profile needs this policy only if you use services such as Amazon EventBridge or CloudWatch Logs. Note Using CloudWatch and EventBridge features is optional, but we recommend setting them up at the beginning of your Systems Manager configuration process if you have decided to use them. For more information, see the Amazon EventBridge User Guide and the Amazon CloudWatch Logs User Guide. 3.
|
systems-manager-ug-615
|
systems-manager-ug.pdf
| 615 |
allows you to run the CloudWatch agent on managed nodes. This policy makes it possible to read information on a Parameter Store 2137 AWS Systems Manager User Guide node and write it to Amazon CloudWatch. Your instance profile needs this policy only if you use services such as Amazon EventBridge or CloudWatch Logs. Note Using CloudWatch and EventBridge features is optional, but we recommend setting them up at the beginning of your Systems Manager configuration process if you have decided to use them. For more information, see the Amazon EventBridge User Guide and the Amazon CloudWatch Logs User Guide. 3. Edit the IAM role attached to the node and add the following policy. This policy gives the node permissions to call the kms:Decrypt and the ssm:CreateDocument API. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "kms:Decrypt", "ssm:CreateDocument" ], "Resource": [ "arn:aws:kms:region:account-id:key/kms-key-id" ] } ] } 4. Copy and paste the following json text into a text editor and save the file as JoinInstanceToDomain.json in the following location: c:\temp \JoinInstanceToDomain.json. { "schemaVersion": "2.2", "description": "Run a PowerShell script to securely join a Windows Server instance to a domain", "mainSteps": [ { "action": "aws:runPowerShellScript", "name": "runPowerShellWithSecureString", Parameter Store 2138 AWS Systems Manager User Guide "precondition": { "StringEquals": [ "platformType", "Windows" ] }, "inputs": { "runCommand": [ "$domain = (Get-SSMParameterValue -Name domainName).Parameters[0].Value", "if ((gwmi Win32_ComputerSystem).domain -eq $domain){write-host \"Computer is part of $domain, exiting\"; exit 0}", "$username = (Get-SSMParameterValue -Name domainJoinUserName).Parameters[0].Value", "$password = (Get-SSMParameterValue -Name domainJoinPassword - WithDecryption $True).Parameters[0].Value | ConvertTo-SecureString -asPlainText - Force", "$credential = New-Object System.Management.Automation.PSCredential($username,$password)", "Add-Computer -DomainName $domain -Credential $credential - ErrorAction SilentlyContinue -ErrorVariable domainjoinerror", "if($?){Write-Host \"Instance joined to domain successfully. Restarting\"; exit 3010}else{Write-Host \"Instance failed to join domain with error:\" $domainjoinerror; exit 1 }" ] } } ] } 5. Run the following command in Tools for Windows PowerShell to create a new SSM document. $json = Get-Content C:\temp\JoinInstanceToDomain | Out-String New-SSMDocument -Name JoinInstanceToDomain -Content $json -DocumentType Command 6. Run the following command in Tools for Windows PowerShell to join the node to the domain. Send-SSMCommand -InstanceId instance-id -DocumentName JoinInstanceToDomain If the command succeeds, the system returns information similar to the following. WARNING: The changes will take effect after you restart the computer EC2ABCD- EXAMPLE. Parameter Store 2139 AWS Systems Manager User Guide Domain join succeeded, restarting Computer is part of example.local, exiting If the command fails, the system returns information similar to the following. Failed to join domain with error: Computer 'EC2ABCD-EXAMPLE' failed to join domain 'example.local' from its current workgroup 'WORKGROUP' with following error message: The specified domain either does not exist or could not be contacted. Auditing and logging Parameter Store activity AWS CloudTrail captures API calls made in the AWS Systems Manager console, the AWS Command Line Interface (AWS CLI), and the Systems Manager SDK. You can view the information in the CloudTrail console or in an Amazon Simple Storage Service (Amazon S3) bucket. All CloudTrail logs for your account use one bucket. For more information about viewing and using CloudTrail logs of Systems Manager activity, see Logging AWS Systems Manager API calls with AWS CloudTrail. For more information about auditing and logging options for Systems Manager, see Logging and monitoring in AWS Systems Manager. Troubleshooting Parameter Store Use the following information to help you troubleshoot problems with Parameter Store, a tool in AWS Systems Manager. Troubleshooting aws:ec2:image parameter creation Use the following information to help troubleshoot problems with creating aws:ec2:image data type parameters. No permission to create an instance Problem: You try to create an instance using an aws:ec2:image parameter but receive an error message such as "You are not authorized to perform this operation." • Solution: You do not have all the permissions needed to create an EC2 instance using a parameter value, such as permissions for ec2:RunInstances, ec2:DescribeImages, and ssm:GetParameter, among others. Contact a user with administrator permissions in your organzation to request the necessary permissions. Parameter Store 2140 AWS Systems Manager User Guide EventBridge reports the failure message "Unable to Describe Resource" Problem: You ran a command to create an aws:ec2:image parameter, but parameter creation failed. You receive a notification from Amazon EventBridge that reports the exception "Unable to Describe Resource". Solution: This message can indicate the following: • You do not have all the permissions needed for the ec2:DescribeImages API operation, or you lack permission to access the specific image referenced in the parameter. Contact a user with administrator permissions in your organization to request the necessary permissions. • The Amazon Machine Image (AMI) ID you entered as a parameter value isn't valid. Make sure you're entering the ID of an AMI that is available in the current AWS Region and account you're working in. New aws:ec2:image parameter isn't available Problem: You just ran a command to create an aws:ec2:image parameter and a version number was reported, but the
|
systems-manager-ug-616
|
systems-manager-ug.pdf
| 616 |
do not have all the permissions needed for the ec2:DescribeImages API operation, or you lack permission to access the specific image referenced in the parameter. Contact a user with administrator permissions in your organization to request the necessary permissions. • The Amazon Machine Image (AMI) ID you entered as a parameter value isn't valid. Make sure you're entering the ID of an AMI that is available in the current AWS Region and account you're working in. New aws:ec2:image parameter isn't available Problem: You just ran a command to create an aws:ec2:image parameter and a version number was reported, but the parameter isn't available. • Solution: When you run the command to create a parameter that uses the aws:ec2:image data type, a version number is generated for the parameter right away, but the parameter format must be validated before the parameter is available. This process can take up to a few minutes. To monitor the parameter creation and validation process, you can do the following: • Use EventBridge to send you notifications about your create and update parameter operations. These notifications report whether a parameter operation was successful or not. For information about subscribing to Parameter Store events in EventBridge, see Setting up notifications or triggering actions based on Parameter Store events. • In the Parameter Store section of the Systems Manager console, refresh the list of parameters periodically to search for the new or updated parameter details. • Use the GetParameter command to check for the new or updated parameter. For example, using the AWS Command Line Interface (AWS CLI): aws ssm get-parameter name MyParameter Parameter Store 2141 AWS Systems Manager User Guide For a new parameter, a ParameterNotFound message is returned until the parameter is validated. For an existing parameter that you're updating, information about the new version isn't included until the parameter is validated. If you attempt to create or update the parameter again before the validation process is complete, the system reports that validation is still in process. If the parameter isn't created or updated, you can try again after 5 minutes have passed from the original attempt. AWS Systems Manager operations tools Operations tools are a suite of capabilities that help you manage your AWS resources. • Amazon CloudWatch dashboards hosted by Systems Manager are customizable home pages in the CloudWatch console that you can use to monitor your resources across AWS Regions in a single view. • Explorer is a customizable operations dashboard that reports information about your AWS resources. Explorer displays an aggregated view of operations data (OpsData) for your AWS accounts and across AWS Regions. • Incident Manager helps you mitigate and recover from incidents affecting your applications hosted on AWS. • OpsCenter provides a central location where operations engineers and IT professionals can view, investigate, and resolve operational work items (OpsItems) related to AWS resources. Topics • AWS Systems Manager Incident Manager • AWS Systems Manager Explorer • AWS Systems Manager OpsCenter • Using Amazon CloudWatch dashboards hosted by Systems Manager AWS Systems Manager Incident Manager Use Incident Manager, a tool in AWS Systems Manager, to manage incidents occurring in your AWS hosted applications. Incident Manager combines user engagements, escalation, runbooks, response plans, chat channels, and post-incident analysis to help your team triage incidents faster and return Operations tools 2142 AWS Systems Manager User Guide your applications to normal. To learn more about Incident Manager, see the Incident Manager User Guide. AWS Systems Manager Explorer AWS Systems Manager Explorer is a customizable operations dashboard that reports information about your AWS resources. Explorer displays an aggregated view of operations data (OpsData) for your AWS accounts and across AWS Regions. In Explorer, OpsData includes metadata about the managed nodes in your hybrid and multicloud environment. OpsData also includes information provided by other Systems Manager tools, including Patch Manager patch compliance and State Manager association compliance details. To further simplify how you access OpsData, Explorer displays information from supporting AWS services like AWS Config, AWS Trusted Advisor, AWS Compute Optimizer, and AWS Support (support cases). To raise operational awareness, Explorer also displays operational work items (OpsItems). Explorer provides context about how OpsItems are distributed across your business units or applications, how they trend over time, and how they vary by category. You can group and filter information in Explorer to focus on items that are relevant to you and that require action. When you identify high priority issues, you can use Systems Manager OpsCenter to run Automation runbooks and quickly resolve those issues. To get started with Explorer, open the Systems Manager console. In the navigation pane, choose Explorer. The following image shows some of the individual report boxes, called widgets, which are available in Explorer. Explorer 2143 AWS Systems Manager User Guide What are the features of Explorer? Explorer includes the following features: •
|
systems-manager-ug-617
|
systems-manager-ug.pdf
| 617 |
and how they vary by category. You can group and filter information in Explorer to focus on items that are relevant to you and that require action. When you identify high priority issues, you can use Systems Manager OpsCenter to run Automation runbooks and quickly resolve those issues. To get started with Explorer, open the Systems Manager console. In the navigation pane, choose Explorer. The following image shows some of the individual report boxes, called widgets, which are available in Explorer. Explorer 2143 AWS Systems Manager User Guide What are the features of Explorer? Explorer includes the following features: • Customizable display of actionable information: Explorer includes drag-and-drop widgets that automatically display actionable information about your AWS resources. Explorer displays information in two types of widgets. • Informational widgets: These widgets summarize data from Amazon EC2, Patch Manager, State Manager, and supporting AWS services like AWS Trusted Advisor, AWS Compute Optimizer, and Support. These widgets provide important context to help you understand the state and operational risks of your AWS resources. Examples of informational widgets include Instance count, Instance by AMI, Total noncompliant nodes (patching), Noncompliant associations, and Support Center cases. • OpsItem widgets: A Systems Manager OpsItem is an operational work item that is related to one or more AWS resources. OpsItems are a feature of Systems Manager OpsCenter. OpsItems Explorer 2144 AWS Systems Manager User Guide might require DevOps engineers to investigate and potentially remediate an issue. Examples of possible OpsItems include high EC2 instance CPU utilization, detached Amazon Elastic Block Store (Amazon EBS) volumes, AWS CodeDeploy deployment failure, or Systems Manager Automation execution failure. Examples of OpsItem widgets include Open OpsItem summary, OpsItem by status, and OpsItems over time. • Filters: Each widget offers the ability to filter information based on AWS account, AWS Region, and tag. Filters help you quickly refine the information displayed in Explorer. • Direct links to service screens: To help you investigate issues with AWS resources, Explorer widgets contain direct links to related service screens. Filters applied to a widget remain in effect if you navigate to a related service screen. • Groups: To help you understand the types of operational issues across your organization, some widgets allow you to group data based on account, Region, and tag. • Reporting tag keys: When you set up Explorer, you can specify up to five tag keys. These keys help you group and filter data in Explorer. If a specified key matches a key on a resource that generates an OpsItem, then the key and value are included in the OpsItems. • Three modes of AWS account and AWS Region display: Explorer includes the following display modes for OpsData and OpsItems in AWS accounts and AWS Regions: • Single-account/single-Region: This is the default view. This mode allows users to view data and OpsItems from their own account and the current Region. • Single-account/multiple-Region: This mode requires you to create one or more resource data syncs by using the Explorer Settings page. A resource data sync aggregates OpsData from one or more Regions. After you create a resource data sync, you can toggle which sync to use on the Explorer dashboard. You can then filter and group data based on Region. • Multiple-account/multiple-Region: This mode requires that your organization or company use AWS Organizations with All features turned on. After you configure AWS Organizations in your computing environment, you can aggregate all account data in a management account. You can then create resource data syncs so that you can filter and group data based on Region. For more information about Organizations All features mode, see Enabling All Features in Your Organization. • Reporting: You can export Explorer reports as comma separated value (.csv) files to an Amazon Simple Storage Service (Amazon S3) bucket. You receive an alert from Amazon Simple Notification Service (Amazon SNS) when an export is complete. Explorer 2145 AWS Systems Manager User Guide How does Explorer relate to OpsCenter? Systems Manager OpsCenter provides a central location where operations engineers and IT professionals view, investigate, and resolve OpsItems related to AWS resources. Explorer is a report hub where DevOps managers view aggregated summaries of their operations data, including OpsItems, across AWS Regions and accounts. Explorer helps users discover trends and patterns and, if necessary, quickly resolve issues using Systems Manager Automation runbooks. OpsCenter setup is now integrated with Explorer Setup. If you already set up OpsCenter, then Explorer automatically displays operations data, including aggregated information about OpsItems. If you haven't set up OpsCenter, then you can use Explorer Setup to get started with both tool. For more information, see Getting started with Systems Manager Explorer and OpsCenter. What is OpsData? OpsData is any operations data that is displayed in the Systems Manager Explorer dashboard. Explorer retrieves OpsData from the following sources: • Amazon
|
systems-manager-ug-618
|
systems-manager-ug.pdf
| 618 |
accounts. Explorer helps users discover trends and patterns and, if necessary, quickly resolve issues using Systems Manager Automation runbooks. OpsCenter setup is now integrated with Explorer Setup. If you already set up OpsCenter, then Explorer automatically displays operations data, including aggregated information about OpsItems. If you haven't set up OpsCenter, then you can use Explorer Setup to get started with both tool. For more information, see Getting started with Systems Manager Explorer and OpsCenter. What is OpsData? OpsData is any operations data that is displayed in the Systems Manager Explorer dashboard. Explorer retrieves OpsData from the following sources: • Amazon Elastic Compute Cloud (Amazon EC2) Data displayed in Explorer includes: total number of nodes, total number of managed and unmanaged nodes, and a count of nodes using a specific Amazon Machine Image (AMI). • Systems Manager OpsCenter Data displayed in Explorer includes: a count of OpsItems by status, a count of OpsItems by severity, a count of open OpsItems across groups and across 30-day time periods, and historical data of OpsItems over time. • Systems Manager Patch Manager Data displayed in Explorer includes a count of noncompliant and critical noncompliant nodes. • AWS Trusted Advisor Data displayed in Explorer includes: status of best practice checks for EC2 Reserved Instances in the areas of cost optimization, security, fault tolerance, performance, and service limits. • AWS Compute Optimizer Explorer 2146 AWS Systems Manager User Guide Data displayed in Explorer includes: a count of Under provisioned and Over provisioned EC2 instances, optimization findings, on-demand pricing details, and recommendations for instance type and price. • Support Center cases Data displayed in Explorer includes: case ID, severity, status, created time, subject, service, and category. • AWS Config Data displayed in Explorer includes: overall summary of compliant and non-compliant AWS Config rules, the number of compliant and non-compliant resources, and specific details about each (when you drill down into a non-compliant rule or resource). • AWS Security Hub Data displayed in Explorer includes: overall summary of Security Hub findings, the number of each finding grouped by severity, and specific details about finding. Note To view AWS Trusted Advisor and Support Center cases in Explorer, you must have either an Enterprise or Business account set up with AWS Support. You can view and manage OpsData sources from the Explorer Settings page. For information about setting up and configuring services that populate Explorer widgets with OpsData, see Setting up related services for Explorer. Is there a charge to use Explorer? Yes. When you turn on the default rules for creating OpsItems during Integrated Setup, you initiate a process that automatically creates OpsItems. Your account is charged based on the number of OpsItems created per month. Your account is also charged based on the number of GetOpsItem, DescribeOpsItem, UpdateOpsItem, and GetOpsSummary API calls made per month. Additionally, you can be charged for public API calls to other services that expose relevant diagnostic information. For more information, see AWS Systems Manager Pricing. Topics Explorer 2147 AWS Systems Manager User Guide • Getting started with Systems Manager Explorer and OpsCenter • Using Explorer • Exporting OpsData from Systems Manager Explorer • Troubleshooting Systems Manager Explorer Getting started with Systems Manager Explorer and OpsCenter AWS Systems Manager uses an integrated setup experience to help you get started with Systems Manager Explorer and Systems Manager OpsCenter. In this documentation, Explorer and OpsCenter Setup is called Integrated Setup. If you already set up OpsCenter, you still need to complete Integrated Setup to verify settings and options. If you haven't set up OpsCenter, then you can use Integrated Setup to get started with both tools. Note Integrated Setup is only available in the Systems Manager console. You can't set up Explorer or OpsCenter programmatically. Integrated Setup performs the following tasks: • Configures roles and permissions: Integrated Setup creates an AWS Identity and Access Management (IAM) role that allows Amazon EventBridge to automatically create OpsItems based on default rules. After setting up, you must configure user, group, or role permissions for OpsCenter, as described in this section. • Allows default rules for OpsItem creation: Integrated Setup creates default rules in EventBridge. These rules automatically create OpsItems in response to events. Examples of these events are: state change for an AWS resource, a change in security settings, or a service becoming unavailable. • Activates OpsData sources: Integrated Setup activates the following data sources that populate Explorer widgets. • Support Center (You must have either a Business or Enterprise Support plan to activate this source.) • AWS Compute Optimizer (You must have either a Business or Enterprise Support plan to activate this source.) • Systems Manager State Manager association compliance Explorer 2148 AWS Systems Manager User Guide • AWS Config Compliance • Systems Manager OpsCenter • Systems Manager Patch Manager patch compliance • Amazon Elastic Compute Cloud (Amazon
|
systems-manager-ug-619
|
systems-manager-ug.pdf
| 619 |
change for an AWS resource, a change in security settings, or a service becoming unavailable. • Activates OpsData sources: Integrated Setup activates the following data sources that populate Explorer widgets. • Support Center (You must have either a Business or Enterprise Support plan to activate this source.) • AWS Compute Optimizer (You must have either a Business or Enterprise Support plan to activate this source.) • Systems Manager State Manager association compliance Explorer 2148 AWS Systems Manager User Guide • AWS Config Compliance • Systems Manager OpsCenter • Systems Manager Patch Manager patch compliance • Amazon Elastic Compute Cloud (Amazon EC2) • Systems Manager Inventory • AWS Trusted Advisor (You must have either a Business or Enterprise Support plan to activate this source.) • AWS Security Hub Note You can change setup configurations at any time on the Settings page. After you complete Integrated Setup, we recommend that you Set up Explorer to display data from multiple Regions and accounts. Explorer and OpsCenter automatically synchronize OpsData and OpsItems for the AWS account and AWS Region you used when you completed Integrated Setup. You can aggregate OpsData and OpsItems from other accounts and Regions by creating a resource data sync. Setting up related services for Explorer AWS Systems Manager Explorer and AWS Systems Manager OpsCenter collect information from, or interact with, other AWS services and Systems Manager tools. We recommend that you set up and configure these other services or tools before you use Integrated Setup. The following table includes tasks that allow Explorer and OpsCenter to collect information from, or interact with, other AWS services and Systems Manager tools. Task Information Verify permissions in Systems Manager Automation Explorer and OpsCenter allow you to remediate issues with AWS resources by using Systems Manager Automation runbooks. To use this remediation tool, you must have permission to run Systems Manager Explorer 2149 AWS Systems Manager Task User Guide Information Automation runbooks. For more information, see Setting up Automation. Set up and configure Systems Manager Patch Manager Explorer includes a widget that provides information about patch compliance. To view this data in Explorer, you must configure patching. For more information, see AWS Systems Manager Patch Manager. Set up and configure Systems Manager State Manager Explorer includes a widget that provides information about Systems Manager State Turn on AWS Config Configuration Recorder Manager association compliance. To view this data in Explorer, you must configure State Manager. For more information, see AWS Systems Manager State Manager. Explorer uses data provided by AWS Config configuration recorder to populate widgets with information about your EC2 instances. To view this data in Explorer, turn on AWS Config configuration recorder. For more information, see Managing the Configuration Recorder. Note After you allow configuration recorder, Systems Manager can take up to six hours to display data in Explorer widgets that display information about your EC2 instances. Explorer 2150 AWS Systems Manager Task Turn on AWS Trusted Advisor Turn on AWS Compute Optimizer Turn on AWS Security Hub User Guide Information Explorer uses data provided by Trusted Advisor to display a status of best practice checks for Amazon EC2 Reserved Instances in the areas of cost optimization, security, fault tolerance , performance, and service limits. To view this data in Explorer, you must have a business or enterprise support plan. For more information, see Support. Explorer uses data provided by Compute Optimizer to display details a count of Under provisioned and Over provisioned EC2 instances, optimization findings, on-demand pricing details, and recommendations for instance type and price. To view this data in Explorer, turn on Compute Optimizer. For more information, see Getting started with AWS Compute Optimizer. Explorer uses data provided by Security Hub to populate widgets with information about your security findings. To view this data in Explorer, turn on Security Hub integration. For more information, see What is AWS Security Hub. Configuring roles and permissions for Systems Manager Explorer Integrated Setup automatically creates and configures AWS Identity and Access Management (IAM) roles for AWS Systems Manager Explorer and AWS Systems Manager OpsCenter. If you completed Integrated Setup, then you don't need to perform any additional tasks to configure roles and permissions for Explorer. However, you must configure permission for OpsCenter, as described later in this topic. Integrated Setup creates and configures the following roles for working with Explorer and OpsCenter. Explorer 2151 AWS Systems Manager User Guide • AWSServiceRoleForAmazonSSM: Provides access to AWS resources managed or used by Systems Manager. • OpsItem-CWE-Role: Allows CloudWatch Events and EventBridge to create OpsItems in response to common events. • AWSServiceRoleForAmazonSSM_AccountDiscovery: Allows Systems Manager to call other AWS services to discover AWS account information when synchronizing data. For more information about this role, see Using roles to collect AWS account information for OpsCenter and Explorer. • AmazonSSMExplorerExport: Allows Explorer to export OpsData to a
|
systems-manager-ug-620
|
systems-manager-ug.pdf
| 620 |
as described later in this topic. Integrated Setup creates and configures the following roles for working with Explorer and OpsCenter. Explorer 2151 AWS Systems Manager User Guide • AWSServiceRoleForAmazonSSM: Provides access to AWS resources managed or used by Systems Manager. • OpsItem-CWE-Role: Allows CloudWatch Events and EventBridge to create OpsItems in response to common events. • AWSServiceRoleForAmazonSSM_AccountDiscovery: Allows Systems Manager to call other AWS services to discover AWS account information when synchronizing data. For more information about this role, see Using roles to collect AWS account information for OpsCenter and Explorer. • AmazonSSMExplorerExport: Allows Explorer to export OpsData to a comma-separated value (CSV) file. If you configure Explorer to display data from multiple accounts and Regions by using AWS Organizations and a resource data sync, then Systems Manager creates the AWSServiceRoleForAmazonSSM_AccountDiscovery service-linked role. Systems Manager uses this role to get information about your AWS accounts in AWS Organizations. The role uses the following permissions policy. { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "organizations:DescribeAccount", "organizations:DescribeOrganization", "organizations:ListAccounts", "organizations:ListAWSServiceAccessForOrganization", "organizations:ListChildren", "organizations:ListParents" ], "Resource":"*" } ] } For more information about the AWSServiceRoleForAmazonSSM_AccountDiscovery role, see Using roles to collect AWS account information for OpsCenter and Explorer. Explorer 2152 AWS Systems Manager User Guide Configuring permissions for Systems Manager OpsCenter After you complete Integrated Setup, you must configure user, group, or role permissions so that users can perform actions in OpsCenter. Before you begin You can configure OpsCenter to create and manage OpsItems for a single account or across multiple accounts. If you configure OpsCenter to create and manage OpsItems across multiple accounts, you can use either the Systems Manager delegated administrator account or the AWS Organizations management account to manually create, view, or edit OpsItems in other accounts. For more information about the Systems Manager delegated administrator account, see Configuring a delegated administrator for Explorer. If you configure OpsCenter for a single account, you can only view or edit OpsItems in the account where OpsItems were created. You can't share or transfer OpsItems across AWS accounts. For this reason, we recommend that you configure permissions for OpsCenter in the AWS account that is used to run your AWS workloads. You can then create users or groups in that account. In this way, multiple operations engineers or IT professionals can create, view, and edit OpsItems in the same AWS account. Explorer and OpsCenter use the following API operations. You can use all features of Explorer and OpsCenter if your user, group, or role has access to these actions. You can also create more restrictive access, as described later in this section. • CreateOpsItem • CreateResourceDataSync • DescribeOpsItems • DeleteResourceDataSync • GetOpsItem • GetOpsSummary • ListResourceDataSync • UpdateOpsItem • UpdateResourceDataSync If you prefer, you can specify read-only permission by adding the following inline policy to your account, group, or role. Explorer 2153 AWS Systems Manager User Guide { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:GetOpsItem", "ssm:GetOpsSummary", "ssm:DescribeOpsItems", "ssm:GetServiceSetting", "ssm:ListResourceDataSync" ], "Resource": "*" } ] } For more information about creating and editing IAM policies, see Creating IAM Policies in the IAM User Guide. For information about how to assign this policy to an IAM group, see Attaching a Policy to an IAM Group. Create a permission using the following and add it to your users, groups, or roles: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:GetOpsItem", "ssm:UpdateOpsItem", "ssm:DescribeOpsItems", "ssm:CreateOpsItem", "ssm:CreateResourceDataSync", "ssm:DeleteResourceDataSync", "ssm:ListResourceDataSync", "ssm:UpdateResourceDataSync" ], "Resource": "*" } ] Explorer 2154 AWS Systems Manager } User Guide Depending on the identity application that you are using in your organization, you can select any of the following options to configure user access. To provide access, add permissions to your users, groups, or roles: • Users and groups in AWS IAM Identity Center: Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. • IAM users: • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. • (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. Restricting access to OpsItems by using tags You can also restrict access to OpsItems by using an inline IAM policy that specifies tags. Here is an example that specifies a tag key of Department and a tag value of Finance. With this policy, the user can only call the GetOpsItem API operation to view OpsItems that were previously tagged with Key=Department and Value=Finance. Users can't view any
|
systems-manager-ug-621
|
systems-manager-ug.pdf
| 621 |
• (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. Restricting access to OpsItems by using tags You can also restrict access to OpsItems by using an inline IAM policy that specifies tags. Here is an example that specifies a tag key of Department and a tag value of Finance. With this policy, the user can only call the GetOpsItem API operation to view OpsItems that were previously tagged with Key=Department and Value=Finance. Users can't view any other OpsItems. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:GetOpsItem" ], "Resource": "*" , "Condition": { "StringEquals": { "ssm:resourceTag/Department": "Finance" } } Explorer 2155 AWS Systems Manager } ] } User Guide Here is an example that specifies API operations for viewing and updating OpsItems. This policy also specifies two sets of tag key-value pairs: Department-Finance and Project-Unity. { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "ssm:GetOpsItem", "ssm:UpdateOpsItem" ], "Resource":"*", "Condition":{ "StringEquals":{ "ssm:resourceTag/Department":"Finance", "ssm:resourceTag/Project":"Unity" } } } ] } For information about adding tags to an OpsItem, see Create OpsItems manually. Understanding default EventBridge rules created by Integrated Setup During the integrated setup process for Explorer and OpsCenter, you can choose to enable a number of default rules that are based on events detected by Amazon EventBridge. When these events are detected, the system automatically creates OpsItems in AWS Systems Manager OpsCenter. For example, the rule SSMOpsItems-Autoscaling-instance-termination-failure results in an OpsItem being created when the termination of an EC2 auto scaling instance fails. The rule SSMOpsItems-SSM-maintenance-window-execution-failed results in an OpsItem being created when a Systems Manager maintenace window fails to complete successfully. Explorer 2156 AWS Systems Manager User Guide For setup instructions and descriptions of all the EventBridge rules you can enable during the setup process, see Set up OpsCenter. If you don't want EventBridge to create OpsItems for these events, you can choose not to enable this option in Integrated Setup. If you prefer, you can specify OpsCenter as the target of specific EventBridge events. For more information, see Configure EventBridge rules to create OpsItems. You can disable a default rule or change its category and severity level in the OpsCenter Settings page by choosing OpsCenter, Settings, and then choosing Edit in the OpsItem rules area. You can also edit the category or severity assigned to an individual OpsItem created from these rules in the Systems Manager console. For information, see Editing an OpsItem. Configuring a delegated administrator for Explorer If you aggregate AWS Systems Manager Explorer data from multiple AWS Regions and accounts by using resource data sync with AWS Organizations, then we recommend that you configure a delegated administrator for Explorer. Explorer 2157 AWS Systems Manager User Guide A delegated administrator can use the following Explorer resource data sync APIs using the console, SDK, AWS Command Line Interface (AWS CLI), or AWS Tools for Windows PowerShell: • CreateResourceDataSync • DeleteResourceDataSync • ListResourceDataSync • UpdateResourceDataSync A delegated administrator can create a maximum of five resource data syncs for either an entire organization or a subset of organizational units. Resource data syncs created by a delegated administrator are only available in the delegated administrator account. You can't view the syncs or the aggregated data in the AWS Organizations management account. For more information about resource data sync, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions. For more information about AWS Organizations, see What is AWS Organizations? in the AWS Organizations User Guide. Topics • Configure an Explorer delegated administrator • Deregister an Explorer delegated administrator Configure an Explorer delegated administrator Use the following procedure to register an Explorer delegated administrator. To register an Explorer delegated administrator 1. Log into your AWS Organizations management account. 2. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 3. In the navigation pane, choose Explorer. 4. Choose Settings. 5. In the Delegated administrator for Explorer section, verify that you have configured the required service-linked role and service access options. If necessary, choose the Create role and Enable access buttons to configure these options. Explorer 2158 AWS Systems Manager User Guide 6. For Account ID, enter the AWS account ID. This account must be a member account in AWS Organizations. 7. Choose Register delegated administrator. The delegated administrator now has access to the Include all accounts from my AWS Organizations configuration and Select organization units in AWS Organizations options on the Create resource data sync page. Deregister an Explorer delegated administrator Use the following procedure to deregister an Explorer delegated administrator. A delegated administrator account can only be deregistered by the AWS Organizations management account. When a delegated administrator account is deregistered, the system deletes all AWS Organizations resource data syncs created by the delegated administrator. To
|
systems-manager-ug-622
|
systems-manager-ug.pdf
| 622 |
AWS account ID. This account must be a member account in AWS Organizations. 7. Choose Register delegated administrator. The delegated administrator now has access to the Include all accounts from my AWS Organizations configuration and Select organization units in AWS Organizations options on the Create resource data sync page. Deregister an Explorer delegated administrator Use the following procedure to deregister an Explorer delegated administrator. A delegated administrator account can only be deregistered by the AWS Organizations management account. When a delegated administrator account is deregistered, the system deletes all AWS Organizations resource data syncs created by the delegated administrator. To deregister an Explorer delegated administrator 1. Log into your AWS Organizations management account. 2. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 3. In the navigation pane, choose Explorer. 4. Choose Settings. 5. In the Delegated administrator for Explorer section, choose Deregister. The system displays a warning. 6. Enter the account ID and choose Remove. The account no longer has access to the AWS Organizations resource data sync API operations. The system deletes all AWS Organizations resource data syncs created by the account. Setting up Systems Manager Explorer to display data from multiple accounts and Regions AWS Systems Manager uses an integrated setup experience to help you get started with AWS Systems Manager Explorer and AWS Systems Manager OpsCenter. After completing Integrated Setup, Explorer and OpsCenter automatically synchronize data. More specifically, these tools synchronize OpsData and OpsItems for the AWS account and AWS Region you used when you completed Integrated Setup. If you want to aggregate OpsData and OpsItems from other accounts and Regions, you must create a resource data sync, as described in this topic. Explorer 2159 AWS Systems Manager Note User Guide For more information about Integrated Setup, see Getting started with Systems Manager Explorer and OpsCenter. Topics • Understanding resource data syncs for Explorer • Understanding multiple account and Region resource data syncs • Creating a resource data sync Understanding resource data syncs for Explorer Resource data sync for Explorer offers two aggregation options: • Single-account/Multiple-regions: You can configure Explorer to aggregate OpsItems and OpsData data from multiple AWS Regions, but the data set is limited to the current AWS account. • Multiple-accounts/Multiple-regions: You can configure Explorer to aggregate data from multiple AWS Regions and accounts. This option requires that you set up and configure AWS Organizations. After you set up and configure AWS Organizations, you can aggregate data in Explorer by organizational unit (OU) or for an entire organization. Systems Manager aggregates the data into the AWS Organizations management account before displaying it in Explorer. For more information, see What is AWS Organizations? in the AWS Organizations User Guide. Warning If you configure Explorer to aggregate data from an organization in AWS Organizations, the system enables OpsData in all member accounts in the organization. Enabling OpsData sources in all member accounts increases the number of calls to OpsCenter APIs like CreateOpsItem and GetOpsSummary. You are charged for calls to these API actions. The following diagram shows a resource data sync configured to work with AWS Organizations. In this scenario, the user has two accounts defined in AWS Organizations. Resource data sync aggregates data from both accounts and multiple AWS Regions into the AWS Organizations management account where it's then displayed in Explorer. Explorer 2160 AWS Systems Manager User Guide Understanding multiple account and Region resource data syncs This section describes important details about multiple account and multiple Region resource data syncs that use AWS Organizations. Specifically, the information in this section applies if you choose one of the following options in the Create resource data sync page: • Include all accounts from my AWS Organizations configuration • Select organization units in AWS Organizations If you don't plan to use one of these options, you can skip this section. When you create a resource data sync in the SSM console, if you choose one of the AWS Organizations options, then Systems Manager automatically allows all OpsData sources in the selected Regions for all AWS accounts in your organization (or in the selected organizational Explorer 2161 AWS Systems Manager User Guide units). For example, even if you haven't turned Explorer on in a Region, if you select an AWS Organizations option for your resource data sync, then Systems Manager automatically collects OpsData from that Region. To create a resource data sync without allowing OpsData sources, specify EnableAllOpsDataSources as false when creating the data sync. For more information, see the EnableAllOpsDataSources parameter details for the ResourceDataSyncSource data type in the Amazon EC2 Systems Manager API Reference. If you don't choose one of the AWS Organizations options for a resource data sync, then you must complete Integrated Setup in each account and Region where you want Explorer to access data. If you don't, Explorer won't display OpsData and OpsItems
|
systems-manager-ug-623
|
systems-manager-ug.pdf
| 623 |
an AWS Organizations option for your resource data sync, then Systems Manager automatically collects OpsData from that Region. To create a resource data sync without allowing OpsData sources, specify EnableAllOpsDataSources as false when creating the data sync. For more information, see the EnableAllOpsDataSources parameter details for the ResourceDataSyncSource data type in the Amazon EC2 Systems Manager API Reference. If you don't choose one of the AWS Organizations options for a resource data sync, then you must complete Integrated Setup in each account and Region where you want Explorer to access data. If you don't, Explorer won't display OpsData and OpsItems for those accounts and Regions in which you didn't complete Integrated Setup. If you add a child account to your organization, Explorer automatically allows all OpsData sources for the account. If, at a later time, you remove the child account from your organization, Explorer continues to collect OpsData from the account. If you update an existing resource data sync that uses one of the AWS Organizations options, the system prompts you to approve collection of all OpsData sources for all accounts and Regions affected by the change. If you add a new service to your AWS account, and if Explorer collects OpsData for that service, Systems Manager automatically configures Explorer to collect that OpsData. For example, if your organization didn't use AWS Trusted Advisor when you previously created a resource data sync, but your organization signs up for this service, Explorer automatically updates your resource data syncs to collect this OpsData. Important Note the following important information about multiple account and Region resource data syncs: • Deleting a resource data sync doesn't turn off an OpsData source in Explorer. • To view OpsData and OpsItems from multiple accounts, you must have the AWS Organizations All features mode turned on and you must be signed into the AWS Organizations management account. Creating a resource data sync Before you configure a resource data sync for Explorer, note the following details. Explorer 2162 AWS Systems Manager User Guide • Explorer supports a maximum of five resource data syncs. • After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one. • OpsData viewed in Explorer is read-only. Use the following procedure to create a resource data sync for Explorer. To create a resource data sync 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose Settings. 4. 5. 6. In the Configure resource data sync section, choose Create resource data sync. For Resource data sync name, enter a name. In the Add accounts section, choose an option. Note To use either of the AWS Organizations options, you must be logged into the AWS Organizations management account or you must be logged into an Explorer delegated administrator account. For more information about the delegated administrator account, see Configuring a delegated administrator for Explorer. 7. In the Regions to include section, choose one of the following options. • Choose All current and future regions to automatically sync data from all current AWS Regions and any new Regions that come online in the future. • Choose All regions to automatically sync data from all current AWS Regions. • Individually choose Regions that you want to include. 8. Choose Create resource data sync. Explorer 2163 AWS Systems Manager User Guide The system can take several minutes to populate Explorer with data after you create a resource data sync. You can view the sync by choosing it from the Select a resource data sync list in Explorer. Using Explorer This section includes information about how to customize AWS Systems Manager Explorer by changing the widget layout and by changing the data that displays in the dashboard. Contents • Editing EventBridge rules created for Explorer • Editing Systems Manager Explorer data sources • Customizing the Explorer display • Receiving findings from AWS Security Hub in Explorer • Deleting a Systems Manager Explorer resource data sync Editing EventBridge rules created for Explorer When you complete Integrated Setup, the system allows more than a dozen rules in Amazon EventBridge. These rules automatically create OpsItems in AWS Systems Manager OpsCenter. AWS Systems Manager Explorer then displays aggregated information about the OpsItems. Each rule includes a preset Category and Severity value. When the system creates OpsItems from an event, it automatically assigns the preset Category and Severity. Important You can't edit the Category and Severity values for default rules but you can
|
systems-manager-ug-624
|
systems-manager-ug.pdf
| 624 |
Receiving findings from AWS Security Hub in Explorer • Deleting a Systems Manager Explorer resource data sync Editing EventBridge rules created for Explorer When you complete Integrated Setup, the system allows more than a dozen rules in Amazon EventBridge. These rules automatically create OpsItems in AWS Systems Manager OpsCenter. AWS Systems Manager Explorer then displays aggregated information about the OpsItems. Each rule includes a preset Category and Severity value. When the system creates OpsItems from an event, it automatically assigns the preset Category and Severity. Important You can't edit the Category and Severity values for default rules but you can edit these values on OpsItems created from the default rules. Explorer 2164 AWS Systems Manager User Guide To edit default rules for creating OpsItems 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose Settings. 4. 5. In the OpsItems rules section, choose Edit. Expand CWE rules. 6. Clear the check box beside those rules that you don't want to use. 7. Use the Category and Severity lists to change this information for a rule. 8. Choose Save. Your changes take effect the next time the system creates an OpsItem. Explorer 2165 AWS Systems Manager User Guide Editing Systems Manager Explorer data sources AWS Systems Manager Explorer displays data from the following sources. You can edit Explorer settings to add or remove data sources: • Amazon Elastic Compute Cloud (Amazon EC2) • AWS Systems Manager OpsCenter • AWS Systems Manager Patch Manager patch compliance • AWS Systems Manager State Manager association compliance • AWS Trusted Advisor • AWS Compute Optimizer • AWS Support Center cases • AWS Config rule and resource compliance • AWS Security Hub findings Note • To view Support Center cases in Explorer, you must have either an Enterprise or Business account set up with Support. • You can't configure Explorer to stop displaying OpsCenter OpsItem data. Before you begin Verify that you set up and configured services that populate Explorer widgets with data. For more information, see Setting up related services for Explorer. To edit data sources 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose Settings, and then choose the Configure Dashboard tab. 4. In the OpsData sources section, in the Status column, turn on or turn off sources according to the data you want to view. Explorer 2166 AWS Systems Manager Customizing the Explorer display User Guide You can customize widget layout in AWS Systems Manager Explorer by using a drag-and-drop capability. You can also customize the OpsData and OpsItems displayed in Explorer by using filters, as described in this topic. Before you customize widget layout, verify that the widgets you want to view are currently displayed in Explorer. To view some widgets in Explorer (such as the AWS Config compliance widget), you must enable them on the Configure dashboard page. To enable widgets to display in Explorer 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose Dashboard actions, Configure dashboard. 4. Choose the Configure Dashboard tab. 5. Either choose Enable all or turn on an individual widget or data source. 6. Choose Explorer to view your changes. To customize widget layout in Explorer, choose a widget that you want to move. Click and hold the name of the widget and then drag it to its new location. Repeat this process for each widget that you want to reposition. Explorer 2167 AWS Systems Manager User Guide If you decide that you don't like the new layout, choose Reset layout to move all widgets back to their original location. Using filters to the change the data displayed in Explorer By default, Explorer displays data for the current AWS account and the current Region. If you create one or more resource data syncs, you can use filters to change which sync is active. You can then choose to display data for a specific Region or all Regions. You can also use the Search bar to filter on different OpsItem and key-tag criteria. To change the data displayed in Explorer by using filters 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. In the navigation pane, choose Explorer. In the Filter section, use the Select a resource data sync list to choose a sync. 2. 3. 4. Use the Regions list to choose either a specific AWS Region or choose All Regions. 5. Choose the Search bar, and then choose the criteria on which to filter the data. 6. Press Enter. Explorer retains the filter options you selected if you close and reopen the page. Explorer 2168 AWS Systems Manager User Guide Receiving findings from AWS Security Hub in Explorer AWS Security Hub provides a comprehensive view
|
systems-manager-ug-625
|
systems-manager-ug.pdf
| 625 |
Manager console at https://console.aws.amazon.com/systems- manager/. In the navigation pane, choose Explorer. In the Filter section, use the Select a resource data sync list to choose a sync. 2. 3. 4. Use the Regions list to choose either a specific AWS Region or choose All Regions. 5. Choose the Search bar, and then choose the criteria on which to filter the data. 6. Press Enter. Explorer retains the filter options you selected if you close and reopen the page. Explorer 2168 AWS Systems Manager User Guide Receiving findings from AWS Security Hub in Explorer AWS Security Hub provides a comprehensive view of your security state in AWS. The service collects security data, called findings, from across AWS accounts, services, and supported third-party products. Security Hub findings can help you check your environment against security industry standards and best practices, analyze your security trends, and identify the highest priority security issues. Security Hub sends findings to Amazon EventBridge, which uses an event rule to send the findings to Explorer. After you enable integration, as described here, you can view Security Hub findings in an Explorer widget and view finding details in OpsCenter OpsItems. The widget provides a summary of all Security Hub findings based on severity. New findings in Security Hub are usually visible in Explorer within seconds of being created. Warning Note the following important information: • Explorer is integrated with OpsCenter, a tool in Systems Manager. After you enable Explorer integration with Security Hub, OpsCenter automatically creates OpsItems for Security Hub findings. Depending on your AWS environment, enabling integration can result in large numbers of OpsItems, at a cost. Before you continue, read about OpsCenter integration with Security Hub. The topic includes specific details about how changes and updates to findings and OpsItems are charged to your account. For more information, see Understanding OpsCenter integration with AWS Security Hub. For OpsCenter pricing information, see AWS Systems Manager Pricing. • If you create a resource data sync in Explorer while logged into the administrator account, Security Hub integration is automatically enabled for the administrator and all member accounts in the sync. Once enabled, OpsCenter automatically creates OpsItems for Security Hub findings, at a cost. For more information about creating a resource data sync, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions. Explorer 2169 AWS Systems Manager User Guide Types of findings that Explorer receives Explorer receives all findings from Security Hub. You can see all findings based on severity in the Explorer widget when you turn on the Security Hub default settings. By default, Explorer creates OpsItems for critical and high severity findings. You can manually configure Explorer to create OpsItems for medium and low severity findings. Though Explorer doesn't create OpsItems for informational findings, you can view informational operations data (OpsData) in the Security Hub findings summary widget. Explorer creates OpsData for all findings regardless of severity. For more information about Security Hub severity levels, see Severity in the AWS Security Hub API Reference. Enabling integration This section describes how to enable and configure Explorer to start receiving Security Hub findings. Before you begin Complete the following tasks before you configure Explorer to start receiving Security Hub findings. • Enable and configure Security Hub. For more information, see Setting up Security Hub in the AWS Security Hub User Guide. • Log into the AWS Organizations management account. Systems Manager requires access to AWS Organizations to create OpsItems from Security Hub findings. After you log in to the management account, you're prompted to select the Enable access button on the Explorer Configure dashboard tab, as described in the following procedure. If you don't log in to the AWS Organizations management account, you can't allow access and Explorer can't create OpsItems from Security Hub findings. To start receiving Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. 3. 4. In the navigation pane, choose Explorer. Select Settings. Select the Configure dashboard tab. Explorer 2170 AWS Systems Manager User Guide 5. 6. Select AWS Security Hub. Select the Disabled slider to turn on AWS Security Hub. Critical and high severity findings are displayed by default. To display medium and low severity findings, select the Disabled slider next to Medium,Low. 7. In the OpsItems created by Security Hub findings section, choose Enable access. If you don't see this button, log in to the AWS Organizations management account and return to this page to select the button. How to view findings from Security Hub The following procedure describes how to view Security Hub findings. To view Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- 2. 3. manager/. In the navigation pane, choose Explorer. Find the AWS Security Hub findings summary widget. This displays your Security Hub findings. You can select
|
systems-manager-ug-626
|
systems-manager-ug.pdf
| 626 |
select the Disabled slider next to Medium,Low. 7. In the OpsItems created by Security Hub findings section, choose Enable access. If you don't see this button, log in to the AWS Organizations management account and return to this page to select the button. How to view findings from Security Hub The following procedure describes how to view Security Hub findings. To view Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- 2. 3. manager/. In the navigation pane, choose Explorer. Find the AWS Security Hub findings summary widget. This displays your Security Hub findings. You can select a severity level to view a detailed description of the corresponding OpsItem. How to stop receiving findings The following procedure describes how to stop receiving Security Hub findings. To stop receiving Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. In the navigation pane, choose Explorer. Select Settings. Select the Configure dashboard tab. Select the Enabled slider to turn off AWS Security Hub. 2. 3. 4. 5. Explorer 2171 AWS Systems Manager Important User Guide If the option to disable Security Hub findings is grayed out in the console, you can disable this setting by running the following command in the AWS CLI. You must run the command while logged into either the AWS Organizations management account or the Systems Manager delegated administrator account. For the region parameter, specify the AWS Region where you want to stop receiving Security Hub findings in Explorer. aws ssm update-service-setting --setting-id /ssm/opsdata/SecurityHub --setting- value Disabled --region AWS Region Here's an example. aws ssm update-service-setting --setting-id /ssm/opsdata/SecurityHub --setting- value Disabled --region us-east-1 Deleting a Systems Manager Explorer resource data sync In AWS Systems Manager Explorer, you can aggregate OpsData and OpsItems from other accounts and Regions by creating a resource data sync. You can't change the account options for a resource data sync. For example, if you created a sync in the us-east-2 (Ohio) Region and you chose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the resource data sync, and create a new one, as described in the following procedure. To delete a resource data sync 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose Settings. 4. In the Configure resource data sync section, choose the resource data sync that you want to delete. Explorer 2172 AWS Systems Manager 5. Choose Delete. User Guide Exporting OpsData from Systems Manager Explorer You can export 5,000 OpsData items as a comma separated value (.csv) file to an Amazon Simple Storage Service (Amazon S3) bucket from AWS Systems Manager Explorer. Explorer uses the AWS- ExportOpsDataToS3 automation runbook to export OpsData. When you export OpsData, the system displays the automation runbook page where you can specify details, such as assumeRole, Amazon S3 bucket name, SNS topic ARN, and fields to be exported. To export OpsData: • Step 1: Specifying an SNS topic • Step 2: (Optional) Configuring data export • Step 3: Exporting OpsData Step 1: Specifying an SNS topic When you configure data export, you must specify an Amazon Simple Notification Service (Amazon SNS) topic that exists in the same AWS Region where you want to export the data. Systems Manager sends a notification to the Amazon SNS topic when an export is complete. For information about creating an Amazon SNS topic, see Creating an Amazon SNS topic. Step 2: (Optional) Configuring data export You can configure data export settings from the Settings or Export Ops Data to S3 Bucket page. To configure data export from Explorer 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose Settings. 4. 5. In the Configure data export section, choose Edit. To upload the data export file to an existing Amazon S3 bucket, choose Select an existing S3 bucket and choose the bucket from the list. Explorer 2173 AWS Systems Manager User Guide To upload the data export file to a new Amazon S3 bucket, choose Create a new S3 bucket and enter the name that you want to use for the new bucket. Note You can only edit the Amazon S3 bucket name and Amazon SNS topic ARN from the page where you configured those settings for the first time in Explorer. If you set up the Amazon S3 bucket and the Amazon SNS topic ARN from the Settings page, then you can only modify those settings from the Settings page. 6. For Select an Amazon SNS topic ARN, choose the topic that you want to notify when the export is complete. 7. Choose Create. Step 3: Exporting OpsData When you export Explorer data, Systems
|
systems-manager-ug-627
|
systems-manager-ug.pdf
| 627 |
you want to use for the new bucket. Note You can only edit the Amazon S3 bucket name and Amazon SNS topic ARN from the page where you configured those settings for the first time in Explorer. If you set up the Amazon S3 bucket and the Amazon SNS topic ARN from the Settings page, then you can only modify those settings from the Settings page. 6. For Select an Amazon SNS topic ARN, choose the topic that you want to notify when the export is complete. 7. Choose Create. Step 3: Exporting OpsData When you export Explorer data, Systems Manager creates an AWS Identity and Access Management (IAM) role named AmazonSSMExplorerExportRole. This role uses the following IAM policy. { "Version": "2012-10-17", "Statement": [ { "Sid": "OpsSummaryExportAutomationServiceRoleStatement1", "Effect": "Allow", "Action": [ "s3:PutObject" ], "Resource": [ "arn:aws:s3:::{{ExportDestinationS3BucketName}}/*" ] }, { "Sid": "OpsSummaryExportAutomationServiceRoleStatement2", "Effect": "Allow", "Action": [ "s3:GetBucketAcl", "s3:GetBucketLocation" ], "Resource": [ Explorer 2174 AWS Systems Manager User Guide "arn:aws:s3:::{{ExportDestinationS3BucketName}}" ] }, { "Sid": "OpsSummaryExportAutomationServiceRoleStatement3", "Effect": "Allow", "Action": [ "sns:Publish" ], "Resource": [ "{{SnsTopicArn}}" ] }, { "Sid": "OpsSummaryExportAutomationServiceRoleStatement4", "Effect": "Allow", "Action": [ "logs:DescribeLogGroups", "logs:DescribeLogStreams" ], "Resource": [ "*" ] }, { "Sid": "OpsSummaryExportAutomationServiceRoleStatement5", "Effect": "Allow", "Action": [ "logs:CreateLogGroup", "logs:PutLogEvents", "logs:CreateLogStream" ], "Resource": [ "*" ] }, { "Sid": "OpsSummaryExportAutomationServiceRoleStatement6", "Effect": "Allow", "Action": [ "ssm:GetOpsSummary" ], "Resource": [ "*" Explorer 2175 User Guide AWS Systems Manager ] } ] } The role includes the following trust entity. { "Version": "2012-10-17", "Statement": [ { "Sid": "OpsSummaryExportAutomationServiceRoleTrustPolicy", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } To export OpsData from Explorer 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Explorer. 3. Choose a data link in an Explorer widget. For example, choose Unresolved or Open issues in the OpsItems by status widget. Or choose the Critical or High data link in the OpsItem by severity widget. Explorer opens the OpsData page for the selected data set. 4. Choose Export Table. Note When you export OpsData for the first time, the system creates an assume role for the export. You can't modify the default assume role. 5. For S3 Bucket Name, choose an existing bucket. You can choose Create to create an Amazon S3 bucket if needed. Explorer 2176 AWS Systems Manager User Guide If you can't change the S3 bucket name, it means that you configured the bucket name from the Settings page. You can only change the bucket name from the Settings page. Note You can only edit the Amazon S3 bucket name and Amazon SNS topic ARN from the page where you configured those settings for the first time in Explorer. 6. For SNS Topic Arn, choose an existing Amazon SNS topic ARN to notify when the download completes. If you can't change the Amazon SNS topic ARN, it means that you configured the Amazon SNS topic ARN from the Settings page. You can only change the topic ARN from the Settings page. 7. (Optional) For SNS Success Message, specify a success message that you want to display when the export is successfully completed. 8. Choose Submit. The system navigates to the previous page and displays the message Click to view status of export process. View details. You can choose View details to view the status of the runbook and progress in Systems Manager Automation. You can now export OpsData from Explorer to the specified Amazon S3 bucket. If you can't export data by using this procedure, verify that your user, group, or role includes the iam:CreatePolicyVersion and iam:DeletePolicyVersion actions. For information about adding these actions to your user, group, or role, see Editing IAM policies in the IAM User Guide. Troubleshooting Systems Manager Explorer This topic includes information about how to troubleshoot common problems with AWS Systems Manager Explorer. Not able to filter AWS resources in Explorer after updating tags on the Settings page If you update tags keys or other data settings in Explorer, the system can take up to six hours to synchronize data based on your changes. The AWS Organizations options on the Create resource data sync page are greyed out Explorer 2177 AWS Systems Manager User Guide The Include all accounts from my AWS Organizations configuration and Select organization units in AWS Organizations options on the Create resource data sync page are only available if you set up and configured AWS Organizations. If you set up and configured AWS Organizations, then either the AWS Organizations management account or an Explorer delegated administrator can create resource data syncs that use these options. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions and Configuring a delegated administrator for Explorer. Explorer doesn't display any data at all • Verify that you completed Integrated Setup in each account and Region where you
|
systems-manager-ug-628
|
systems-manager-ug.pdf
| 628 |
and Select organization units in AWS Organizations options on the Create resource data sync page are only available if you set up and configured AWS Organizations. If you set up and configured AWS Organizations, then either the AWS Organizations management account or an Explorer delegated administrator can create resource data syncs that use these options. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions and Configuring a delegated administrator for Explorer. Explorer doesn't display any data at all • Verify that you completed Integrated Setup in each account and Region where you want Explorer to access and display data. If you don't, Explorer won't display OpsData and OpsItems for those accounts and Regions in which you didn't complete Integrated Setup. For more information, see Getting started with Systems Manager Explorer and OpsCenter. • When using Explorer to view data from multiple accounts and Regions, verify that you're logged into the AWS Organizations management account or the Explorer delegated administrator account. To view OpsData and OpsItems from multiple accounts and Regions, you must be signed in to this account. Widgets about Amazon EC2 instances don't display data If widgets about Amazon Elastic Compute Cloud (Amazon EC2) instances, such as the Instance count, Managed instances, and Instance by AMI widgets don't display data, then verify the following: • Verify that you waited several minutes. OpsData can take several minutes to display in Explorer after you completed Integrated Setup. • Verify that you configured AWS Config configuration recorder. Explorer uses data provided by AWS Config configuration recorder to populate widgets with information about your EC2 instances. For more information, see Managing the Configuration Recorder. • Verify that the Amazon EC2 OpsData source is active on the Settings page. Also, verify that more than 6 hours have passed since you activated configuration recorder or since you made changes to your instances. Systems Manager can take up to six hours to display data from AWS Config in Explorer EC2 widgets after you initially activated configuration recorder or make changes to your instances. Explorer 2178 AWS Systems Manager User Guide • Be aware that if an instance is either stopped or terminated, then Explorer stops showing those instances after 24 hours. • Verify that you're in the correct AWS Region where you configured your Amazon EC2 instances. Explorer doesn't display data about on-premises instances. • If you configured a resource data sync for multiple accounts and Regions, verify that you're signed in to the Organizations management account or the Explorer delegated administator account. Patch widget doesn't display data The Non-compliant instances for patching widget only displays data about patch instances that aren't compliant. This widget displays no data if your instances are compliant. If you suspect that you have non-compliant instances, then verify that you set up and configured Systems Manager patching and use AWS Systems Manager Patch Manager to check your patch compliance. For more information, see AWS Systems Manager Patch Manager. Miscellaneous issues Explorer doesn't let you edit or remediate OpsItems: OpsItems viewed across accounts or Regions are read-only. They can only be updated and remediated from their home account or Region. AWS Systems Manager OpsCenter OpsCenter, a tool in AWS Systems Manager, provides a central location where operations engineers and IT professionals can view, investigate, and resolve operational work items (OpsItems) related to AWS resources. OpsCenter is designed to reduce mean time to resolution for issues impacting AWS resources. OpsCenter aggregates and standardizes OpsItems across services while providing contextual investigation data about each OpsItem, related OpsItems, and related resources. OpsCenter also provides Systems Manager Automation runbooks that you can use to quickly resolve issues. You can specify searchable, custom data for each OpsItem. You can also view automatically-generated summary reports about OpsItems by status and source. To get started with OpsCenter, open the Systems Manager console. In the navigation pane, choose OpsCenter. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any AWS service that publishes events. Configuring CloudWatch alarms and EventBridge events to automatically create OpsCenter 2179 AWS Systems Manager User Guide OpsItems allows you to quickly diagnose and remediate issues with AWS resources from a single console. To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the AWS resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the AWS resource, OpsCenter aggregates information from AWS Config, AWS CloudTrail logs, and Amazon CloudWatch Events, so you don't have to navigate across multiple console pages during your investigation. The following list includes types of AWS resources and metrics for
|
systems-manager-ug-629
|
systems-manager-ug.pdf
| 629 |
OpsCenter 2179 AWS Systems Manager User Guide OpsItems allows you to quickly diagnose and remediate issues with AWS resources from a single console. To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the AWS resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the AWS resource, OpsCenter aggregates information from AWS Config, AWS CloudTrail logs, and Amazon CloudWatch Events, so you don't have to navigate across multiple console pages during your investigation. The following list includes types of AWS resources and metrics for which customers configure CloudWatch alarms that create OpsItems. • Amazon DynamoDB: database read and write actions reach a threshold • Amazon EC2: CPU utilization reaches a threshold • AWS billing: estimated charges reach a threshold • Amazon EC2: an instance fails a status check • Amazon Elastic Block Store (EBS): disk space utilization reaches a threshold The following list includes types of EventBridge rules customer configure to create OpsItems. • AWS Security Hub: security alert issued • DynamoDB: a throttling event • Amazon EC2 Auto Scaling: failure to launch an instance • Systems Manager: failure to run an automation • AWS Health: an alert for scheduled maintenance • EC2: instance state change from Running to Stopped OpsCenter is also integrated with Amazon CloudWatch Application Insights for .NET and SQL Server. This means you can automatically create OpsItems for problems detected in your applications. You can also integrate OpsCenter with AWS Security Hub to aggregate and take action on your security, performance, and operational issues in Systems Manager. Operations engineers and IT professionals can create, view, and edit OpsItems by using the OpsCenter page in the AWS Systems Manager console, public API operations, the AWS Command OpsCenter 2180 AWS Systems Manager User Guide Line Interface (AWS CLI), AWS Tools for Windows PowerShell, or the AWS SDKs. OpsCenter public API operations also allows you to integrate OpsCenter with your case management systems and health dashboards. How can OpsCenter benefit my organization? OpsCenter provides a standard and unified experience for viewing, working on, and remediating issues related to AWS resources. A standard and unified experience improves the time it takes to remedy issues, investigate related issues, and train new operations engineers and IT professionals. A standard and unified experience also reduces the number of manual errors entered into the system of managing and remediating issues. More specifically, OpsCenter offers the following benefits for operations engineers and organizations: • You no longer need to navigate across multiple console pages to view, investigate, and resolve OpsItems related to AWS resources. OpsItems are aggregated, across services, in a central location. • You can view service-specific and contextually relevant data for OpsItems that are automatically generated by CloudWatch alarms, EventBridge events, and CloudWatch Application Insights for .NET and SQL Server. • You can specify the Amazon Resource Name (ARN) of a resource related to an OpsItem. By specifying related resources, OpsCenter uses built-in logic to help you avoid creating duplicate OpsItems. • You can view details and resolution information about similar OpsItems. • You can quickly view information about and run Systems Manager Automation runbooks to resolve issues. What are the features of OpsCenter? • Automated and manual OpsItem creation OpsCenter is integrated with Amazon CloudWatch. This means you can configure CloudWatch to automatically create an OpsItem in OpsCenter when an alarm enters the ALARM state or when Amazon EventBridge processes an event from any AWS service that publishes events. You can also manually create OpsItems. OpsCenter 2181 AWS Systems Manager User Guide OpsCenter is also integrated with Amazon CloudWatch Application Insights for .NET and SQL Server. This means you can automatically create OpsItems for problems detected in your applications. • Detailed and searchable OpsItems Each OpsItem includes multiple fields of information, including a title, ID, priority, description, the source of the OpsItem, and the date/time it was last updated. Each OpsItem also includes the following configurable features: • Status: Open, In progress, Resolved, or Open and In progress. • Related resources: A related resource is the impacted resource or the resource that initiated the EventBridge event that created the OpsItem. Each OpsItem includes a Related resources section where OpsCenter automatically lists the Amazon Resource Name (ARN) of the related resource. You can also manually specify ARNs of related resources. For some ARN types, OpsCenter automatically creates a deep link that displays details about the resource without having to visit other console pages to view that information. For example, if you specify the ARN of an EC2 instance, you can view all of the EC2-provided details about that instance in OpsCenter. You can manually add the ARNs of additional related resources. Each OpsItem can list a maximum of 100 related resource ARNs. For more information, see Adding
|
systems-manager-ug-630
|
systems-manager-ug.pdf
| 630 |
section where OpsCenter automatically lists the Amazon Resource Name (ARN) of the related resource. You can also manually specify ARNs of related resources. For some ARN types, OpsCenter automatically creates a deep link that displays details about the resource without having to visit other console pages to view that information. For example, if you specify the ARN of an EC2 instance, you can view all of the EC2-provided details about that instance in OpsCenter. You can manually add the ARNs of additional related resources. Each OpsItem can list a maximum of 100 related resource ARNs. For more information, see Adding related resources to an OpsItem. • Related and Similar OpsItems: With the Related OpsItems feature, you can specify the IDs of OpsItems that are in some way related to the current OpsItem. The Similar OpsItem feature automatically reviews OpsItem titles and descriptions and then lists other OpsItems that might be related or of interest to you. • Searchable and private operational data: Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB. This custom data is searchable, but with restrictions. For the Searchable operational data feature, all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. For the Private operational data feature, the data is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation). OpsCenter 2182 AWS Systems Manager User Guide • Deduplication: By specifying related resources, OpsCenter uses built-in logic to help you avoid creating duplicate OpsItems. OpsCenter also includes a feature called Operational insights, which displays information about duplicate OpsItems. To further limit the number of duplicate OpsItems in your account, you can manually specify a deduplication string for an EventBridge event rule. For more information, see Managing duplicate OpsItems. • Bulk edit OpsItems: You can select multiple OpsItems in OpsCenter and edit one of the following fields: Status, Priority, Severity, Category. • Easy remediation using runbooks Each OpsItem includes a Runbooks section with a list of Systems Manager Automation runbooks that you can use to automatically remediate common issues with AWS resources. If you open an OpsItem, choose an AWS resource for that OpsItem, and then choose the Run automation button in the console, then OpsCenter provides a list of Automation runbooks that you can run on the AWS resource that generated the OpsItem. After you run an Automation runbook from an OpsItem, the runbook is automatically associated with the related resource of the OpsItem for future reference. Additionally, if you automatically set up OpsItem rules in EventBridge by using OpsCenter, then EventBridge automatically associates runbooks for common events. OpsCenter keeps a 30-day record of Automation runbooks run for a specific OpsItem. For more information, see Remediate OpsItem issues. • Change notification: You can specify the ARN of an Amazon Simple Notification Service (SNS) topic and publish notifications anytime an OpsItem is changed or edited. The SNS topic must exist in the same AWS Region as the OpsItem. • Comprehensive OpsItem search capabilities: OpsCenter provides multiple search options to help you quickly locate OpsItems. Here are several examples of how you can search: OpsItem ID, Title, Last modified time, Operational data value, Source, and Automation ID of a runbook execution, to name a few. You can further limit search results by using status filters. • OpsItem summary reports OpsCenter includes a summary report page that automatically displays the following sections: • Status summary: a summary of OpsItems by status (Open, In progress, Resolved, Open and In progress). • Sources with most open OpsItems: a breakdown of the top AWS services with open OpsItems. • OpsItems by source and age: a count of OpsItems grouped by source and days since creation. For more information about viewing OpsCenter summary reports, see Viewing OpsCenter summary reports. OpsCenter 2183 AWS Systems Manager User Guide • Logging and auditing capability support You can audit and log OpsCenter user actions in your AWS account through integration with other AWS services. For more information, see Viewing OpsCenter logs and reports. • Console, CLI, PowerShell, and SDK access to OpsCenter tool You can work with OpsCenter by using the AWS Systems Manager console, AWS Command Line Interface (AWS CLI), AWS Tools for PowerShell, or the AWS SDK of your choice. Does OpsCenter integrate with my existing case management system? OpsCenter is designed to complement your existing case management systems. You can integrate OpsItems into your existing case management system by using public API operations. You can also maintain
|
systems-manager-ug-631
|
systems-manager-ug.pdf
| 631 |
log OpsCenter user actions in your AWS account through integration with other AWS services. For more information, see Viewing OpsCenter logs and reports. • Console, CLI, PowerShell, and SDK access to OpsCenter tool You can work with OpsCenter by using the AWS Systems Manager console, AWS Command Line Interface (AWS CLI), AWS Tools for PowerShell, or the AWS SDK of your choice. Does OpsCenter integrate with my existing case management system? OpsCenter is designed to complement your existing case management systems. You can integrate OpsItems into your existing case management system by using public API operations. You can also maintain manual lifecycle workflows in your current systems and use OpsCenter as an investigation and remediation hub. For information about OpsCenter public API operations, see the following API operations in the AWS Systems Manager API Reference. • CreateOpsItem • DescribeOpsItems • GetOpsItem • GetOpsSummary • UpdateOpsItem Is there a charge to use OpsCenter? Yes. For more information, see AWS Systems Manager Pricing. Does OpsCenter work with my on-premises and hybrid managed nodes? Yes. You can use OpsCenter to investigate and remediate issues with your on-premises managed nodes that are configured for Systems Manager. For more information about setting up and configuring on-premises servers and virtual machines for Systems Manager, see Managing nodes in hybrid and multicloud environments with Systems Manager. OpsCenter 2184 AWS Systems Manager User Guide What are the quotas for OpsCenter? You can view quotas for all Systems Manager tools in the Systems Manager service quotas in the Amazon Web Services General Reference. Unless otherwise noted, each quota is Region-specific. Set up OpsCenter AWS Systems Manager uses an integrated setup experience to help you get started with OpsCenter and Explorer, which are tools in Systems Manager. Explorer is a customizable operations dashboard that reports information about your AWS resources. In this documentation, Explorer and OpsCenter setup is called Integrated Setup. You must use Integrated Setup to set up OpsCenter with Explorer. Integrated Setup is only available in the AWS Systems Manager console. You can't set up Explorer and OpsCenter programmatically. For more information, see Getting started with Systems Manager Explorer and OpsCenter. Before you begin When you set up OpsCenter, you enable default rules in Amazon EventBridge that automatically create OpsItems. The following table describes the default EventBridge rules that automatically create OpsItems. You can disable EventBridge rules in the OpsCenter Settings page under OpsItem rules. Important Your account is charged for OpsItems created by default rules. For more information, see AWS Systems Manager Pricing. Rule name Description SSMOpsItems-Autoscaling-instance-launch- failure This rule creates OpsItems when the launch of an EC2 auto scaling instance failed. SSMOpsItems-Autoscaling-instance-ter mination-failure This rule creates OpsItems when the terminati on of an EC2 auto scaling instance failed. OpsCenter 2185 AWS Systems Manager Rule name SSMOpsItems-EBS-snapshot-copy-failed SSMOpsItems-EBS-snapshot-creation-failed SSMOpsItems-EBS-volume-performance-issue SSMOpsItems-EC2-issue SSMOpsItems-EC2-scheduled-change User Guide Description This rule creates OpsItems when the system failed to copy an Amazon Elastic Block Store (Amazon EBS) snapshot. This rule creates OpsItems when the system failed to create an Amazon EBS snapshot. This rule corresponds to an AWS Health tracking rule. The rule creates OpsItems whenever there is a performance issue with an Amazon EBS volume (health event = AWS_EBS_DEGRADED_EBS_VOLUME ). _PERFORMANCE This rule corresponds to an AWS Health tracking rule for unexpected events that affect AWS services or resources. The rule creates OpsItems when, for example, a service sends communications about operational issues that are causing service degradation or to raise awarness about localized resource-level issues. For example, this rule creates an OpsItem for the following event: AWS_EC2_OPERATIONA L_ISSUE . This rule corresponds to an AWS Health tracking rule. AWS can schedule events for your instances, such as rebooting, stopping, or starting instances. The rule creates OpsItems for EC2 scheduled events. For more informati on about scheduled events, see Scheduled events for your instances in the Amazon EC2 User Guide. OpsCenter 2186 AWS Systems Manager Rule name SSMOpsItems-RDS-issue SSMOpsItems-RDS-scheduled-change SSMOpsItems-SSM-maintenance-window-e xecution-failed User Guide Description This rule corresponds to an AWS Health tracking rule for unexpected events that affect AWS services or resources. The rule creates OpsItems when, for example, a service sends communications about operational issues that are causing service degradation or to raise awarness about localized resource-level issues. For example, this rule creates an OpsItem for the following events: AWS_RDS_MYSQL_DATA BASE_CRASHING_REPEATEDLY , AWS_RDS_EXPORT_TASK_FAILED , and AWS_RDS_CONNECTIVITY_ISSUE . This rule corresponds to an AWS Health tracking rule. The rule creates OpsItems for Amazon RDS scheduled events. Scheduled events provide information about upcoming changes to your Amazon RDS resources. Some events might recommend that you take action to avoid service disruptions. Other events occur automatically without any action on your part. Your resource might be temporari ly unavailable during the scheduled change activity. For example, this rule creates an OpsItem for the following events: AWS_RDS_S YSTEM_UPGRADE_SCHEDULED and . For AWS_RDS_MAINTENANCE_SCHEDULED more information about
|
systems-manager-ug-632
|
systems-manager-ug.pdf
| 632 |
rule creates an OpsItem for the following events: AWS_RDS_MYSQL_DATA BASE_CRASHING_REPEATEDLY , AWS_RDS_EXPORT_TASK_FAILED , and AWS_RDS_CONNECTIVITY_ISSUE . This rule corresponds to an AWS Health tracking rule. The rule creates OpsItems for Amazon RDS scheduled events. Scheduled events provide information about upcoming changes to your Amazon RDS resources. Some events might recommend that you take action to avoid service disruptions. Other events occur automatically without any action on your part. Your resource might be temporari ly unavailable during the scheduled change activity. For example, this rule creates an OpsItem for the following events: AWS_RDS_S YSTEM_UPGRADE_SCHEDULED and . For AWS_RDS_MAINTENANCE_SCHEDULED more information about scheduled events, see Event type categories in the AWS Health User Guide. This rule creates OpsItems when the processin g of the Systems Manager maintenance window failed. OpsCenter 2187 AWS Systems Manager Rule name Description User Guide SSMOpsItems-SSM-maintenance-window-e xecution-timedout This rule creates OpsItems when the launch of the Systems Manager maintenance window timed out. Use the following procedure to set up OpsCenter. To set up OpsCenter 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. On the OpsCenter home page, choose Get started. 4. On the OpsCenter setup page, choose Enable this option to have Explorer configure AWS Config and Amazon CloudWatch events to automatically create OpsItems based on commonly-used rules and events. If you don't choose this option, OpsCenter remains disabled. Note Amazon EventBridge (formerly Amazon CloudWatch Events) provides all functionality of CloudWatch Events and some new features, such as custom event buses, third-party event sources and schema registry. 5. Choose Enable OpsCenter. After you enable OpsCenter, you can do the following from Settings: • Create CloudWatch alarms using the Open CloudWatch console button. For more information, see Configure CloudWatch alarms to create OpsItems. • Enable operational insights. For more information, see Analyzing operational insights to reduce OpsItems. • Enable AWS Security Hub findings alarms. For more information, see Understanding OpsCenter integration with AWS Security Hub. OpsCenter 2188 AWS Systems Manager Contents User Guide • (Optional) Setting up OpsCenter to centrally manage OpsItems across accounts • (Optional) Set up Amazon SNS to receive notifications about OpsItems (Optional) Setting up OpsCenter to centrally manage OpsItems across accounts You can use Systems Manager OpsCenter to centrally manage OpsItems across multiple AWS accounts in a selected AWS Region. This feature is available after you set up your organization in AWS Organizations. AWS Organizations is an account management service that enables you to consolidate multiple AWS accounts into an organization that you create and centrally manage. AWS Organizations includes account management and consolidated billing capabilities that enable you to better meet the budgetary, security, and compliance needs of your business. For more information, see What is AWS Organizations? in the AWS Organizations User Guide Users who belong to the AWS Organizations management account can set up a delegated administrator account for Systems Manager. In the context of OpsCenter, delegated administrators can create, edit, and view OpsItems in member accounts. The delegated administrator can also use Systems Manager Automation runbooks to bulk resolve OpsItems or remediate issues with AWS resources that are generating OpsItems. Note You can assign only one account as the delegated administrator for Systems Manager. For more information, see Creating an AWS Organizations delegated administrator for Systems Manager. Systems Manager offers the following methods for setting up OpsCenter to centrally manage OpsItems across multiple AWS accounts. • Quick Setup: Quick Setup, a tool in Systems Manager, simplifies set up and configuration tasks for Systems Manager tools. For more information, see AWS Systems Manager Quick Setup. Quick Setup for OpsCenter helps you complete the following tasks for managing OpsItems across accounts: • Registering an account as the delegated administrator (if the delegated administrator hasn't already been designated) OpsCenter 2189 AWS Systems Manager User Guide • Creating required AWS Identity and Access Management (IAM) policies and roles • Specifying an AWS Organizations organization or organizational units (OUs) where a delegated administrator can manage OpsItems across accounts For more information, see (Optional) Configure OpsCenter to manage OpsItems across accounts by using Quick Setup. Note Quick Setup isn't available in all AWS Regions where Systems Manager is currently available. If Quick Setup isn't available in a Region where you want to use it to configure OpsCenter to centrally manage OpsItems across multiple accounts, then you must use the manual method. To view a list of AWS Regions where Quick Setup is available, see Availability of Quick Setup in AWS Regions. • Manual set up: If Quick Setup isn't available in the Region where you want to configure OpsCenter to centrally manage OpsItems across accounts, then you can use the manual procedure to do so. For more information, see (Optional) Manually set up OpsCenter to centrally manage OpsItems across accounts. (Optional) Configure OpsCenter to manage OpsItems across
|
systems-manager-ug-633
|
systems-manager-ug.pdf
| 633 |
Region where you want to use it to configure OpsCenter to centrally manage OpsItems across multiple accounts, then you must use the manual method. To view a list of AWS Regions where Quick Setup is available, see Availability of Quick Setup in AWS Regions. • Manual set up: If Quick Setup isn't available in the Region where you want to configure OpsCenter to centrally manage OpsItems across accounts, then you can use the manual procedure to do so. For more information, see (Optional) Manually set up OpsCenter to centrally manage OpsItems across accounts. (Optional) Configure OpsCenter to manage OpsItems across accounts by using Quick Setup Quick Setup, a tool in AWS Systems Manager, simplifies setup and configuration tasks for Systems Manager tools. Quick Setup for OpsCenter helps you complete the following tasks for managing OpsItems across accounts: • Specifying the delegated administrator account • Creating required AWS Identity and Access Management (IAM) policies and roles • Specifying an AWS Organizations organization, or a subset of member accounts, where a delegated administrator can manage OpsItems across accounts When you configure OpsCenter to manage OpsItems across accounts by using Quick Setup, Quick Setup creates the following resources in the specified accounts. These resources give the specified accounts permission to work with OpsItems and use Automation runbooks to fix issues with AWS resources generating OpsItems. OpsCenter 2190 User Guide Accounts AWS Organizations management account and delegated administrator account Delegated administrator account All AWS Organizations member accounts AWS Systems Manager Resources AWSServiceRoleForAmazonSSM_ AccountDiscovery Access Management (IAM) service-linked role AWS Identity and For more information about this role, see Using roles to collect AWS account informati on for OpsCenter and Explorer. OpsItem-CrossAccountManagem entRole IAM role AWS-SystemsManager-Automati onAdministrationRole IAM role OpsItem-CrossAccountExecuti onRole IAM role AWS-SystemsManager-Automati onExecutionRole IAM role AWS::SSM::ResourcePolicy Systems Manager resource policy for the default OpsItem group (OpsItemGroup ) Note If you previously configured OpsCenter to manage OpsItems across accounts using the manual method, you must delete the AWS CloudFormation stacks or stack sets created during Steps 4 and 5 of that process. If those resources exist in your account when you complete the following procedure, Quick Setup fails to configure cross-account OpsItem management properly. To configure OpsCenter to manage OpsItems across accounts by using Quick Setup 1. Sign in to the AWS Management Console using the AWS Organizations management account. OpsCenter 2191 AWS Systems Manager User Guide 2. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 3. In the navigation pane, choose Quick Setup. 4. Choose the Library tab. 5. Scroll to the bottom and locate the OpsCenter configuration tile. Choose Create. 6. On the Quick Setup OpsCenter page, in the Delegated administrator section, enter an account ID. If you are unable to edit this field, then a delegated administrator account has already been specified for Systems Manager. 7. In the Targets section, choose an option. If you choose Custom, then select the organizational units (OU) where you want to manage OpsItems across accounts. 8. Choose Create. Quick Setup creates the OpsCenter configuration and deploys the required AWS resources to the designated OUs. Note If you don't want to manage OpsItems across multiple accounts, you can delete the configuration from Quick Setup. When you delete the configuration, Quick Setup deletes the following IAM policies and roles created when the configuration was originally deployed: • OpsItem-CrossAccountManagementRole from the delegated administrator account • OpsItem-CrossAccountExecutionRole and SSM::ResourcePolicy from all Organizations member accounts Quick Setup removes the configuration from all organizational units and AWS Regions where the configuration was originally deployed. Troubleshooting issues with a Quick Setup configuration for OpsCenter This section includes information to help you troubleshoot issues when configuring cross-account OpsItem management using Quick Setup. Topics OpsCenter 2192 AWS Systems Manager User Guide • Deployment to these StackSets failed: delegatedAdmin • Quick Setup configuration status shows Failed Deployment to these StackSets failed: delegatedAdmin When creating an OpsCenter configuration, Quick Setup deploys two AWS CloudFormation stack sets in the Organizations management account. The stack sets use the following prefix: AWS- QuickSetup-SSMOpsCenter. If Quick Setup displays the following error: Deployment to these StackSets failed: delegatedAdmin use the following procedure to fix this issue. To troubleshoot a StackSets failed:delegatedAdmin error 1. If you received the Deployment to these StackSets failed: delegatedAdmin error in a red banner in the Quick Setup console, sign in to the delegated administrator account and the AWS Region designated as the Quick Setup home Region. 2. Open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation. 3. Choose the stack created by your Quick Setup configuration. The stack name includes the following: AWS-QuickSetup-SSMOpsCenter. Note Sometimes CloudFormation deletes failed stack deployments. If the stack isn't available in the Stacks table, choose Deleted from the filter list. 4. View the Status and Status reason. For more information about stack statuses, see Stack status codes in the AWS CloudFormation User
|
systems-manager-ug-634
|
systems-manager-ug.pdf
| 634 |
StackSets failed: delegatedAdmin error in a red banner in the Quick Setup console, sign in to the delegated administrator account and the AWS Region designated as the Quick Setup home Region. 2. Open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation. 3. Choose the stack created by your Quick Setup configuration. The stack name includes the following: AWS-QuickSetup-SSMOpsCenter. Note Sometimes CloudFormation deletes failed stack deployments. If the stack isn't available in the Stacks table, choose Deleted from the filter list. 4. View the Status and Status reason. For more information about stack statuses, see Stack status codes in the AWS CloudFormation User Guide. 5. To understand the exact step that failed, view the Events tab and review each event's Status. For more information, see Troubleshooting in the AWS CloudFormation User Guide. Note If you are unable to resolve the deployment failure using the CloudFormation troubleshooting steps, delete the configuration and try again. OpsCenter 2193 AWS Systems Manager User Guide Quick Setup configuration status shows Failed If the Configuration details table on the Configuration details page shows a configuration status of Failed, sign in to the AWS account and Region where it failed. To troubleshoot a Quick Setup failure to create an OpsCenter configuration 1. Sign in to the AWS account and the AWS Region where the failure occurred. 2. Open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation. 3. Choose the stack created by your Quick Setup configuration. The stack name includes the following: AWS-QuickSetup-SSMOpsCenter. Note Sometimes CloudFormation deletes failed stack deployments. If the stack isn't available in the Stacks table, choose Deleted from the filter list. 4. View the Status and Status reason. For more information about stack statuses, see Stack status codes in the AWS CloudFormation User Guide. 5. To understand the exact step that failed, view the Events tab and review each event's Status. For more information, see Troubleshooting in the AWS CloudFormation User Guide. Member account configuration shows ResourcePolicyLimitExceededException If a stack status shows ResourcePolicyLimitExceededException, the account has previously onboarded to OpsCenter cross-account management by using the manual method. To resolve this issue, you must delete the AWS CloudFormation stacks or stack sets created during Steps 4 and 5 of the manual onboarding process. For more information, see Delete a stack set and Deleting a stack on the AWS CloudFormation console in the AWS CloudFormation User Guide. (Optional) Manually set up OpsCenter to centrally manage OpsItems across accounts This section describes how to manually configure OpsCenter for cross-account OpsItem management. While this process is still supported, it has been replaced by a newer process that uses Systems Manager Quick Setup. For more information, see (Optional) Configure OpsCenter to manage OpsItems across accounts by using Quick Setup. You can set up a central account to create manual OpsItems for member accounts, and manage and remediate those OpsItems. The central account can be the AWS Organizations management OpsCenter 2194 AWS Systems Manager User Guide account, or both the AWS Organizations management account and Systems Manager delegated administrator account. We recommend that you use the Systems Manager delegated administrator account as a central account. You can only use this feature after you configure AWS Organizations. With AWS Organizations, you can consolidate multiple AWS accounts into an organization that you create and manage centrally. The central account user can create OpsItems for all selected member accounts simultaneously, and manage those OpsItems. Use the process in this section to enable the Systems Manager service principal in Organizations and configure AWS Identity and Access Management (IAM) permissions for working with OpsItems across accounts. Topics • Before you begin • Step 1: Creating a resource data sync • Step 2: Enabling the Systems Manager service principal in AWS Organizations • Step 3: Creating the AWSServiceRoleForAmazonSSM_AccountDiscovery service-linked role • Step 4: Configuring permissions to work with OpsItems across accounts • Step 5: Configuring permissions to work with related resources across accounts Note Only OpsItems of type /aws/issue are supported when working in OpsCenter across accounts. Before you begin Before you set up OpsCenter to work with OpsItems across accounts, ensure that you have set up the following: • A Systems Manager delegated administrator account. For more information, see Configuring a delegated administrator for Explorer. • One organization set up and configured in Organizations. For more information, see Creating and managing an organization in the AWS Organizations User Guide. OpsCenter 2195 AWS Systems Manager User Guide • You configured Systems Manager Automation to run automation runbooks across multiple AWS Regions and AWS accounts. For more information, see Running automations in multiple AWS Regions and accounts. Step 1: Creating a resource data sync After you set up and configure AWS Organizations, you can aggregate OpsItems in OpsCenter for an entire organization by creating a resource data sync. For more information, see Creating a resource data sync. When you create the
|
systems-manager-ug-635
|
systems-manager-ug.pdf
| 635 |
up and configured in Organizations. For more information, see Creating and managing an organization in the AWS Organizations User Guide. OpsCenter 2195 AWS Systems Manager User Guide • You configured Systems Manager Automation to run automation runbooks across multiple AWS Regions and AWS accounts. For more information, see Running automations in multiple AWS Regions and accounts. Step 1: Creating a resource data sync After you set up and configure AWS Organizations, you can aggregate OpsItems in OpsCenter for an entire organization by creating a resource data sync. For more information, see Creating a resource data sync. When you create the sync, in the Add accounts section, be sure to choose the Include all accounts from my AWS Organizations configuration option. Step 2: Enabling the Systems Manager service principal in AWS Organizations To enable a user to work with OpsItems across accounts, the Systems Manager service principal must be enabled in AWS Organizations. If you previously configured Systems Manager for multi- account scenarios using other tools, the Systems Manager service principal might already be configured in Organizations. Run the following commands from the AWS Command Line Interface (AWS CLI) to verify. If you haven't configured Systems Manager for other multi-account scenarios, skip to the next procedure, To enable the Systems Manager service principal in AWS Organizations. To verify the Systems Manager service principal is enabled in AWS Organizations 1. Download the latest version of the AWS CLI to your local machine. 2. Open the AWS CLI, and run the following command to specify your credentials and an AWS Region. aws configure The system prompts you to specify the following. In the following example, replace each user input placeholder with your own information. AWS Access Key ID [None]: key_name AWS Secret Access Key [None]: key_name Default region name [None]: region Default output format [None]: ENTER 3. Run the following command to verify that the Systems Manager service principal is enabled for AWS Organizations. OpsCenter 2196 AWS Systems Manager User Guide aws organizations list-aws-service-access-for-organization The command returns information similar to that shown in the following example. { "EnabledServicePrincipals": [ { "ServicePrincipal": "member.org.stacksets.cloudformation.amazonaws.com", "DateEnabled": "2020-12-11T16:32:27.732000-08:00" }, { "ServicePrincipal": "opsdatasync.ssm.amazonaws.com", "DateEnabled": "2022-01-19T12:30:48.352000-08:00" }, { "ServicePrincipal": "ssm.amazonaws.com", "DateEnabled": "2020-12-11T16:32:26.599000-08:00" } ] } To enable the Systems Manager service principal in AWS Organizations If you haven't previously configured the Systems Manager service principal for Organizations, use the following procedure to do so. For more information about this command, see enable-aws- service-access in the AWS CLI Command Reference. 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing CLI and Configuring CLI. 2. Download the latest version of the AWS CLI to your local machine. 3. Open the AWS CLI, and run the following command to specify your credentials and an AWS Region. aws configure The system prompts you to specify the following. In the following example, replace each user input placeholder with your own information. OpsCenter 2197 AWS Systems Manager User Guide AWS Access Key ID [None]: key_name AWS Secret Access Key [None]: key_name Default region name [None]: region Default output format [None]: ENTER 4. Run the following command to enable the Systems Manager service principal for AWS Organizations. aws organizations enable-aws-service-access --service-principal "ssm.amazonaws.com" Step 3: Creating the AWSServiceRoleForAmazonSSM_AccountDiscovery service-linked role A service-linked role such as the AWSServiceRoleForAmazonSSM_AccountDiscovery role is a unique type of IAM role that is linked directly to an AWS service, such as Systems Manager. Service-linked roles are predefined by the service and include all the permissions that the service requires to call other AWS services on your behalf. For more information about the AWSServiceRoleForAmazonSSM_AccountDiscovery service-linked role, see Service-linked role permissions for Systems Manager account discovery. Use the following procedure to create the AWSServiceRoleForAmazonSSM_AccountDiscovery service-linked role by using the AWS CLI. For more information about the command used in this procedure, see create-service-linked-role in the AWS CLI Command Reference. To create the AWSServiceRoleForAmazonSSM_AccountDiscovery service-linked role 1. Sign in to the AWS Organizations management account. 2. While signed in to the Organizations management account, run the following command. aws iam create-service-linked-role \ --aws-service-name accountdiscovery.ssm.amazonaws.com \ --description "Systems Manager account discovery for AWS Organizations service- linked role" Step 4: Configuring permissions to work with OpsItems across accounts Use AWS CloudFormation stacksets to create an OpsItemGroup resource policy and an IAM execution role that give users permission to work with OpsItems across accounts. OpsCenter 2198 AWS Systems Manager User Guide To get started, download and unzip the OpsCenterCrossAccountMembers.zip file. This file contains the OpsCenterCrossAccountMembers.yaml AWS CloudFormation template file. When you create a stack set by using this template, CloudFormation automatically creates the OpsItemCrossAccountResourcePolicy resource policy and the OpsItemCrossAccountExecutionRole execution role in the account. For more information about creating a stack set, see Create a stack set in the AWS CloudFormation User Guide. Important Note the following important information
|
systems-manager-ug-636
|
systems-manager-ug.pdf
| 636 |
Use AWS CloudFormation stacksets to create an OpsItemGroup resource policy and an IAM execution role that give users permission to work with OpsItems across accounts. OpsCenter 2198 AWS Systems Manager User Guide To get started, download and unzip the OpsCenterCrossAccountMembers.zip file. This file contains the OpsCenterCrossAccountMembers.yaml AWS CloudFormation template file. When you create a stack set by using this template, CloudFormation automatically creates the OpsItemCrossAccountResourcePolicy resource policy and the OpsItemCrossAccountExecutionRole execution role in the account. For more information about creating a stack set, see Create a stack set in the AWS CloudFormation User Guide. Important Note the following important information about this task: • You must deploy the stackset while signed in to the AWS Organizations management account. • You must repeat this procedure while signed in to every account that you want to target for working with OpsItems across accounts, including the delegated administrator account. • If you want to enable cross-account OpsItems administration in different AWS Regions, choose Add all regions in the Specify regions section of the template. Cross-account OpsItem administration isn't supported for opt-in Regions. Step 5: Configuring permissions to work with related resources across accounts An OpsItem can include detailed information about impacted resources such as Amazon Elastic Compute Cloud (Amazon EC2) instances or Amazon Simple Storage Service (Amazon S3) buckets. The OpsItemCrossAccountExecutionRole execution role, which you created in the previous Step 4, provides OpsCenter with read-only permissions for member accounts to view related resources. You must also create an IAM role to provide management accounts with permission to view and interact with related resources, which you will complete in this task. To get started, download and unzip the OpsCenterCrossAccountManagementRole.zip file. This file contains the OpsCenterCrossAccountManagementRole.yaml AWS CloudFormation template file. When you create a stack by using this template, CloudFormation automatically creates the OpsCenterCrossAccountManagementRole IAM role in the account. For more information about creating a stack, see Creating a stack on the AWS CloudFormation console in the AWS CloudFormation User Guide. OpsCenter 2199 AWS Systems Manager Important User Guide Note the following important information about this task: • If you plan to specify an account as a delegated administrator for OpsCenter, be sure to specify that AWS account when you create the stack. • You must perform this procedure while signed in to the AWS Organizations management account and again while signed in to the delegated administrator account. (Optional) Set up Amazon SNS to receive notifications about OpsItems You can configure OpsCenter to send notifications to an Amazon Simple Notification Service (Amazon SNS) topic when the system creates an OpsItem or updates an existing OpsItem. Complete the following steps to receive notifications for OpsItems. • Step 1: Creating and subscribing to an Amazon SNS topic • Step 2: Updating the Amazon SNS access policy • Step 3: Updating the AWS KMS access policy Note If you turn on AWS Key Management Service (AWS KMS) server-side encryption in Step 2, then you must complete Step 3. Otherwise, you can skip Step 3. • Step 4: Turning on default OpsItems rules to send notifications for new OpsItems Step 1: Creating and subscribing to an Amazon SNS topic To receive notifications, you must create and subscribe to an Amazon SNS topic. For more information, see Creating an Amazon SNS topic and Subscribing to an Amazon SNS topic in the Amazon Simple Notification Service Developer Guide. OpsCenter 2200 AWS Systems Manager Note User Guide If you're using OpsCenter in multiple AWS Regions or accounts, you must create and subscribe to an Amazon SNS topic in each Region or account where you want to receive OpsItem notifications. Step 2: Updating the Amazon SNS access policy You have to associate an Amazon SNS topic with OpsItems. Use the following procedure to set up an Amazon SNS access policy so that Systems Manager can publish OpsItems notifications to the Amazon SNS topic that you created in Step 1. 1. Sign in to the AWS Management Console and open the Amazon SNS console at https:// console.aws.amazon.com/sns/v3/home. 2. In the navigation pane, choose Topics. 3. Choose the topic that you created in Step 1, and then choose Edit. 4. Expand Access policy. 5. Add the following Sid block to the existing policy. Replace each example resource placeholder with your own information. { "Sid": "Allow OpsCenter to publish to this topic", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com" }, "Action": "SNS:Publish", "Resource": "arn:aws:sns:region:account ID:topic name", // Account ID of the SNS topic owner "Condition": { "StringEquals": { "AWS:SourceAccount": "account ID" // Account ID of the OpsItem owner } } } OpsCenter 2201 AWS Systems Manager Note User Guide The aws:SourceAccount global condition key protects against the confused deputy scenario. To use this condition key, set the value to the account ID of the OpsItem owner. For more information, see Confused Deputy in the IAM User Guide.
|
systems-manager-ug-637
|
systems-manager-ug.pdf
| 637 |
example resource placeholder with your own information. { "Sid": "Allow OpsCenter to publish to this topic", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com" }, "Action": "SNS:Publish", "Resource": "arn:aws:sns:region:account ID:topic name", // Account ID of the SNS topic owner "Condition": { "StringEquals": { "AWS:SourceAccount": "account ID" // Account ID of the OpsItem owner } } } OpsCenter 2201 AWS Systems Manager Note User Guide The aws:SourceAccount global condition key protects against the confused deputy scenario. To use this condition key, set the value to the account ID of the OpsItem owner. For more information, see Confused Deputy in the IAM User Guide. 6. Choose Save changes. The system now sends notifications to the Amazon SNS topic when OpsItems are created or updated. Important If you configure the Amazon SNS topic with an AWS Key Management Service (AWS KMS) server-side encryption key in the Step 2, then complete Step 3. Otherwise, you can skip Step 3. Step 3: Updating the AWS KMS access policy If you turned on AWS KMS server-side encryption for your Amazon SNS topic, you must also update the access policy of the AWS KMS key that you chose when you configured the topic. Use the following procedure to update the access policy so that Systems Manager can publish OpsItem notifications to the Amazon SNS topic you created in Step 1. Note OpsCenter doesn't support publishing OpsItems to an Amazon SNS topic that is configured with an AWS managed key. 1. Open the AWS KMS console at https://console.aws.amazon.com/kms. 2. 3. To change the AWS Region, use the Region selector in the upper-right corner of the page. In the navigation pane, choose Customer managed keys. 4. Choose the ID of the KMS key that you chose when you created the topic. 5. In the Key policy section, choose Switch to policy view. OpsCenter 2202 AWS Systems Manager 6. Choose Edit. User Guide 7. Add the following Sid block to the existing policy. Replace each example resource placeholder with your own information. { "Sid": "Allow OpsItems to decrypt the key", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com" }, "Action": ["kms:Decrypt", "kms:GenerateDataKey*"], "Resource": "arn:aws:kms:region:account ID:key/key ID" } In the following example, the new block is entered at line 14. 8. Choose Save changes. Step 4: Turning on default OpsItems rules to send notifications for new OpsItems Default OpsItems rules in Amazon EventBridge aren't configured with an Amazon Resource Name (ARN) for Amazon SNS notifications. Use the following procedure to edit a rule in EventBridge and enter a notifications block. OpsCenter 2203 AWS Systems Manager User Guide To add a notifications block to a default OpsItem rule 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose the OpsItems tab, and then choose Configure sources. 4. Choose the name of the source rule that you want to configure with a notifications block, as shown in the following example. The rule opens in Amazon EventBridge. 5. On the rule details page, on the Targets tab, choose Edit. 6. 7. In the Additional settings section, choose Configure input transformer. In the Template box, add a notifications block in the following format. "notifications":[{"arn":"arn:aws:sns:region:account ID:topic name"}], Here's an example. "notifications":[{"arn":"arn:aws:sns:us-west-2:1234567890:MySNSTopic"}], Enter the notifications block before the resources block, as shown in the following example for the US West (Oregon) (us-west-2) Region. { "title": "EBS snapshot copy failed", "description": "CloudWatch Event Rule SSMOpsItems-EBS-snapshot-copy-failed was triggered. Your EBS snapshot copy has failed. See below for more details.", OpsCenter 2204 AWS Systems Manager User Guide "category": "Availability", "severity": "2", "source": "EC2", "notifications": [{ "arn": "arn:aws:sns:us-west-2:1234567890:MySNSTopic" }], "resources": <resources>, "operationalData": { "/aws/dedup": { "type": "SearchableString", "value": "{\"dedupString\":\"SSMOpsItems-EBS-snapshot-copy-failed\"}" }, "/aws/automations": { "value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CopySnapshot\" } ]" }, "failure-cause": { "value": <failure - cause> }, "source": { "value": <source> }, "start-time": { "value": <start - time> }, "end-time": { "value": <end - time> } } } 8. Choose Confirm. 9. Choose Next. 10. Choose Next. 11. Choose Update rule. The next time that the system creates an OpsItem for the default rule, it publishes a notification to the Amazon SNS topic. OpsCenter 2205 AWS Systems Manager User Guide Integrate OpsCenter with other AWS services OpsCenter, a tool in AWS Systems Manager, integrates with multiple AWS services to diagnose and remediate issues with AWS resources. You must set up the AWS service before you integrate it with OpsCenter. By default, the following AWS services are integrated with OpsCenter and can create OpsItems automatically: • Amazon CloudWatch • Amazon CloudWatch Application Insights • Amazon EventBridge • AWS Config • AWS Systems Manager Incident Manager You have to integrate the following services with OpsCenter to create OpsItems automatically: • Amazon DevOps Guru • AWS Security Hub When any of these services create an OpsItem, you can manage and remediate the OpsItem from OpsCenter. For more
|
systems-manager-ug-638
|
systems-manager-ug.pdf
| 638 |
with multiple AWS services to diagnose and remediate issues with AWS resources. You must set up the AWS service before you integrate it with OpsCenter. By default, the following AWS services are integrated with OpsCenter and can create OpsItems automatically: • Amazon CloudWatch • Amazon CloudWatch Application Insights • Amazon EventBridge • AWS Config • AWS Systems Manager Incident Manager You have to integrate the following services with OpsCenter to create OpsItems automatically: • Amazon DevOps Guru • AWS Security Hub When any of these services create an OpsItem, you can manage and remediate the OpsItem from OpsCenter. For more information, see Manage OpsItems and Remediate OpsItem issues. For more information about each AWS service and how it integrates with OpsCenter, see the following topics. Topics • Understanding OpsCenter integration with Amazon CloudWatch • Understanding OpsCenter integration with Amazon CloudWatch Application Insights • Understanding OpsCenter integration with Amazon DevOps Guru • Understanding OpsCenter integration with Amazon EventBridge • Understanding OpsCenter integration with AWS Config • Understanding OpsCenter integration with AWS Security Hub • Understanding OpsCenter integration with Incident Manager OpsCenter 2206 AWS Systems Manager User Guide Understanding OpsCenter integration with Amazon CloudWatch Amazon CloudWatch monitors your AWS resources and services, and displays metrics on every AWS service that you use. CloudWatch creates an OpsItem when an alarm enters the alarm state. For example, you can configure an alarm to automatically create an OpsItem if there is a spike in HTTP errors generated by your Application Load Balancer. Some alarms that you can configure in CloudWatch to create OpsItems are shown in the following list: • Amazon DynamoDB: database read and write actions reach a threshold • Amazon EC2: CPU utilization reaches a threshold • AWS billing: estimated charges reach a threshold • Amazon EC2: an instance fails a status check • Amazon Elastic Block Store (EBS): disk space utilization reaches a threshold You can either create an alarm or edit an existing alarm to create an OpsItem. For more information, see Configure CloudWatch alarms to create OpsItems. When you enable OpsCenter using Integrated Setup, it integrates CloudWatch with OpsCenter. Understanding OpsCenter integration with Amazon CloudWatch Application Insights Using Amazon CloudWatch Application Insights, you can set up the most appropriate monitors for your application resources to continuously analyze data for signs of problems with your applications. When you configure application resources in CloudWatch Application Insights, you can choose to have the system create OpsItems in OpsCenter. An OpsItem is created on the OpsCenter console for every problem detected with the application. For information, see Set up, configure, and manage your application for monitoring in the Amazon CloudWatch User Guide. Note Starting October 16, 2023, the title and description for OpsItems created by CloudWatch Application Insights now use the following improved format: OpsItem title: [<APPLICATION NAME>: <RESOURCE ID>] <PROBLEM SUMMARY> OpsCenter 2207 AWS Systems Manager User Guide OpsItem description: CloudWatch Application Insights has detected a problem in application <APPLICATION NAME>. Problem summary: <PROBLEM SUMMARY> Problem ID: <PROBLEM ID> (hyperlinks to the Application Insights problem summary page) Problem Status: <PROBLEM STATUS> Insight: <INSIGHT> Here is an example: OpsCenter 2208 AWS Systems Manager User Guide Understanding OpsCenter integration with Amazon DevOps Guru Amazon DevOps Guru applies machine learning to analyze your operational data, application metrics, and application events to identify behaviors that deviate from normal operating patterns. OpsCenter 2209 AWS Systems Manager User Guide If you enable DevOps Guru to generate an OpsItem in OpsCenter, each insight generates a new OpsItem. You can use OpsCenter to manage your OpsItems. DevOps Guru automatically creates OpsItems. You can enable Amazon DevOps Guru to create OpsItems by using Quick Setup, which is a tool in Systems Manager. The system creates OpsItems by using the AWSServiceRoleForDevOpsGuru AWS Identity and Access Management (IAM) service- linked role. To integrate OpsCenter with DevOps Guru 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose Quick Setup. 3. On the Customize DevOps Guru configuration options page, choose the Library tab. 4. 5. 6. In the DevOps Guru pane, choose Create. For Configuration options, select Enable AWS Systems Manager OpsItems. Select Create after you complete the setup. Understanding OpsCenter integration with Amazon EventBridge Amazon EventBridge delivers a stream of events that describe changes in AWS resources. When you enable OpsCenter using Integrated Setup, it integrates EventBridge with OpsCenter, and enables default EventBridge rules. Based on these rules, EventBridge creates OpsItems. Using rules, you can filter and route events to OpsCenter for investigation and remediation. Note Amazon EventBridge (formerly Amazon CloudWatch Events) provides all functionality of CloudWatch Events and some new features, such as custom event buses, third-party event sources and schema registry. Following are some rules that you can configure in EventBridge to create an OpsItem: • Security Hub: security alert issued • Amazon DynamoDB a throttling
|
systems-manager-ug-639
|
systems-manager-ug.pdf
| 639 |
stream of events that describe changes in AWS resources. When you enable OpsCenter using Integrated Setup, it integrates EventBridge with OpsCenter, and enables default EventBridge rules. Based on these rules, EventBridge creates OpsItems. Using rules, you can filter and route events to OpsCenter for investigation and remediation. Note Amazon EventBridge (formerly Amazon CloudWatch Events) provides all functionality of CloudWatch Events and some new features, such as custom event buses, third-party event sources and schema registry. Following are some rules that you can configure in EventBridge to create an OpsItem: • Security Hub: security alert issued • Amazon DynamoDB a throttling event • Amazon Elastic Compute Cloud Auto Scaling: failure to launch an instance OpsCenter 2210 AWS Systems Manager User Guide • Systems Manager: failure to run an automation • AWS Health: an alert for scheduled maintenance • Amazon EC2: instance state changed from running to stop Based on your requirements, you can either create a rule or edit an existing rule to create an OpsItems. For instructions on how to edit a rule to create an OpsItem, see Configure EventBridge rules to create OpsItems. Understanding OpsCenter integration with AWS Config AWS Config provides a detailed view of the configuration of AWS resources in your AWS account. AWS Config does not integrate directly with OpsCenter. Instead, you create an AWS Config rule that sends an event to Amazon EventBridge, such as when AWS Config detects a noncompliant instance. Then EventBridge evaluates that event against an EventBridge rule you've created. If the rule matches, EventBridge transforms the event to an OpsItem and transmits it to OpsCenter as the destination target. Using this OpsItem, you can track details of the noncompliant resource, record investigative actions, and provide access to consistent remediation actions. Related info Configure EventBridge rules to create OpsItems Using AWS Systems Manager OpsCenter and AWS Config for compliance monitoring Understanding OpsCenter integration with AWS Security Hub AWS Security Hub collects security data, called findings, from across AWS accounts and services. Using a set of rules to detect and generate findings, Security Hub helps you identify, prioritize, and remediate security issues for the resources you manage. After you configure integration, as described in this topic, Systems Manager creates OpsItems for Security Hub findings in OpsCenter. Note OpsCenter has bidirectional integration with Security Hub. This means that if you update the Status or Severity field for an OpsItem related to a security finding, the system synchronizes the changes with Security Hub. Likewise, any changes to a finding are automatically updated in the corresponding OpsItems in OpsCenter. OpsCenter 2211 AWS Systems Manager User Guide When an OpsItem is created from a Security Hub finding, Security Hub metadata is automatically added to the operational data field of the OpsItem. If this metadata is deleted, the bidirectional updates no longer function. By default, Systems Manager creates OpsItems for critical and high severity findings. You can manually configure OpsCenter to create OpsItems for medium and low severity findings. OpsCenter doesn’t create OpsItems for informational findings as they don't require remediation. For more information about Security Hub severity levels, see Severity in the AWS Security Hub API Reference. Before you begin Before you configure OpsCenter to create OpsItems based on Security Hub findings, verify that you completed the Security Hub set up tasks. For more information, see Setting up Security Hub in the AWS Security Hub User Guide. When you integrate Security Hub with OpsCenter, the system creates OpsItems by using the AWSServiceRoleForSystemsManagerOpsDataSync IAM service-linked role. For more information about this role, see Using roles to create OpsData and OpsItems for Explorer. Warning Note the following important information about pricing for OpsCenter integration with Security Hub: • If you are logged into the Security Hub administrator account when you configure OpsCenter and Security Hub integration, the system creates OpsItems for findings in the administrator and all member accounts. The OpsItems are all created in the administrator account. Depending on a variety of factors, this can lead to an unexpectedly large bill from AWS. If you are logged into a member account when you configure integration, the system only creates OpsItems for findings in that individual account. For more information about the Security Hub administrator account, member accounts, and their relation to the EventBridge event feed for findings, see Types of Security Hub integration with EventBridge in the AWS Security Hub User Guide. OpsCenter 2212 AWS Systems Manager User Guide • For each finding that creates an OpsItem, you are charged the regular price for creating the OpsItem. You are also charged if you edit the OpsItem or if the corresponding finding is updated in Security Hub (which triggers an OpsItem update). • OpsItems that are created by an integration with AWS Security Hub are not currently limited by the maximum quota of 500,000 OpsItems per account in a
|
systems-manager-ug-640
|
systems-manager-ug.pdf
| 640 |
their relation to the EventBridge event feed for findings, see Types of Security Hub integration with EventBridge in the AWS Security Hub User Guide. OpsCenter 2212 AWS Systems Manager User Guide • For each finding that creates an OpsItem, you are charged the regular price for creating the OpsItem. You are also charged if you edit the OpsItem or if the corresponding finding is updated in Security Hub (which triggers an OpsItem update). • OpsItems that are created by an integration with AWS Security Hub are not currently limited by the maximum quota of 500,000 OpsItems per account in a Region. It is therefore possible for Security Hub alerts to create more than 500,000 chargeable OpsItems in each Region in an account. For high-production environments, we therefore recommend limiting the scope of Security Hub findings to high severity issues only. To configure OpsCenter to create OpsItems for Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose Settings. 4. In the Security Hub findings section, choose Edit. 5. Choose the slider to change Disabled to Enabled. 6. If you want the system to create OpsItems for medium or low severity findings, toggle these options. 7. Choose Save to save your configuration. Use the following procedure if you no longer want the system to create OpsItems for Security Hub findings. To stop receiving OpsItems for Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose Settings. 4. In the Security Hub findings section, choose Edit. OpsCenter 2213 AWS Systems Manager User Guide 5. Choose the slider to change Enabled to Disabled. If you aren't able to toggle the slider, Security Hub hasn't been enabled for your AWS account. 6. Choose Save to save your configuration. OpsCenter no longer creates OpsItems based on Security Hub findings. Important A Systems Manager delegated administrator or the AWS Organizations management account can enable Security Hub findings in OpsCenter for multiple accounts and AWS Regions by creating a resource data sync in Explorer. If the Security Hub source is enabled in Explorer and a resource data sync exists that targets the member account where you disabled Security Hub integration, then the settings selected by your administrator take precedence. OpsCenter continues to create OpsItems for Security Hub findings. To stop creating OpsItems for Security Hub findings in a member account targeted by a resource data sync, contact your administrator and ask them to remove your account from the resource data sync or turn off the Security Hub source in Explorer. For information about changing settings in Explorer, see Editing Systems Manager Explorer data sources. Understanding OpsCenter integration with Incident Manager Incident Manager, a tool in AWS Systems Manager, provides an incident management console that helps you mitigate and recover from incidents affecting your AWS hosted applications. An incident is any unplanned interruption or reduction in quality of services. After you set up and configure Incident Manager, the system automatically creates OpsItems in OpsCenter. When the system creates an incident in Incident Manager, it also creates an OpsItem in OpsCenter, and displays the incident as a related item. If the OpsItem already exists, Incident Manager doesn't create an OpsItem. The first OpsItem is known as the parent OpsItem. If an incident grows in scale and scope, you can add incidents to an existing OpsItem. If required, you can manually create an incident for an OpsItem. After an incident is closed, you can create an analysis in Incident Manager to review and improve the remediation process for similar issues. By default, OpsCenter integrates with Incident Manager. If Incident Manager is not set up, the OpsCenter page displays a message to set up Incident Manager. When Incident Manager creates an OpsItem, you can manage and remediate the OpsItem from OpsCenter. For instructions on creating an incident for an OpsItem, see Creating an incident for an OpsItem. OpsCenter 2214 AWS Systems Manager Create OpsItems User Guide After you set up OpsCenter, a tool in AWS Systems Manager, and integrate it with your AWS services, your AWS services automatically create OpsItems based on default rules, events, or alarms. You can view the statuses and severity levels of default Amazon EventBridge rules. If required, you can create or edit these rules from Amazon EventBridge. You can also view alarms from Amazon CloudWatch, and create or edit alarms. Using rules and alarms, you can configure events for which you want to generate OpsItems automatically. When the system creates an OpsItem, it's in the Open status. You can change the status to In progress when you start investigation of the OpsItem and to Resolved after you remediate the OpsItem. For more information about how to configure alarms and rules in AWS
|
systems-manager-ug-641
|
systems-manager-ug.pdf
| 641 |
You can view the statuses and severity levels of default Amazon EventBridge rules. If required, you can create or edit these rules from Amazon EventBridge. You can also view alarms from Amazon CloudWatch, and create or edit alarms. Using rules and alarms, you can configure events for which you want to generate OpsItems automatically. When the system creates an OpsItem, it's in the Open status. You can change the status to In progress when you start investigation of the OpsItem and to Resolved after you remediate the OpsItem. For more information about how to configure alarms and rules in AWS services to create OpsItems and how to create OpsItems manually, see the following topics. Topics • Configure EventBridge rules to create OpsItems • Configure CloudWatch alarms to create OpsItems • Create OpsItems manually Configure EventBridge rules to create OpsItems When Amazon EventBridge receives an event, it creates a new OpsItem based on default rules. You can create a rule or edit an existing rule to set OpsCenter as the target of an EventBridge event. For information about how to create an event rule, see Creating a rule for an AWS service in the Amazon EventBridge User Guide. To configure an EventBridge rule to create OpsItems in OpsCenter 1. Open the Amazon EventBridge console at https://console.aws.amazon.com/events/. 2. In the navigation pane, choose Rules. 3. On the Rules page, for Event bus, choose default. 4. 5. For Rules, choose a rule by selecting the check box next to its name. Select the name of the rule to open its details page. In Rule details, verify that Status is set to Enabled. OpsCenter 2215 AWS Systems Manager Note User Guide If required, you can update the status using Edit in the upper-right corner of the page. 6. Choose the Targets tab. 7. On the Targets tab, choose Edit. 8. 9. For Target types, select AWS service. For Select a target, choose Systems Manager OpsItem. 10. For many target types, EventBridge needs permission to send events to the target. In these cases, EventBridge can create the AWS Identity and Access Management (IAM) role needed for your rule to run: • To create an IAM role automatically, choose Create a new role for this specific resource. • To use an IAM role that you created to give EventBridge permission to create OpsItems in OpsCenter, choose Use existing role. 11. In Additional settings, for Configure target input, choose Input Transformer. You can use the Input transformer option to specify a deduplication string and other important information for OpsItems, such as title and severity. 12. Choose Configure input transformer. 13. In Target input transformer, for Input path, specify the values to parse from the triggering event. For example, to parse the start time, end time, and other details from the event that triggers the rule, use the following JSON. { "end-time": "$.detail.EndTime", "failure-cause": "$.detail.cause", "resources": "$.resources[0]", "source": "$.detail.source", "start-time": "$.detail.StartTime" } 14. For Template, specify the information to send to the target. For example, use the following JSON to pass information to OpsCenter. The information is used to create an OpsItem. OpsCenter 2216 AWS Systems Manager Note User Guide If the input template is in the JSON format, then the object value in the template can't include quotes. For example, the values for resources, failure-cause, source, start time, and end time can't be in quotes. { "title": "EBS snapshot copy failed", "description": "CloudWatch Event Rule SSMOpsItems-EBS-snapshot-copy-failed was triggered. Your EBS snapshot copy has failed. See below for more details.", "category": "Availability", "severity": "2", "source": "EC2", "operationalData": { "/aws/dedup": { "type": "SearchableString", "value": "{\"dedupString\":\"SSMOpsItems-EBS-snapshot-copy-failed\"}" }, "/aws/automations": { "value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CopySnapshot\" } ]" }, "failure-cause": { "value": <failure-cause> }, "source": { "value": <source> }, "start-time": { "value": <start-time> }, "end-time": { "value": <end-time> }, }, "resources": { "value": <resources> } } } OpsCenter 2217 AWS Systems Manager User Guide For more information about these fields, see Transforming target input in the Amazon EventBridge User Guide. 15. Choose Confirm. 16. Choose Next. 17. Choose Next. 18. Choose Update rule. After an OpsItem is created from an event, you can view the event details by opening the OpsItem and scrolling down to the Private operational data section. For information about how to configure the options in an OpsItem, see Manage OpsItems. Configure CloudWatch alarms to create OpsItems During the integrated setup of OpsCenter, a tool in AWS Systems Manager, you enable Amazon CloudWatch to automatically create OpsItems based on common alarms. You can create an alarm or edit an existing alarm to create OpsItems in OpsCenter. CloudWatch creates a new service-linked role in AWS Identity and Access Management (IAM) when you configure an alarm to create OpsItems. The new role is named AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information about CloudWatch service-linked roles, see Using service-linked roles for CloudWatch in
|
systems-manager-ug-642
|
systems-manager-ug.pdf
| 642 |
For information about how to configure the options in an OpsItem, see Manage OpsItems. Configure CloudWatch alarms to create OpsItems During the integrated setup of OpsCenter, a tool in AWS Systems Manager, you enable Amazon CloudWatch to automatically create OpsItems based on common alarms. You can create an alarm or edit an existing alarm to create OpsItems in OpsCenter. CloudWatch creates a new service-linked role in AWS Identity and Access Management (IAM) when you configure an alarm to create OpsItems. The new role is named AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information about CloudWatch service-linked roles, see Using service-linked roles for CloudWatch in the Amazon CloudWatch User Guide. When a CloudWatch alarm generates an OpsItem, the OpsItem displays CloudWatch alarm - 'alarm_name' is in ALARM state. To view details about a specific OpsItem, choose the OpsItem and then choose the Related resource details tab. You can manually edit OpsItems to change details, such as the severity or category. However, when you edit the severity or the category of an alarm, Systems Manager can't update the severity or category of OpsItems that are already created from the alarm. If an alarm created an OpsItem and if you specified a deduplication string, the alarm won't create additional OpsItems even if you edit the alarm in CloudWatch. If the OpsItem is resolved in OpsCenter, CloudWatch will create a new OpsItem. For more information about configuring CloudWatch alarms, see the following topics. Topics OpsCenter 2218 AWS Systems Manager User Guide • Configuring a CloudWatch alarm to create OpsItems (console) • Configuring an existing CloudWatch alarm to create OpsItems (programmatically) Configuring a CloudWatch alarm to create OpsItems (console) You can manually create an alarm or update an existing alarm to create OpsItems from Amazon CloudWatch. To create a CloudWatch alarm and configure Systems Manager as a target of that alarm 1. Complete steps 1–9 as specified in Create a CloudWatch alarm based on a static threshold in the Amazon CloudWatch User Guide. 2. In the Systems Manager action section, choose Add Systems Manager OpsCenter action. 3. Choose OpsItems. 4. 5. For Severity, choose from 1 to 4. (Optional) For Category, choose a category for the OpsItem. 6. Complete steps 11–13 as specified in Create a CloudWatch alarm based on a static threshold in the Amazon CloudWatch User Guide. 7. Choose Next and complete the wizard. To edit an existing alarm and configure Systems Manager as a target of that alarm 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. 3. 4. 5. 6. In the navigation pane, choose Alarms. Select the alarm, and then choose Actions, Edit. (Optional) Change settings in the Metrics and Conditions sections, and then choose Next. In the Systems Manager section, choose Add Systems Manager OpsCenter action. For Severity, choose a number. Note Severity is a user-defined value. You or your organization determine what each severity value means and any service-level agreement associated with each severity. 7. (Optional) For Category, choose an option. OpsCenter 2219 AWS Systems Manager User Guide 8. Choose Next and complete the wizard. Configuring an existing CloudWatch alarm to create OpsItems (programmatically) You can configure Amazon CloudWatch alarms to create OpsItems programmatically by using the AWS Command Line Interface (AWS CLI), AWS CloudFormation templates, or Java code snippets. Topics • Before you begin • Configuring CloudWatch alarms to create OpsItems (AWS CLI) • Configuring CloudWatch alarms to create or update OpsItems (CloudFormation) • Configuring CloudWatch alarms to create or update OpsItems (Java) Before you begin If you edit an existing alarm programmatically or create an alarm that creates OpsItems, you must specify an Amazon Resource Name (ARN). This ARN identifies Systems Manager OpsCenter as the target for OpsItems created from the alarm. You can customize the ARN so that OpsItems created from the alarm include specific information such as severity or category. Each ARN includes the information described in the following table. Parameter Region (required) account_ID (required) severity (required) Details The AWS Region where the alarm exists. For example: us-west-2 . For information about AWS Regions where you can use OpsCenter , see AWS Systems Manager endpoints and quotas. The same AWS account ID used to create the alarm. For example: 123456789012 . The account ID must be followed by a colon (:) and the parameter opsitem as shown in the following examples. A user-defined severity level for OpsItems created from the alarm. Valid values: 1, 2, 3, 4 OpsCenter 2220 AWS Systems Manager Parameter Category(optional) User Guide Details A category for OpsItems created from the alarm. Valid values: Availability , Cost, Performance , Recovery, and Security. Create the ARN by using the following syntax. This ARN doesn't include the optional Category parameter. arn:aws:ssm:Region:account_ID:opsitem:severity Following is an example. arn:aws:ssm:us-west-2:123456789012:opsitem:3 To create an ARN that uses the optional Category parameter, use the following syntax. arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name Following is an example. arn:aws:ssm:us-west-2:123456789012:opsitem:3#CATEGORY=Security Configuring CloudWatch
|
systems-manager-ug-643
|
systems-manager-ug.pdf
| 643 |
colon (:) and the parameter opsitem as shown in the following examples. A user-defined severity level for OpsItems created from the alarm. Valid values: 1, 2, 3, 4 OpsCenter 2220 AWS Systems Manager Parameter Category(optional) User Guide Details A category for OpsItems created from the alarm. Valid values: Availability , Cost, Performance , Recovery, and Security. Create the ARN by using the following syntax. This ARN doesn't include the optional Category parameter. arn:aws:ssm:Region:account_ID:opsitem:severity Following is an example. arn:aws:ssm:us-west-2:123456789012:opsitem:3 To create an ARN that uses the optional Category parameter, use the following syntax. arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name Following is an example. arn:aws:ssm:us-west-2:123456789012:opsitem:3#CATEGORY=Security Configuring CloudWatch alarms to create OpsItems (AWS CLI) This command requires that you specify an ARN for the alarm-actions parameter. For information about how to create the ARN, see Before you begin. To configure a CloudWatch alarm to create OpsItems (AWS CLI) 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command to collect information about the alarm that you want to configure. aws cloudwatch describe-alarms --alarm-names "alarm name" OpsCenter 2221 AWS Systems Manager User Guide 3. Run the following command to update an alarm. Replace each example resource placeholder with your own information. aws cloudwatch put-metric-alarm --alarm-name name \ --alarm-description "description" \ --metric-name name --namespace namespace \ --statistic statistic --period value --threshold value \ --comparison-operator value \ --dimensions "dimensions" --evaluation-periods value \ --alarm-actions arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name \ --unit unit Here's an example. Linux & macOS aws cloudwatch put-metric-alarm --alarm-name cpu-mon \ --alarm-description "Alarm when CPU exceeds 70 percent" \ --metric-name CPUUtilization --namespace AWS/EC2 \ --statistic Average --period 300 --threshold 70 \ --comparison-operator GreaterThanThreshold \ --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 \ --alarm-actions arn:aws:ssm:us-east-1:123456789012:opsitem:3#CATEGORY=Security \ --unit Percent Windows aws cloudwatch put-metric-alarm --alarm-name cpu-mon ^ --alarm-description "Alarm when CPU exceeds 70 percent" ^ --metric-name CPUUtilization --namespace AWS/EC2 ^ --statistic Average --period 300 --threshold 70 ^ --comparison-operator GreaterThanThreshold ^ --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 ^ --alarm-actions arn:aws:ssm:us-east-1:123456789012:opsitem:3#CATEGORY=Security ^ --unit Percent OpsCenter 2222 AWS Systems Manager User Guide Configuring CloudWatch alarms to create or update OpsItems (CloudFormation) This section includes AWS CloudFormation templates that you can use to configure CloudWatch alarms to automatically create or update OpsItems. Each template requires that you specify an ARN for the AlarmActions parameter. For information about how to create the ARN, see Before you begin. Metric alarm – Use the following CloudFormation template to create or update a CloudWatch metric alarm. The alarm specified in this template monitors Amazon Elastic Compute Cloud (Amazon EC2) instance status checks. If the alarm enters the ALARM state, it creates an OpsItem in OpsCenter. { "AWSTemplateFormatVersion": "2010-09-09", "Parameters" : { "RecoveryInstance" : { "Description" : "The EC2 instance ID to associate this alarm with.", "Type" : "AWS::EC2::Instance::Id" } }, "Resources": { "RecoveryTestAlarm": { "Type": "AWS::CloudWatch::Alarm", "Properties": { "AlarmDescription": "Run a recovery action when instance status check fails for 15 consecutive minutes.", "Namespace": "AWS/EC2" , "MetricName": "StatusCheckFailed_System", "Statistic": "Minimum", "Period": "60", "EvaluationPeriods": "15", "ComparisonOperator": "GreaterThanThreshold", "Threshold": "0", "AlarmActions": [ {"Fn::Join" : ["", ["arn:arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name", { "Ref" : "AWS::Partition" }, ":ssm:", { "Ref" : "AWS::Region" }, { "Ref" : "AWS:: AccountId" }, ":opsitem:3" ]]} ], "Dimensions": [{"Name": "InstanceId","Value": {"Ref": "RecoveryInstance"}}] } } } } OpsCenter 2223 AWS Systems Manager User Guide Composite alarm – Use the following CloudFormation template to create or update a composite alarm. A composite alarm consists of multiple metric alarms. If the alarm enters the ALARM state, it creates an OpsItem in OpsCenter. "Resources":{ "HighResourceUsage":{ "Type":"AWS::CloudWatch::CompositeAlarm", "Properties":{ "AlarmName":"HighResourceUsage", "AlarmRule":"(ALARM(HighCPUUsage) OR ALARM(HighMemoryUsage)) AND NOT ALARM(DeploymentInProgress)", "AlarmActions":"arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name", "AlarmDescription":"Indicates that the system resource usage is high while no known deployment is in progress" }, "DependsOn":[ "DeploymentInProgress", "HighCPUUsage", "HighMemoryUsage" ] }, "DeploymentInProgress":{ "Type":"AWS::CloudWatch::CompositeAlarm", "Properties":{ "AlarmName":"DeploymentInProgress", "AlarmRule":"FALSE", "AlarmDescription":"Manually updated to TRUE/FALSE to disable other alarms" } }, "HighCPUUsage":{ "Type":"AWS::CloudWatch::Alarm", "Properties":{ "AlarmDescription":"CPUusageishigh", "AlarmName":"HighCPUUsage", "ComparisonOperator":"GreaterThanThreshold", "EvaluationPeriods":1, "MetricName":"CPUUsage", "Namespace":"CustomNamespace", "Period":60, "Statistic":"Average", "Threshold":70, OpsCenter 2224 AWS Systems Manager User Guide "TreatMissingData":"notBreaching" } }, "HighMemoryUsage":{ "Type":"AWS::CloudWatch::Alarm", "Properties":{ "AlarmDescription":"Memoryusageishigh", "AlarmName":"HighMemoryUsage", "ComparisonOperator":"GreaterThanThreshold", "EvaluationPeriods":1, "MetricName":"MemoryUsage", "Namespace":"CustomNamespace", "Period":60, "Statistic":"Average", "Threshold":65, "TreatMissingData":"breaching" } } } Configuring CloudWatch alarms to create or update OpsItems (Java) This section includes Java code snippets that you can use to configure CloudWatch alarms to automatically create or update OpsItems. Each snippet requires that you specify an ARN for the validSsmActionStr parameter. For information about how to create the ARN, see Before you begin. A specific alarm – Use the following Java code snippet to create or update a CloudWatch alarm. The alarm specified in this template monitors Amazon EC2 instance status checks. If the alarm enters the ALARM state, it creates an OpsItem in OpsCenter. import com.amazonaws.services.cloudwatch.AmazonCloudWatch; import com.amazonaws.services.cloudwatch.AmazonCloudWatchClientBuilder; import com.amazonaws.services.cloudwatch.model.ComparisonOperator; import com.amazonaws.services.cloudwatch.model.Dimension; import com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest; import com.amazonaws.services.cloudwatch.model.PutMetricAlarmResult; import com.amazonaws.services.cloudwatch.model.StandardUnit; import com.amazonaws.services.cloudwatch.model.Statistic; private void putMetricAlarmWithSsmAction() { final AmazonCloudWatch cw = AmazonCloudWatchClientBuilder.defaultClient(); OpsCenter 2225 AWS Systems Manager User Guide Dimension dimension = new Dimension() .withName("InstanceId") .withValue(instanceId);
|
systems-manager-ug-644
|
systems-manager-ug.pdf
| 644 |
specify an ARN for the validSsmActionStr parameter. For information about how to create the ARN, see Before you begin. A specific alarm – Use the following Java code snippet to create or update a CloudWatch alarm. The alarm specified in this template monitors Amazon EC2 instance status checks. If the alarm enters the ALARM state, it creates an OpsItem in OpsCenter. import com.amazonaws.services.cloudwatch.AmazonCloudWatch; import com.amazonaws.services.cloudwatch.AmazonCloudWatchClientBuilder; import com.amazonaws.services.cloudwatch.model.ComparisonOperator; import com.amazonaws.services.cloudwatch.model.Dimension; import com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest; import com.amazonaws.services.cloudwatch.model.PutMetricAlarmResult; import com.amazonaws.services.cloudwatch.model.StandardUnit; import com.amazonaws.services.cloudwatch.model.Statistic; private void putMetricAlarmWithSsmAction() { final AmazonCloudWatch cw = AmazonCloudWatchClientBuilder.defaultClient(); OpsCenter 2225 AWS Systems Manager User Guide Dimension dimension = new Dimension() .withName("InstanceId") .withValue(instanceId); String validSsmActionStr = "arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name"; PutMetricAlarmRequest request = new PutMetricAlarmRequest() .withAlarmName(alarmName) .withComparisonOperator( ComparisonOperator.GreaterThanThreshold) .withEvaluationPeriods(1) .withMetricName("CPUUtilization") .withNamespace("AWS/EC2") .withPeriod(60) .withStatistic(Statistic.Average) .withThreshold(70.0) .withActionsEnabled(false) .withAlarmDescription( "Alarm when server CPU utilization exceeds 70%") .withUnit(StandardUnit.Seconds) .withDimensions(dimension) .withAlarmActions(validSsmActionStr); PutMetricAlarmResult response = cw.putMetricAlarm(request); } Update all alarms – Use the following Java code snippet to update all CloudWatch alarms in your AWS account to create OpsItems when an alarm enters the ALARM state. import com.amazonaws.services.cloudwatch.AmazonCloudWatch; import com.amazonaws.services.cloudwatch.AmazonCloudWatchClientBuilder; import com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest; import com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult; import com.amazonaws.services.cloudwatch.model.MetricAlarm; private void listMetricAlarmsAndAddSsmAction() { final AmazonCloudWatch cw = AmazonCloudWatchClientBuilder.defaultClient(); boolean done = false; DescribeAlarmsRequest request = new DescribeAlarmsRequest(); OpsCenter 2226 AWS Systems Manager User Guide String validSsmActionStr = "arn:aws:ssm:Region:account_ID:opsitem:severity#CATEGORY=category_name"; while(!done) { DescribeAlarmsResult response = cw.describeAlarms(request); for(MetricAlarm alarm : response.getMetricAlarms()) { // assuming there are no alarm actions added for the metric alarm alarm.setAlarmActions(ImmutableList.of(validSsmActionStr)); } request.setNextToken(response.getNextToken()); if(response.getNextToken() == null) { done = true; } } } Create OpsItems manually When you find an operational issue, you can manually create an OpsItem from OpsCenter, a tool in AWS Systems Manager, to manage and resolve the issue. If you set up OpsCenter for cross-account administration, a Systems Manager delegated administrator or AWS Organizations management account can create OpsItems for member accounts. For more information, see (Optional) Manually set up OpsCenter to centrally manage OpsItems across accounts. You can create OpsItems by using the AWS Systems Manager console, the AWS Command Line Interface (AWS CLI), or AWS Tools for Windows PowerShell. Topics • Creating OpsItems manually (console) • Creating OpsItems manually (AWS CLI) • Creating OpsItems manually (PowerShell) OpsCenter 2227 AWS Systems Manager User Guide Creating OpsItems manually (console) You can manually create OpsItems using the AWS Systems Manager console. When you create an OpsItem, it's displayed in your OpsCenter account. If you set up OpsCenter for cross-account administration, OpsCenter provides the delegated administrator or management account with the option to create OpsItems for selected member accounts. For more information, see (Optional) Manually set up OpsCenter to centrally manage OpsItems across accounts. To create an OpsItem using the AWS Systems Manager console 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose Create OpsItem. If you don't see this button, choose the OpsItems tab, and then choose Create OpsItem. 4. (Optional) Choose Other account, and then choose the account where you want to create the OpsItem. Note This step is required if you're creating OpsItems for a member account. For Title, enter a descriptive name to help you understand the purpose of the OpsItem. For Source, enter the type of impacted AWS resource or other source information to help users understand the origin of the OpsItem. Note You can't edit the Source field after you create the OpsItem. (Optional) For Priority, choose the priority level. (Optional) For Severity, choose the severity level. (Optional) For Category, choose a category. 5. 6. 7. 8. 9. 10. For Description, enter information about this OpsItem including (if applicable) steps for reproducing the issue. OpsCenter 2228 AWS Systems Manager Note User Guide The console supports most markdown formatting in the OpsItem description field. For more information, see Using Markdown in the Console in the Getting Started with the AWS Management Console Getting Started Guide. 11. For Deduplication string, enter words that the system can use to check for duplicate OpsItems. For more information about deduplication strings, see Managing duplicate OpsItems. 12. (Optional) For Notifications, specify the Amazon Resource Name (ARN) of the Amazon SNS topic where you want notifications sent when this OpsItem is updated. You must specify an Amazon SNS ARN that is in the same AWS Region as the OpsItem. 13. (Optional) For Related resources, choose Add to specify the ID or ARN of the impacted resource and any related resources. 14. Choose Create OpsItem. If successful, the page displays the OpsItem. When a delegated administrator or management account creates an OpsItem for selected member accounts, the new OpsItems are displayed in the OpsCenter of the administrator and members accounts. For information about how to configure the options in an OpsItem, see Manage OpsItems. Creating OpsItems manually (AWS CLI) The following procedure describes how to create an OpsItem by using the AWS Command Line Interface (AWS CLI). To create an OpsItem using the AWS
|
systems-manager-ug-645
|
systems-manager-ug.pdf
| 645 |
resources, choose Add to specify the ID or ARN of the impacted resource and any related resources. 14. Choose Create OpsItem. If successful, the page displays the OpsItem. When a delegated administrator or management account creates an OpsItem for selected member accounts, the new OpsItems are displayed in the OpsCenter of the administrator and members accounts. For information about how to configure the options in an OpsItem, see Manage OpsItems. Creating OpsItems manually (AWS CLI) The following procedure describes how to create an OpsItem by using the AWS Command Line Interface (AWS CLI). To create an OpsItem using the AWS CLI 1. Install and configure the AWS Command Line Interface (AWS CLI), if you haven't already. For information, see Installing or updating the latest version of the AWS CLI. 2. Open the AWS CLI and run the following command to create an OpsItem. Replace each example resource placeholder with your own information. aws ssm create-ops-item \ --title "Descriptive_title" \ --description "Information_about_the_issue" \ OpsCenter 2229 AWS Systems Manager User Guide --priority Number_between_1_and_5 \ --source Source_of_the_issue \ --operational-data Up_to_20_KB_of_data_or_path_to_JSON_file \ --notifications Arn="SNS_ARN_in_same_Region" \ --tags "Key=key_name,Value=a_value" Specify operational data from a file When you create an OpsItem, you can specify operational data from a file. The file must be a JSON file, and the contents of the file must use the following format. { "key_name": { "Type": "SearchableString", "Value": "Up to 20 KB of data" } } Here is an example. aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data file:///Users/TestUser1/Desktop/OpsItems/opsData.json ^ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" ^ --tags "Key=EC2,Value=Production" Note For information about how to enter JSON-formatted parameters on the command line on different local operating systems, see Using quotation marks with strings in the AWS CLI in the AWS Command Line Interface User Guide. The system returns information like the following. { "OpsItemId": "oi-1a2b3c4d5e6f" OpsCenter 2230 AWS Systems Manager } User Guide 3. Run the following command to view details about the OpsItem that you created. aws ssm get-ops-item --ops-item-id ID The system returns information like the following. { "OpsItem": { "CreatedBy": "arn:aws:iam::12345678:user/TestUser", "CreatedTime": 1558386334.995, "Description": "Log clean up may have failed which caused the disk to be full", "LastModifiedBy": "arn:aws:iam::12345678:user/TestUser", "LastModifiedTime": 1558386334.995, "Notifications": [ { "Arn": "arn:aws:sns:us-west-1:12345678:TestUser" } ], "Priority": 2, "RelatedOpsItems": [], "Status": "Open", "OpsItemId": "oi-1a2b3c4d5e6f", "Title": "EC2 instance disk full", "Source": "ec2", "OperationalData": { "EC2": { "Value": "12345", "Type": "SearchableString" } } } } 4. Run the following command to update the OpsItem. This command changes the status from Open (the default) to InProgress. aws ssm update-ops-item --ops-item-id ID --status InProgress The command has no output. OpsCenter 2231 AWS Systems Manager User Guide 5. Run the following command again to verify that the status changed to InProgress. aws ssm get-ops-item --ops-item-id ID Examples of creating an OpsItem The following code examples show you how to create an OpsItem by using the Linux management portal, macOS, or Windows. Linux management portal or macOS The following command creates an OpsItem when an Amazon Elastic Compute Cloud (Amazon EC2) instance disk is full. aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"EC2":{"Value":"12345","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" \ --tags "Key=EC2,Value=ProductionServers" The following command uses the /aws/resources key in OperationalData to create an OpsItem with an Amazon DynamoDB related resource. aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/resources":{"Value":"[{\"arn\": \"arn:aws:dynamodb:us- west-2:12345678:table/OpsItems\"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser" The following command uses the /aws/automations key in OperationalData to create an OpsItem that specifies the AWS-ASGEnterStandby document as an associated Automation runbook. aws ssm create-ops-item \ OpsCenter 2232 AWS Systems Manager User Guide --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/automations":{"Value":"[{\"automationId \": \"AWS-ASGEnterStandby\", \"automationType\": \"AWS::SSM::Automation \"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser" Windows The following command creates an OpsItem when an Amazon Relational Database Service (Amazon RDS) instance is not responding. aws ssm create-ops-item ^ --title "RDS instance not responding" ^ --description "RDS instance not responding to ping" ^ --priority 1 ^ --source RDS ^ --operational-data={\"RDS\":{\"Value\":\"abcd\",\"Type\":\"SearchableString\"}} ^ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" ^ --tags "Key=RDS,Value=ProductionServers" The following command uses the /aws/resources key in OperationalData to create an OpsItem with an Amazon EC2 instance related resource. aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data={\"/aws/resources\":{\"Value\":\"[{\\"""arn\\""":\ \"""arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0\\"""}]\",\"Type\": \"SearchableString\"}} The following command uses the /aws/automations key
|
systems-manager-ug-646
|
systems-manager-ug.pdf
| 646 |
Database Service (Amazon RDS) instance is not responding. aws ssm create-ops-item ^ --title "RDS instance not responding" ^ --description "RDS instance not responding to ping" ^ --priority 1 ^ --source RDS ^ --operational-data={\"RDS\":{\"Value\":\"abcd\",\"Type\":\"SearchableString\"}} ^ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" ^ --tags "Key=RDS,Value=ProductionServers" The following command uses the /aws/resources key in OperationalData to create an OpsItem with an Amazon EC2 instance related resource. aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data={\"/aws/resources\":{\"Value\":\"[{\\"""arn\\""":\ \"""arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0\\"""}]\",\"Type\": \"SearchableString\"}} The following command uses the /aws/automations key in OperationalData to create an OpsItem that specifies the AWS-RestartEC2Instance runbook as an associated Automation runbook. aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ OpsCenter 2233 AWS Systems Manager User Guide --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data={\"/aws/automations\":{\"Value\":\"[{\\"""automationId\\""": \\"""AWS-RestartEC2Instance\\”"",\\"""automationType\\""":\\"""AWS::SSM::Automation\ \"""}]\",\"Type\":\"SearchableString\"}} Creating OpsItems manually (PowerShell) The following procedure describes how to create an OpsItem by using AWS Tools for Windows PowerShell. To create an OpsItem using AWS Tools for Windows PowerShell 1. Open AWS Tools for Windows PowerShell and run the following command to specify your credentials. Set-AWSCredentials –AccessKey key-name –SecretKey key-name 2. Run the following command to set the AWS Region for your PowerShell session. Set-DefaultAWSRegion -Region Region 3. Run the following command to create a new OpsItem. Replace each example resource placeholder with your own information. This command specifies a Systems Manager Automation runbook for remediating this OpsItem. $opsItem = New-Object Amazon.SimpleSystemsManagement.Model.OpsItemDataValue $opsItem.Type = [Amazon.SimpleSystemsManagement.OpsItemDataType]::SearchableString $opsItem.Value = '[{\"automationId\":\"runbook_name\",\"automationType\": \"AWS::SSM::Automation\"}]' $newHash = @{" /aws/ automations"=[Amazon.SimpleSystemsManagement.Model.OpsItemDataValue]$opsItem} New-SSMOpsItem ` -Title "title" ` -Description "description" ` -Priority priority_number ` -Source AWS_service ` -OperationalData $newHash If successful, the command outputs the ID of the new OpsItem. OpsCenter 2234 AWS Systems Manager User Guide The following example specifies the Amazon Resource Name (ARN) of an impaired Amazon Elastic Compute Cloud (Amazon EC2) instance. $opsItem = New-Object Amazon.SimpleSystemsManagement.Model.OpsItemDataValue $opsItem.Type = [Amazon.SimpleSystemsManagement.OpsItemDataType]::SearchableString $opsItem.Value = '[{\"arn\":\"arn:aws:ec2:us-east-1:123456789012:instance/ i-1234567890abcdef0\"}]' $newHash = @{" /aws/ resources"=[Amazon.SimpleSystemsManagement.Model.OpsItemDataValue]$opsItem} New-SSMOpsItem -Title "EC2 instance disk full still" -Description "Log clean up may have failed which caused the disk to be full" -Priority 2 -Source ec2 -OperationalData $newHash Manage OpsItems OpsCenter, a tool in AWS Systems Manager, tracks OpsItems from their creation to resolution. If you set up OpsCenter for cross-account administration, a delegated administrator or management account can manage OpsItems from their account. For more information, see (Optional) Manually set up OpsCenter to centrally manage OpsItems across accounts. You can view and manage OpsItems by using the following pages in the Systems Manager console: • Summary – Displays a count of open and in-progress OpsItems, count of OpsItems by source and age, and operational insights. You can filter OpsItems by source and OpsItems status. • OpsItems – Displays a list of OpsItems with multiple fields of information, such as title, ID, priority, description, the source of the OpsItem, and the date and time of last update. Using this page, you can manually create OpsItems, configure sources, change the status of an OpsItem, and filter OpsItems by new incidents. You can choose an OpsItem to display its OpsItems details page. • OpsItem details – Provides detailed insights and tools that you can use to manage an OpsItem. The OpsItems details page has the following tabs: • Overview – Displays related resources, runbooks that ran in the last 30 days, and a list of available runbooks that you can run. You can also view similar OpsItems, add operational data, and add related OpsItems. • Related resource details – Displays information about the resource from several AWS services. Expand the Resource details section to view information about this resource as provided by OpsCenter 2235 AWS Systems Manager User Guide the AWS service that hosts it. You can also toggle through other related resources associated with this OpsItem by using the Related resources list. For more information about how to manage OpsItems, see the following topics. Topics • Viewing details of an OpsItem • Editing an OpsItem • Adding related resources to an OpsItem • Adding related OpsItems to an OpsItem • Adding operational data to an OpsItem • Creating an incident for an OpsItem • Managing duplicate OpsItems • Analyzing operational insights to reduce OpsItems • Viewing OpsCenter logs and reports Viewing details of an OpsItem To get a comprehensive view of an OpsItem, use the OpsItem details page in the OpsCenter console. The Overview page displays the following information: • OpsItems details– Displays general information for the selected OpsItem. • Related Resources – A related resource is the impacted resource or the resource that initiated the event that created the OpsItem. • Automation executions in the last 30 days – A list of runbooks that ran in last 30 days. •
|
systems-manager-ug-647
|
systems-manager-ug.pdf
| 647 |
an OpsItem • Managing duplicate OpsItems • Analyzing operational insights to reduce OpsItems • Viewing OpsCenter logs and reports Viewing details of an OpsItem To get a comprehensive view of an OpsItem, use the OpsItem details page in the OpsCenter console. The Overview page displays the following information: • OpsItems details– Displays general information for the selected OpsItem. • Related Resources – A related resource is the impacted resource or the resource that initiated the event that created the OpsItem. • Automation executions in the last 30 days – A list of runbooks that ran in last 30 days. • Runbooks – You can choose a runbook from a list of available runbooks. • Similar OpsItems – This is a system-generated list of OpsItems that might be related or of interest to you. To generate the list, the system scans the titles and descriptions of all OpsItems and returns OpsItems that use similar words. • Operational data – Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. • Related OpsItems – You can specify the IDs of OpsItems that are in some way related to the current OpsItem. OpsCenter 2236 AWS Systems Manager User Guide • Related Resource Details – Displays data providers, including Amazon CloudWatch metrics and alarms, AWS CloudTrail logs, and details from AWS Config. To view details of an OpsItem 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose an OpsItem to view its details. Editing an OpsItem The OpsItem details section includes information about an OpsItem, including the description, title, source, OpsItem ID, and the status. You can edit a single OpsItem or you can select multiple OpsItems and edit the following fields: Status, Priority, Severity, Category. When Amazon EventBridge creates an OpsItem, it populates the Title, Source, and Description fields. You can edit the Title and Description fields, but you can't edit the Source field. Note The console supports most markdown formatting in the OpsItem description field. For more information, see Using Markdown in the Console in the Getting Started with the AWS Management Console Getting Started Guide. Generally, you can edit the following configurable data for an OpsItem: • Title – Name of the OpsItem. The source creates the title of the OpsItem. • Description – Information about this OpsItem including (if applicable) steps for reproducing the issue. • Status – Status of an OpsItem. For a list of valid status values, see OpsItem Status in the AWS Systems Manager API Reference. OpsCenter 2237 AWS Systems Manager User Guide • Priority – Priority of an OpsItem can be between 1 and 5. We recommend that your organization determine what each priority level means and a corresponding service level agreement for each level. • Severity – Severity of an OpsItem can be between 1 to 4, where 1 is critical, 2 is high, 3 is medium, and 4 is low. • Category – Category of an OpsItem can be availability, cost, performance, recovery, or security. • Notifications – When you edit an OpsItem, you can specify the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic in the Notifications field. By specifying an ARN, you ensure that all stakeholders receive a notification when the OpsItem is edited, including a status change. For more information, see the Amazon Simple Notification Service Developer Guide. Important The Amazon SNS topic must exist in the same AWS Region as the OpsItem. If the topic and the OpsItem are in different Regions, the system returns an error. OpsCenter has bidirectional integration with AWS Security Hub. When you update an OpsItem status and severity related to a security finding, those changes are automatically sent to Security Hub to ensure you always see the latest and correct information. When an OpsItem is created from a Security Hub finding, Security Hub metadata is automatically added to the operational data field of the OpsItem. If this metadata is deleted, the bidirectional updates no longer function. To edit OpsItem details 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose an OpsItem ID to open the details page or choose multiple OpsItems. If you choose multiple OpsItems, you can only edit the status, priority, severity, or category. If you edit multiple OpsItems, OpsCenter updates and saves your changes as soon as you choose the new status, priority, severity, or category. In the OpsItem details section, choose Edit. Edit the details of the OpsItem according to the requirements and guidelines specified by your 4. 5. organization. OpsCenter 2238 AWS Systems Manager User Guide 6. When you're finished, choose Save. Adding related resources to an
|
systems-manager-ug-648
|
systems-manager-ug.pdf
| 648 |
the navigation pane, choose OpsCenter. 3. Choose an OpsItem ID to open the details page or choose multiple OpsItems. If you choose multiple OpsItems, you can only edit the status, priority, severity, or category. If you edit multiple OpsItems, OpsCenter updates and saves your changes as soon as you choose the new status, priority, severity, or category. In the OpsItem details section, choose Edit. Edit the details of the OpsItem according to the requirements and guidelines specified by your 4. 5. organization. OpsCenter 2238 AWS Systems Manager User Guide 6. When you're finished, choose Save. Adding related resources to an OpsItem Each OpsItem includes a Related resources section that lists the Amazon Resource Name (ARN) of the related resource. A related resource is the impacted AWS resource that needs to be investigated. If Amazon EventBridge creates the OpsItem, the system automatically populates the OpsItem with the ARN of the resource. You can manually specify ARNs of related resources. For certain ARN types, OpsCenter automatically creates a deep link that displays details about the resource directly in the OpsCenter console. For example, if you specify the ARN of an Amazon Elastic Compute Cloud (Amazon EC2) instance as a related resource, then OpsCenter pulls in details about that EC2 instance. This allows you to view detailed information about your impacted AWS resources without having to leave OpsCenter. To view and add related resources to an OpsItem 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose the OpsItems tab. 4. Choose an OpsItem ID. 5. To view information about the impacted resource, choose the Related resources details tab. OpsCenter 2239 AWS Systems Manager User Guide This tab displays information about the resource from several AWS services. Expand the Resource details section to view information about this resource as provided by the AWS service that hosts it. You can also toggle through other related resources associated with this OpsItem by using the Related resources list. 6. 7. 8. 9. To add additional related resources, choose the Overview tab. In the Related resources section, choose Add. For Resource type, choose a resource from the list. For Resource ID, enter either the ID or the Amazon Resource Name (ARN). The type of information you choose depends on the resource that you chose in the previous step. Note You can manually add the ARNs of additional related resources. Each OpsItem can list a maximum of 100 related resource ARNs. The following table lists the resource types that automatically create deep links to related resources. OpsCenter 2240 AWS Systems Manager Supported resource types User Guide Resource name ARN format AWS Certificate Manager certificate arn:aws:acm: region:account-i d :certificate/ certificate-id Amazon EC2 Auto Scaling group arn:aws:autoscaling: d :autoScalingGroup: region:account-i groupid:autoScal ingGroupName/ groupfriendlyname Amazon CloudFront distribution arn:aws:cloudfront:: account-id :* AWS CloudFormation stack Amazon CloudWatch alarm AWS CloudTrail trail AWS CodeBuild project AWS CodePipeline Amazon DevOps Guru insight arn:aws:cloudforma tion: region:account-i d :stack/stackname /additionalidentifi er arn:aws:cloudwatch: d :alarm:alarm-name region:account-i arn:aws:cloudtrail: d :trail/trailname region:account-i arn:aws:codebuild: d :resourcetype /resource region:account-i arn:aws:codepipeline: d :resource-specifier region:account-i arn:aws:devops-guru: id :insight/ proactive or region:account- reactive/resource-id OpsCenter 2241 AWS Systems Manager Resource name Amazon DynamoDB table User Guide ARN format arn:aws:dynamodb: region:account-i d :table/tablename Amazon Elastic Compute Cloud (Amazon EC2) customer gateway arn:aws:ec2: region:account-i d :customer-gateway/ cgw-id Amazon EC2 elastic IP Amazon EC2 Dedicated Host Amazon EC2 instance Amazon EC2 internet gateway arn:aws:ec2: region:account-i d :eip/eipalloc-id arn:aws:ec2: region:account-i d :dedicated-host/ host-id arn:aws:ec2: region:account-i d :instance/ instance-id arn:aws:ec2: region:account-i d :internet-gateway/ igw-id Amazon EC2 network access control list (network ACL) arn:aws:ec2: region:account-i d :network-acl/ nacl-id Amazon EC2 network interface arn:aws:ec2: region:account-i d :network-interface/ eni-id Amazon EC2 route table Amazon EC2 security group arn:aws:ec2: region:account-id :route- table/ route-table-id arn:aws:ec2: region:account-i d :security-group/ security-group-id OpsCenter 2242 AWS Systems Manager Resource name Amazon EC2 subnet Amazon EC2 volume Amazon EC2 VPC Amazon EC2 VPN connection Amazon EC2 VPN gateway AWS Elastic Beanstalk application Elastic Load Balancing (Classic Load Balancer) Elastic Load Balancing (Application Load Balancer) Elastic Load Balancing (Network Load Balancer) User Guide ARN format arn:aws:ec2: region:account-i d :subnet/subnet-id arn:aws:ec2: region:account-i d :volume/volume-id arn:aws:ec2: region:account-i d :vpc/vpc-id arn:aws:ec2: region:account-id :vpn- connection/ vpn-id arn:aws:ec2: region:account-id :vpn- gateway/ vgw-id arn:aws:elasticbea nstalk: region:account-id :applicat ion/ applicationname arn:aws:elasticloadbalancin g: region:account-id :loadbala ncer/ name arn:aws:elasticloadbalancin g: region:account-id :loadbalancer/ app/ load-balancer-name /load-bala ncer-id arn:aws:elasticloadbalancin g: region:account-id :loadbalancer/ net/ load-balancer-name /load-bala ncer-id OpsCenter 2243 AWS Systems Manager Resource name ARN format User Guide AWS Identity and Access Management (IAM) group arn:aws:iam:: account-id :group/group- name IAM policy IAM role IAM user AWS Lambda function arn:aws:iam:: account-i d :policy/policy-name arn:aws:iam:: account-id :role/role- name arn:aws:iam:: account-id :user/user- name arn:aws:lambda: region:account-i d :function: function-name Amazon Relational Database Service (Amazon RDS) cluster arn:aws:rds: region:account-i d :cluster: db-cluster-name Amazon RDS database instance arn:aws:rds: region:account-id :db:db- instance-name Amazon RDS subscription Amazon RDS security group Amazon RDS cluster
|
systems-manager-ug-649
|
systems-manager-ug.pdf
| 649 |
arn:aws:elasticloadbalancin g: region:account-id :loadbala ncer/ name arn:aws:elasticloadbalancin g: region:account-id :loadbalancer/ app/ load-balancer-name /load-bala ncer-id arn:aws:elasticloadbalancin g: region:account-id :loadbalancer/ net/ load-balancer-name /load-bala ncer-id OpsCenter 2243 AWS Systems Manager Resource name ARN format User Guide AWS Identity and Access Management (IAM) group arn:aws:iam:: account-id :group/group- name IAM policy IAM role IAM user AWS Lambda function arn:aws:iam:: account-i d :policy/policy-name arn:aws:iam:: account-id :role/role- name arn:aws:iam:: account-id :user/user- name arn:aws:lambda: region:account-i d :function: function-name Amazon Relational Database Service (Amazon RDS) cluster arn:aws:rds: region:account-i d :cluster: db-cluster-name Amazon RDS database instance arn:aws:rds: region:account-id :db:db- instance-name Amazon RDS subscription Amazon RDS security group Amazon RDS cluster snapshot arn:aws:rds: region:account-i d :es:subscription-name arn:aws:rds: region:account-i d :secgrp:security-group-name arn:aws:rds: region:account-i d :cluster-snapshot: cluster-s napshot-name OpsCenter 2244 AWS Systems Manager Resource name Amazon RDS subnet group Amazon Redshift cluster Amazon Redshift parameter group Amazon Redshift security group Amazon Redshift cluster snapshot Amazon Redshift subnet group User Guide ARN format arn:aws:rds: region:account-i d :subgrp:subnet-group-name arn:aws:redshift: region:account-i d :cluster: cluster-name arn:aws:redshift: region:account-i d :parametergroup: parameter-group-na me arn:aws:redshift: region:account-i d :securitygroup: security-group-name arn:aws:redshift: region:account-i d :snapshot: cluster-name /snapshot- name arn:aws:redshift: region:account-i d :subnetgroup: subnet-group-name Amazon Simple Storage Service (Amazon S3) bucket arn:aws:s3::: bucket_name AWS Config recording of AWS Systems Manager managed node inventory Systems Manager State Manager association arn:aws:ssm: region:account-i d :managed-instance-inventory / node_id arn:aws:ssm: region:account-i d :association/ association_ID OpsCenter 2245 AWS Systems Manager User Guide Adding related OpsItems to an OpsItem By using Related OpsItems of the OpsItems Details page, you can investigate operations issues and provide context for an issue. OpsItems can be related in different ways, including a parent- child relationship between OpsItems, a root cause, or a duplicate. You can associate one OpsItem with another to display it in the Related OpsItem section.You can specify a maximum of 10 IDs for other OpsItems that are related to the current OpsItem. To add a related OpsItem 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose an OpsItem ID to open the details page. 4. 5. In the Related OpsItem section, choose Add. For OpsItem ID, specify an ID. 6. Choose Add. Adding operational data to an OpsItem Operational data is custom data that provides useful reference details about an OpsItem. You can enter multiple key-value pairs of operational data. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. The maximum length of the key can be 128 characters, and the maximum size of the value can be 20 KB. OpsCenter 2246 AWS Systems Manager User Guide You can make the data searchable by other users in the account, or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation). To add operational data to an OpsItem 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose an OpsItem ID to open its details page. 4. 5. Expand Operational data. If no operational data exists for the OpsItem, choose Add. If operational data already exists for the OpsItem, choose Manage. After you create operational data, you can edit the key and the value, remove the operational data, or add additional key-value pairs by choosing Manage. 6. For Key, specify a word or words to help users understand the purpose of the data. OpsCenter 2247 AWS Systems Manager User Guide Important Operational data keys can't begin with the following: amazon, aws, amzn, ssm, / amazon, /aws, /amzn, /ssm. 7. For Value, specify the data. 8. Choose Save. Note You can filter OpsItems by using the Operational data operator on the OpsItems page. In the Search box, choose Operational data, and then enter a key-value pair in JSON. You must enter the key-value pair by using the following format: {"key":"key_name","value":"a_value"} Creating an incident for an OpsItem Use the following procedure to manually create an incident for an OpsItem to track and manage it in AWS Systems Manager Incident Manager, which is a tool in AWS Systems Manager. An incident is any unplanned interruption or reduction in quality of services. For more information about Incident Manager, see the section called “Integrate OpsCenter with other AWS services”. To manually create an incident for an OpsItem 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- 2. 3. manager/. In the navigation pane, choose OpsCenter. If Incident Manager created an OpsItem for you, choose it and go to step 5. If not, choose Create OpsItem and complete the form. If you don't see this button, choose the OpsItems tab, and then choose Create OpsItem.
|
systems-manager-ug-650
|
systems-manager-ug.pdf
| 650 |
is a tool in AWS Systems Manager. An incident is any unplanned interruption or reduction in quality of services. For more information about Incident Manager, see the section called “Integrate OpsCenter with other AWS services”. To manually create an incident for an OpsItem 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- 2. 3. manager/. In the navigation pane, choose OpsCenter. If Incident Manager created an OpsItem for you, choose it and go to step 5. If not, choose Create OpsItem and complete the form. If you don't see this button, choose the OpsItems tab, and then choose Create OpsItem. 4. If you created an OpsItem, open it. 5. Choose Start Incident. 6. For Response plan, choose the Incident Manager response plan that you want to assign to this incident. OpsCenter 2248 AWS Systems Manager User Guide 7. 8. (Optional) For Title, enter a descriptive name to help other team members understand the nature of the incident. If you don't enter a new title, OpsCenter creates the OpsItem and the corresponding incident in Incident Manager using the title in the response plan. (Optional) For Incident impact, choose an impact level for this incident. If you don't choose an impact level, OpsCenter creates the OpsItem and the corresponding incident in Incident Manager using the impact level in the response plan. 9. Choose Start. Managing duplicate OpsItems OpsCenter can receive multiple duplicate OpsItems for a single source from multiple AWS services. OpsCenter uses a combination of built-in logic and configurable deduplication strings to avoid creating duplicate OpsItems. AWS Systems Manager applies deduplication built-in logic when the CreateOpsItem API operation is called. AWS Systems Manager uses the following deduplication logic: 1. When creating the OpsItem, Systems Manager creates and stores a hash based on the deduplication string and the resource that initiated the OpsItem. 2. When another request is made to create an OpsItem, the system checks the deduplication string of the new request. 3. If a matching hash exists for this deduplication string, Systems Manager checks the status of the existing OpsItem. If the status of an existing OpsItem is open or in progress, the OpsItem is not created. If the existing OpsItem is resolved, Systems Manager creates a new OpsItem. After you create an OpsItem, you can't edit or change the deduplication strings in that OpsItem. To manage duplicate OpsItems, you can do the following: • Edit the deduplication string for an Amazon EventBridge rule that targets OpsCenter. For more information, see Editing a deduplication string in a default EventBridge rule. • Specify a deduplication string when you manually create an OpsItem. For more information, see Specifying a deduplication string using AWS CLI. • Review and resolve duplicate OpsItems using operational insights. You can use runbooks to resolve duplicate OpsItems. OpsCenter 2249 AWS Systems Manager User Guide To help you resolve duplicate OpsItems and reduce the number of OpsItems created by a source, Systems Manager provides automation runbooks. For information, see Resolving duplicate OpsItems based on insights. Editing a deduplication string in a default EventBridge rule Use the following procedure to specify a deduplication string for an EventBridge rule that targets OpsCenter. To edit a deduplication string for an EventBridge rule 1. Sign in to the AWS Management Console and open the Amazon EventBridge console at https://console.aws.amazon.com/events/. 2. In the navigation pane, choose Rules. 3. Choose a rule, and then choose Edit. 4. Go to the Select target(s) page. 5. 6. In the Additional settings section, choose Configure input transformer. In the Template box, locate the "operationalData": { "/aws/dedup" JSON entry and the deduplication strings that you want to edit. The deduplication string entry in EventBridge rules uses the following JSON format. "operationalData": { "/aws/dedup": {"type": "SearchableString","value": "{\"dedupString\":\"Words the system should use to check for duplicate OpsItems\"}"}} Here is an example. "operationalData": { "/aws/dedup": {"type": "SearchableString","value": "{\"dedupString\":\"SSMOpsCenter-EBS-volume-performance-issue\"}"}} 7. Edit the deduplication strings, and then choose Confirm. 8. Choose Next. 9. Choose Next. 10. Choose Update rule. OpsCenter 2250 AWS Systems Manager User Guide Specifying a deduplication string using AWS CLI You can specify a deduplication string when you manually create a new OpsItem by using either the AWS Systems Manager console or the AWS CLI. For information about entering deduplication strings when you manually create an OpsItem in the console, see Create OpsItems manually. If you're using the AWS CLI, you can enter the deduplication string for the OperationalData parameter. The parameter syntax uses JSON, as shown in the following example. --operational-data '{"/aws/dedup":{"Value":"{\"dedupString\": \"Words the system should use to check for duplicate OpsItems\"}","Type":"SearchableString"}}' Here is an example command that specifies a deduplication string of disk full. Linux & macOS aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 1 \ --source ec2 \ --operational-data
|
systems-manager-ug-651
|
systems-manager-ug.pdf
| 651 |
when you manually create an OpsItem in the console, see Create OpsItems manually. If you're using the AWS CLI, you can enter the deduplication string for the OperationalData parameter. The parameter syntax uses JSON, as shown in the following example. --operational-data '{"/aws/dedup":{"Value":"{\"dedupString\": \"Words the system should use to check for duplicate OpsItems\"}","Type":"SearchableString"}}' Here is an example command that specifies a deduplication string of disk full. Linux & macOS aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 1 \ --source ec2 \ --operational-data '{"/aws/dedup":{"Value":"{\"dedupString\": \"disk full \"}","Type":"SearchableString"}}' \ --tags "Key=EC2,Value=ProductionServers" \ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser" Windows aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 1 ^ --source EC2 ^ --operational-data={\"/aws/dedup\":{\"Value\":\"{\\"""dedupString\\""":\\"""disk full\\"""}\",\"Type\":\"SearchableString\"}} ^ --tags "Key=EC2,Value=ProductionServers" --notifications Arn="arn:aws:sns:us- west-1:12345678:TestUser" OpsCenter 2251 AWS Systems Manager User Guide Analyzing operational insights to reduce OpsItems OpsCenter operational insights display information about duplicate OpsItems. OpsCenter automatically analyzes OpsItems in your account and generates three types of insights. You can view this information in the Operational insights section of the OpsCenter Summary tab. • Duplicate OpsItems – An insight is generated when eight or more OpsItems have the same title for the same resource. • Most common titles – An insight is generated when more than 50 OpsItems have the same title. • Resources generating the most OpsItems – An insight is generated when an AWS resource has more than 10 open OpsItems. These insights and their corresponding resources are displayed in the Resources generating the most OpsItems table on the OpsCenter Summary tab. Resources are listed in decreasing order of OpsItem count. Note OpsCenter creates Resources generating the most OpsItems insights for the following resource types: • Amazon Elastic Compute Cloud (Amazon EC2) instances • Amazon EC2 security groups • Amazon EC2 Auto Scaling group • Amazon Relational Database Service (Amazon RDS) database • Amazon RDS cluster • AWS Lambda function • Amazon DynamoDB table • Elastic Load Balancing load balancer • Amazon Redshift cluster • AWS Certificate Manager certificate • Amazon Elastic Block Store volume OpsCenter enforces a limit of 15 insights per type. If a type reaches this limit, OpsCenter stops displaying more insights for that type. To view additional insights, you must resolve all OpsItems associated with an OpsInsight of that type. If a pending insight is prevented from being displayed OpsCenter 2252 AWS Systems Manager User Guide in the console because of the 15-insight limit, that insight becomes visible after another insight is closed. When you choose an insight, OpsCenter displays information about the affected OpsItems and resources. The following screenshot shows an example with the details of a duplicate OpsItem insight. Operational insights are turned off by default. For more information about working with operational insights, see the following topics. Topics • Enabling operational insights • Resolving duplicate OpsItems based on insights • Disabling operational insights OpsCenter 2253 AWS Systems Manager Enabling operational insights User Guide You can enable operational insights on the OpsCenter page in the Systems Manager console. When you enable operational insights, Systems Manager creates an AWS Identity and Access Management (IAM) service-linked role called AWSServiceRoleForAmazonSSM_OpsInsights. A service-linked role is a unique type of IAM role that is linked directly to Systems Manager. Service-linked roles are predefined and include all the permissions that the service requires to call other AWS services on your behalf. For more information about the AWSServiceRoleForAmazonSSM_OpsInsights service-linked role, see Using roles to create operational insight OpsItems in Systems Manager OpsCenter. Note Note the following important information: • Your AWS account is charged for operational insights. For more information, see AWS Systems Manager Pricing. • OpsCenter periodically refreshes insights using a batch process. This means the list of insights displayed in OpsCenter might be out of sync. Use the following procedure to enable and view operational insights in OpsCenter. To enable and view operational insights 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- 2. 3. manager/. In the navigation pane, choose OpsCenter. In the Operational insight is available message box, choose Enable. If you don't see this message, scroll down to the Operational insights section and choose Enable. 4. After you enable this feature, on the Summary tab, scroll down to the Operational insights section. 5. To view a filtered list of insights, choose the link beside Duplicate OpsItems, Most common titles, or Resources generating the most OpsItems. To view all insights, choose View all operational insights. 6. Choose an insight ID to view more information. OpsCenter 2254 AWS Systems Manager User Guide Resolving duplicate OpsItems based on insights To resolve insights, you must first resolve all OpsItems associated with an insight. You can use the AWS-BulkResolveOpsItemsForInsight runbook to resolve OpsItems
|
systems-manager-ug-652
|
systems-manager-ug.pdf
| 652 |
the Operational insights section and choose Enable. 4. After you enable this feature, on the Summary tab, scroll down to the Operational insights section. 5. To view a filtered list of insights, choose the link beside Duplicate OpsItems, Most common titles, or Resources generating the most OpsItems. To view all insights, choose View all operational insights. 6. Choose an insight ID to view more information. OpsCenter 2254 AWS Systems Manager User Guide Resolving duplicate OpsItems based on insights To resolve insights, you must first resolve all OpsItems associated with an insight. You can use the AWS-BulkResolveOpsItemsForInsight runbook to resolve OpsItems associated with an insight. To help you resolve duplicate OpsItems and reduce the number of OpsItems created by a source, Systems Manager provides the following automation runbooks: • The AWS-BulkResolveOpsItems runbook resolves OpsItems that match a specified filter. • The AWS-AddOpsItemDedupStringToEventBridgeRule runbook adds a deduplication string for all OpsItem targets that are associated with a specific Amazon EventBridge rule. This runbook doesn't add a deduplication string if a rule already has one. • The AWS-DisableEventBridgeRule turns off a rule in EventBridge if the rule is generating dozens or hundreds of OpsItems. To resolve an operational insight 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. On the Overview tab, scroll down to Operational insights. 4. Choose View all operational insights. 5. Choose an insight ID to view more information. 6. Choose a runbook and choose Execute. Disabling operational insights When you turn off operational insights, the system stops creating new insights and stops displaying insights in the console. Any active insights remain unchanged in the system, although you won't see them displayed in the console. If you enable this feature again, the system displays previously unresolved insights and starts creating new insights. Use the following procedure to turn off operational insights. OpsCenter 2255 AWS Systems Manager To turn off operational insights User Guide 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose Settings. 4. In the Operational insights section, choose Edit and then toggle the Disable option. 5. Choose Save. Viewing OpsCenter logs and reports AWS CloudTrail logs AWS Systems Manager OpsCenter API calls to the console, the AWS Command Line Interface (AWS CLI), and the SDK. You can view the information in the CloudTrail console or in an Amazon Simple Storage Service (Amazon S3) bucket. Amazon S3 uses one bucket to store all CloudTrail logs for your account. Logs of OpsCenter actions show create, update, get, and describe OpsItem activities. For more information about viewing and using CloudTrail logs of Systems Manager activity, see Logging AWS Systems Manager API calls with AWS CloudTrail. AWS Systems Manager OpsCenter provides you with the following information about OpsItems: • OpsItem status summary – Provides a summary of OpsItems by status (Open and In progress, Open, or In Progress). • Sources with most open OpsItems – Provides a breakdown of the top AWS services with open OpsItems. • OpsItems by source and age – Provides a count of OpsItems, grouped by source and days since creation. To view the OpsCenter summary report 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. On the OpsItems Overview page, choose Summary. OpsCenter 2256 AWS Systems Manager User Guide 4. Under OpsItems by source and age, choose the Search bar to filter OpsItems according to Source. Use the list to filter according to Status. Delete OpsItems You can delete an individual OpsItem by calling the DeleteOpsItem API operation using the AWS Command Line Interface or the AWS SDK. You can't delete an OpsItem in the AWS Management Console. To delete an OpsItem, your AWS Identity and Access Management (IAM) user, group, or role must have either administrator permission or you must have been granted permission to call the DeleteOpsItem API operation. Important Note the following important information about this operation. • Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem. • This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response. • This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call. • This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see (Optional) Setting up OpsCenter to centrally manage OpsItems across accounts. •
|
systems-manager-ug-653
|
systems-manager-ug.pdf
| 653 |
immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response. • This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call. • This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see (Optional) Setting up OpsCenter to centrally manage OpsItems across accounts. • If you receive the OpsItemLimitExceededException, you can delete one or more OpsItems to reduce your total number of OpsItems below the quota limits. For more information about this exception, see Troubleshooting issues with OpsCenter. Deleting an OpsItem Use the following procedure to delete an OpsItem. OpsCenter 2257 AWS Systems Manager To delete an OpsItem User Guide 1. Install and configure the AWS CLI, if you haven't already. For more information, see Installing or updating the latest version of the AWS CLI. 2. Run the following command. Replace ID with the ID of the OpsItem you want to delete. aws ssm delete-ops-item --ops-item-id ID If successful, the command returns no data. Remediate OpsItem issues Using AWS Systems Manager Automation runbooks, you can remediate issues with AWS resources that are identified in an OpsItem. Automation uses predefined runbooks to remediate common issues with AWS resources. Each OpsItem includes the Runbooks section that provides a list of runbooks that you can use for remediation. When you choose an Automation runbook from the list, OpsCenter automatically displays some of the fields required to run the document. When you run an Automation runbook, the system associates the runbook with the related resource of the OpsItem. If Amazon EventBridge creates an OpsItem, it associates a runbook with the OpsItem. OpsCenter keeps a 30- day record of Automation runbooks for an OpsItem. You can choose a status to view important details about the runbook, such as the reason why an automation failed and which step of the Automation runbook was running when the failure occurred, as shown in the following example. OpsCenter 2258 AWS Systems Manager User Guide The Related resource details page for a selected OpsItem includes the Run automation list. You can choose recent or resource-specific Automation runbooks and run them to remediate issues. This page also includes data providers, including Amazon CloudWatch metrics and alarms, AWS CloudTrail logs, and details from AWS Config. OpsCenter 2259 AWS Systems Manager User Guide You can view information about an Automation runbook by either choosing its name in the console or by using the Systems Manager Automation runbook reference. Remediating an OpsItem using a runbook Before you use an Automation runbook to remediate an OpsItem issue, do the following: • Verify that you have permission to run Systems Manager Automation runbooks. For more information, see Setting up Automation. • Collect resource-specific ID information for the automation that you want to run. For example, if you want to run an automation that restarts an EC2 instance, then you must specify the ID of the EC2 instance to restart. To run an Automation runbook to remediate an OpsItem issue 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. OpsCenter 2260 AWS Systems Manager User Guide 3. Choose the OpsItem ID to open the details page. 4. Scroll to the Runbooks section. 5. Use the search bar or the numbers in the upper right to find the Automation runbook that you want to run. 6. Choose a runbook, and then choose Execute. 7. Enter the required information for the runbook, and then choose Submit. Once you start the runbook, the system returns to the previous screen and displays the status. 8. In the Automation executions in the last 30 days section, choose the Execution ID link to view steps and the status of the execution. Remediating an OpsItem using an associated runbook After you run an Automation runbook from an OpsItem, OpsCenter associates the runbook with the OpsItem. An associated runbook is ranked higher than other runbooks in the Runbooks list. Use the following procedure to run an Automation runbook that has already been associated with a related resource in an OpsItem. For information about adding related resources, see Manage OpsItems. To run a resource-associated runbook to remediate an OpsItem issue 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Open the OpsItem. 4. In the Related resources section, choose the resource on which you want to run the Automation runbook. 5. Choose Run automation, and then choose the associated Automation runbook that you want to run. OpsCenter 2261 AWS Systems Manager User Guide
|
systems-manager-ug-654
|
systems-manager-ug.pdf
| 654 |
following procedure to run an Automation runbook that has already been associated with a related resource in an OpsItem. For information about adding related resources, see Manage OpsItems. To run a resource-associated runbook to remediate an OpsItem issue 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Open the OpsItem. 4. In the Related resources section, choose the resource on which you want to run the Automation runbook. 5. Choose Run automation, and then choose the associated Automation runbook that you want to run. OpsCenter 2261 AWS Systems Manager User Guide 6. Enter the required information for the runbook, and then choose Execute. Once you start the runbook, the system returns to the previous screen and displays the status. 7. In the Automation executions in the last 30 days section, choose the Execution ID link to view steps and the status of the execution. Viewing OpsCenter summary reports AWS Systems Manager OpsCenter includes a summary page that automatically displays the following information: • OpsItem status summary – A summary of OpsItems by status, such as Open and In progress. • Sources with most open OpsItems – A breakdown of the top AWS services that have open OpsItems. • OpsItems by source and age – A count of OpsItems, grouped by source and number of days since creation. To view OpsCenter summary reports 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. 3. In the navigation pane, choose OpsCenter, and then choose the Summary tab. In the OpsItems by source and age section, do the following: 1. (Optional) In the filter field, choose Source, select Equal, Begin With, or Not Equal, and then enter a search parameter. 2. In the adjacent list, select one of the following status values: • Open • In progress • Resolved • Open and in progress • All OpsCenter 2262 AWS Systems Manager User Guide Troubleshooting issues with OpsCenter This topic includes information to help you troubleshoot common errors and issues with OpsCenter. You receive the OpsItemLimitExceededException If your AWS account has reached the maximum number of OpsItems allowed when you call the CreateOpsItem API operation, you receive an OpsItemLimitExceededException. OpsCenter returns the exception if your call would exceed the maximum number of OpsItems for either of the following quotas: • Total number of OpsItems per AWS account per Region (including Open and Resolved OpsItems): 500,000 • Maximum number of OpsItems per AWS account per month: 10,000 These quotas apply to OpsItems created from any source except the following: • OpsItems created by AWS Security Hub findings • OpsItems that are auto-generated when an Incident Manager incident is opened OpsItems created from these sources don't count against your OpsItem quotas, but you are charged for each OpsItem. If you receive an OpsItemLimitExceededException, you can manually delete OpsItems until you are below the quota preventing you from creating a new OpsItem. Again, deleting OpsItems created for Security Hub findings or Incident Manager incidents won't reduce your total number of OpsItems enforced by the quotas. You must delete OpsItems from other sources. For information about how to delete an OpsItem, see Delete OpsItems. You receive a large bill from AWS for large numbers of auto-generated OpsItems If you configured integration with AWS Security Hub, OpsCenter creates OpsItems for Security Hub findings. Depending on the number of finding Security Hub generates and the account you were logged into when you configured integration, OpsCenter can generate large numbers of OpsItems, at a cost. Here are more specific details related to OpsItems generated by Security Hub findings: • If you are logged into the Security Hub administrator account when you configure OpsCenter and Security Hub integration, the system creates OpsItems for findings in the administrator and OpsCenter 2263 AWS Systems Manager User Guide all member accounts. The OpsItems are all created in the administrator account. Depending on a variety of factors, this can lead to an unexpectedly large bill from AWS. If you are logged into a member account when you configure integration, the system only creates OpsItems for findings in that individual account. For more information about the Security Hub administrator account, member accounts, and their relation to the EventBridge event feed for findings, see Types of Security Hub integration with EventBridge in the AWS Security Hub User Guide. • For each finding that creates an OpsItem, you are charged the regular price for creating the OpsItem. You are also charged if you edit the OpsItem or if the corresponding finding is updated in Security Hub (which triggers an OpsItem update). • OpsItems that are created by an integration with AWS Security Hub are not currently limited by the maximum quota of 500,000 OpsItems per account in a Region. It is therefore possible for Security Hub alerts to create
|
systems-manager-ug-655
|
systems-manager-ug.pdf
| 655 |
EventBridge event feed for findings, see Types of Security Hub integration with EventBridge in the AWS Security Hub User Guide. • For each finding that creates an OpsItem, you are charged the regular price for creating the OpsItem. You are also charged if you edit the OpsItem or if the corresponding finding is updated in Security Hub (which triggers an OpsItem update). • OpsItems that are created by an integration with AWS Security Hub are not currently limited by the maximum quota of 500,000 OpsItems per account in a Region. It is therefore possible for Security Hub alerts to create more than 500,000 chargeable OpsItems in each Region in an account. For high-production environments, we therefore recommend limiting the scope of Security Hub findings to high severity issues only. Important If you believe a large number of OpsItems were created in error and your AWS bill is unwarranted, contact Support. Use the following procedure if you no longer want the system to create OpsItems for Security Hub findings. To stop receiving OpsItems for Security Hub findings 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the navigation pane, choose OpsCenter. 3. Choose Settings. 4. In the Security Hub findings section, choose Edit. OpsCenter 2264 AWS Systems Manager User Guide 5. Choose the slider to change Enabled to Disabled. If you aren't able to toggle the slider, Security Hub hasn't been enabled for your AWS account. 6. Choose Save to save your configuration. OpsCenter no longer creates OpsItems based on Security Hub findings. Important If OpsCenter toggles the setting back to Enabled and continues to create OpsItems for findings, log into the Systems Manager delegated administrator account or the AWS Organizations management account and repeat this procedure. If you don't have permission to log into either of those accounts, contact your administrator and ask them to repeat this procedure to disable integration for your account. Using Amazon CloudWatch dashboards hosted by Systems Manager Amazon CloudWatch dashboards are customizable home pages in the CloudWatch console that you can use to monitor your resources in a single view, even those resources that are spread across different AWS Regions. You can use CloudWatch dashboards to create customized views of the metrics and alarms for your AWS resources. With dashboards, you can create the following: • A single view for selected metrics and alarms to help you assess the health of your resources and applications across one or more AWS Regions. You can select the color used for each metric on each graph, so that you can track the same metric across multiple graphs. • An operational playbook that provides guidance for team members during operational events about how to respond to specific incidents. • A common view of critical resource and application measurements that can be shared by team members for faster communication flow during operational events. You can create dashboards by using the console, the AWS Command Line Interface (AWS CLI), or by using the CloudWatch PutDashboard API. For more information, see Using Amazon CloudWatch dashboards in the Amazon CloudWatch User Guide. CloudWatch Dashboards 2265 AWS Systems Manager User Guide Working with SSM Agent AWS Systems Manager Agent (SSM Agent) is Amazon software that runs on Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, on-premises servers, and virtual machines (VMs). SSM Agent makes it possible for Systems Manager to update, manage, and configure these resources. The agent processes requests from the Systems Manager service in the AWS Cloud, and then runs them as specified in the request. SSM Agent then sends status and execution information back to the Systems Manager service by using the Amazon Message Gateway Service (ssmmessages). (In AWS Regions launched before 2024, status and execution information might also be sent back by the Amazon Message Delivery Service (service prefix: ec2messages).) If you monitor traffic, you will see that your managed nodes communicate with ssmmessages.* endpoints and possibly ec2messages.* endpoints. For more information, see Reference: ec2messages, ssmmessages, and other API operations. For information about porting SSM Agent logs to Amazon CloudWatch Logs, see Logging and monitoring in AWS Systems Manager. Contents • Learn technical details about the SSM Agent • Find AMIs with the SSM Agent preinstalled • Working with SSM Agent on EC2 instances for Linux • Working with SSM Agent on EC2 instances for macOS • Working with SSM Agent on EC2 instances for Windows Server • Checking SSM Agent status and starting the agent • Checking the SSM Agent version number • Viewing SSM Agent logs • Restricting access to root-level commands through SSM Agent • Automating updates to SSM Agent • Subscribing to SSM Agent notifications • Troubleshooting SSM Agent Learn technical details about the SSM Agent Use the information in this topic to help you implement AWS Systems Manager Agent (SSM Agent)
|
systems-manager-ug-656
|
systems-manager-ug.pdf
| 656 |
• Working with SSM Agent on EC2 instances for Linux • Working with SSM Agent on EC2 instances for macOS • Working with SSM Agent on EC2 instances for Windows Server • Checking SSM Agent status and starting the agent • Checking the SSM Agent version number • Viewing SSM Agent logs • Restricting access to root-level commands through SSM Agent • Automating updates to SSM Agent • Subscribing to SSM Agent notifications • Troubleshooting SSM Agent Learn technical details about the SSM Agent Use the information in this topic to help you implement AWS Systems Manager Agent (SSM Agent) and understand how the agent works. Learn technical details about the SSM Agent 2266 AWS Systems Manager Topics • SSM Agent version 3.2.x.x credential behavior • SSM Agent credentials precedence User Guide • Configuring SSM Agent for use with the Federal Information Processing Standard (FIPS) • About the local ssm-user account • SSM Agent and the Instance Metadata Service (IMDS) • Keeping SSM Agent up-to-date • Ensuring that the SSM Agent installation directory is not modified, moved, or deleted • SSM Agent rolling updates by AWS Regions • SSM Agent communications with AWS managed S3 buckets SSM Agent version 3.2.x.x credential behavior SSM Agent stores a set of temporary credentials at /var/lib/amazon/ssm/credentials (for Linux and macOS) or %PROGRAMFILES%\Amazon\SSM\credentials (for Windows Server) when an instance is onboarded using the Default Host Management Configuration in Quick Setup. The temporary credentials have the permissions you specify for the IAM role you chose for Default Host Management Configuration. On Linux, only the root account can access these credentials. On Windows Server, only the SYSTEM account and local Administrators can access these credentials. SSM Agent credentials precedence This topic describes important information about how SSM Agent is granted permission to perform actions on your resources. Note Support for edge devices differs slightly. You must configure your edge devices to use AWS IoT Greengrass Core software, configure an AWS Identity and Access Management (IAM) service role, and deploy SSM Agent to your devices by using AWS IoT Greengrass. For more information, see Managing edge devices with Systems Manager. When SSM Agent is installed on a machine, it requires permissions in order to communicate with the Systems Manager service. On Amazon Elastic Compute Cloud (Amazon EC2) instances, SSM Agent version 3.2.x.x credential behavior 2267 AWS Systems Manager User Guide these permissions are provided in an instance profile that is attached to the instance. On a non- EC2 machine, SSM Agent normally gets the needed permissions from the shared credentials file, located at /root/.aws/credentials (Linux and macOS) or %USERPROFILE%\.aws \credentials (Windows Server). The needed permissions are added to this file during the hybrid activation process. In rare cases, however, a machine might end up with permissions added to more than one of the locations where SSM Agent checks for permissions to run its tasks. For example, say that you have configured an EC2 instance to be managed by Systems Manager. That configuration includes attaching an instance profile. But then you decide to also use that instance for developer or end-user tasks and install the AWS Command Line Interface (AWS CLI) on it. This installation results in additional permissions being added to a credentials file on the instance. When you run a Systems Manager command on the instance, SSM Agent might try to use credentials different from the ones you expect it to use, such as from a credentials file instead of an instance profile. This is because SSM Agent looks for credentials in the order prescribed for the default credential provider chain. Note On Linux and macOS, SSM Agent runs as the root user. Therefore, the environment variables and credentials file that SSM Agent looks for in this process are those of the root user only (/root/.aws/credentials). SSM Agent doesn't look at the environment variables or credentials file of any other users on the instance during the search for credentials. The default provider chain looks for credentials in the following order: 1. Environment variables, if configured (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY). 2. Shared credentials file ($HOME/.aws/credentials for Linux and macOS or %USERPROFILE% \.aws\credentials for Windows Server) with permissions provided by, for example, a hybrid activation or an AWS CLI installation. 3. An AWS Identity and Access Management (IAM) role for tasks if an application is present that uses an Amazon Elastic Container Service (Amazon ECS) task definition or RunTask API operation. SSM Agent credentials precedence 2268 AWS Systems Manager User Guide 4. An instance profile attached to an Amazon EC2 instance. 5. The IAM role chosen for Default Host Management Configuration. For related information, see the following topics: • Instance profiles for EC2 instances – Configure instance permissions required for Systems Manager • Hybrid activations – Create a hybrid activation to register nodes with Systems Manager • AWS CLI credentials
|
systems-manager-ug-657
|
systems-manager-ug.pdf
| 657 |
3. An AWS Identity and Access Management (IAM) role for tasks if an application is present that uses an Amazon Elastic Container Service (Amazon ECS) task definition or RunTask API operation. SSM Agent credentials precedence 2268 AWS Systems Manager User Guide 4. An instance profile attached to an Amazon EC2 instance. 5. The IAM role chosen for Default Host Management Configuration. For related information, see the following topics: • Instance profiles for EC2 instances – Configure instance permissions required for Systems Manager • Hybrid activations – Create a hybrid activation to register nodes with Systems Manager • AWS CLI credentials – Configuration and credential file settings in the AWS Command Line Interface User Guide • Default credential provider chain – Specifying Credentials in the AWS SDK for Go Developer Guide Note This topic in the AWS SDK for Go Developer Guide describes the default provider chain in terms of the SDK for Go; however, the same principles apply to evaluating credentials for SSM Agent. Configuring SSM Agent for use with the Federal Information Processing Standard (FIPS) If you need to use Systems Manager with Federal Information Processing Standard (FIPS) 140-3 validated cryptographic modules, you can configure AWS Systems Manager Agent (SSM Agent) to use the FIPS endpoints in supported Regions. To configure SSM Agent to connect to FIPS 140-3 endpoints 1. Connect to your managed node. 2. Navigate to the directory that contains the amazon-ssm-agent.json file: • Linux: /etc/amazon/ssm/ • macOS: /opt/aws/ssm/ • Windows Server: C:\Program Files\Amazon\SSM\ 3. Open the file named amazon-ssm-agent.json for editing. Configuring SSM Agent for use with the Federal Information Processing Standard (FIPS) 2269 AWS Systems Manager Tip User Guide If no amazon-ssm-agent.json file exists yet, copy the contents of amazon- ssm-agent.json.template to a new file named amazon-ssm-agent.json. Save amazon-ssm-agent.json in the same directory where amazon-ssm- agent.json.template is located. 4. Add the following content to the file. Replace the region placeholder values with the appropriate Region code for your partition: { ---Existing file content, if any--- "Mds": { "Endpoint": "ec2messages-fips.region.amazonaws.com", }, "Ssm": { "Endpoint": "ssm-fips.region.amazonaws.com", }, "Mgs": { "Endpoint": "ssmmessages-fips.region.amazonaws.com", "Region": "region" }, "S3": { "Endpoint": "s3-fips.dualstack.region.amazonaws.com", "Region": region" }, "Kms": { "Endpoint": "kms-fips.region.amazonaws.com" } } Supported Regions include the following: • us-east-1 for the US East (N. Virginia) Region • us-east-2 for the US East (Ohio) Region • us-west-1 for the US West (N. California) Region • us-west-2 for the US West (Oregon) Region • ca-west-1 for the Canada West (Calgary) Region Configuring SSM Agent for use with the Federal Information Processing Standard (FIPS) 2270 AWS Systems Manager User Guide 5. Save the file and restart SSM Agent. Every time you change the configuration, restart SSM Agent. You can customize other features of SSM Agent using the same procedure. For an up-to-date list of the available configuration properties and their default values, see Config Property Definitions in the amazon-ssm-agent repository in GitHub. For more information about AWS support for FIPS, see Federal Information Processing Standard (FIPS) 140-3. About the local ssm-user account Starting with version 2.3.50.0 of SSM Agent, the agent creates a local user account called ssm- user and adds it to the /etc/sudoers.d directory (Linux and macOS) or to the Administrators group (Windows Server). On agent versions before 2.3.612.0, the account is created the first time SSM Agent starts or restarts after installation. On version 2.3.612.0 and later, the ssm-user account is created the first time a session is started on an instance. This ssm-user is the default OS user when a session starts in Session Manager, a tool in AWS Systems Manager. You can change the permissions by moving ssm-user to a less-privileged group or by changing the sudoers file. The ssm-user account isn't removed from the system when SSM Agent is uninstalled. On Windows Server, SSM Agent handles setting a new password for the ssm-user account when each session starts. No passwords are set for ssm-user on Linux managed instances. Starting with SSM Agent version 2.3.612.0, the ssm-user account isn't created automatically on Windows Server machines that are being used as domain controllers. To use Session Manager on a Windows Server domain controller, create the ssm-user account manually if it isn't already present, and assign Domain Administrator permissions to the user. Important In order for the ssm-user account to be created, the instance profile attached to the instance must provide the necessary permissions. For information, see Step 2: Verify or add instance permissions for Session Manager. About the local ssm-user account 2271 AWS Systems Manager User Guide SSM Agent and the Instance Metadata Service (IMDS) Systems Manager relies on EC2 instance metadata to function correctly. Systems Manager can access instance metadata using either version 1 or version 2 of the Instance Metadata Service (IMDSv1 and IMDSv2). Your instance must be able to access IPv4 address of the instance metadata service: 169.254.169.254.
|
systems-manager-ug-658
|
systems-manager-ug.pdf
| 658 |
Important In order for the ssm-user account to be created, the instance profile attached to the instance must provide the necessary permissions. For information, see Step 2: Verify or add instance permissions for Session Manager. About the local ssm-user account 2271 AWS Systems Manager User Guide SSM Agent and the Instance Metadata Service (IMDS) Systems Manager relies on EC2 instance metadata to function correctly. Systems Manager can access instance metadata using either version 1 or version 2 of the Instance Metadata Service (IMDSv1 and IMDSv2). Your instance must be able to access IPv4 address of the instance metadata service: 169.254.169.254. For more information, see Instance metadata and user data in the Amazon EC2 User Guide. Keeping SSM Agent up-to-date An updated version of SSM Agent is released whenever new tools are added to Systems Manager or updates are made to existing tools. Failing to use the latest version of the agent can prevent your managed node from using various Systems Manager tools and features. For that reason, we recommend that you automate the process of keeping SSM Agent up to date on your machines. For information, see Automating updates to SSM Agent. Subscribe to the SSM Agent Release Notes page on GitHub to get notifications about SSM Agent updates. Note An updated version of SSM Agent is released whenever new tools are added to Systems Manager or updates are made to existing tools. Failing to use the latest version of the agent can prevent your managed node from using various Systems Manager tools and features. For that reason, we recommend that you automate the process of keeping SSM Agent up to date on your machines. For information, see Automating updates to SSM Agent. Subscribe to the SSM Agent Release Notes page on GitHub to get notifications about SSM Agent updates. Amazon Machine Images (AMIs) that include SSM Agent by default can take up to two weeks to be updated with the newest version of SSM Agent. We recommend that you configure even more frequent automated updates to SSM Agent. Ensuring that the SSM Agent installation directory is not modified, moved, or deleted SSM Agent is installed at /var/lib/amazon/ssm/ (Linux and macOS) and %PROGRAMFILES% \Amazon\SSM\ (Windows Server). These installation directories contain critical files and folders used by SSM Agent, such as a credentials file, resources for inter-process communication (IPC), SSM Agent and the Instance Metadata Service (IMDS) 2272 AWS Systems Manager User Guide and orchestration folders. Nothing within the installation directory should be modified, moved, or deleted. Otherwise, SSM Agent might cease to function properly. SSM Agent rolling updates by AWS Regions After an SSM Agent update is made available in its GitHub repository, it can take up to two weeks until the updated version is rolled out to all AWS Regions at different times. For this reason, you might receive the "Unsupported on current platform" or "updating amazon-ssm-agent to an older version, please turn on allow downgrade to proceed" error when trying to deploy a new version of SSM Agent in a Region. To determine the version of SSM Agent available to you, you can run a curl command. To view the version of the agent available in the global download bucket, run the following command. curl https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/VERSION To view the version of the agent available in a specific Region, run the following command, substituting region with the Region you're working in, such as us-east-2 for the US East (Ohio) Region. curl https://s3.region.amazonaws.com/amazon-ssm-region/latest/VERSION You can also open the VERSION file directly in your browser without a curl command. SSM Agent communications with AWS managed S3 buckets In the course of performing various Systems Manager operations, AWS Systems Manager Agent (SSM Agent) accesses a number of Amazon Simple Storage Service (Amazon S3) buckets. These S3 buckets are publicly accessible, and by default, SSM Agent connects to them using HTTP calls. However, if you're using a virtual private cloud (VPC) endpoint in your Systems Manager operations, you must provide explicit permission in an Amazon Elastic Compute Cloud (Amazon EC2) instance profile for Systems Manager, or in a service role for non-EC2 machines in a hybrid and multicloud environment. Otherwise, your resources can't access these public buckets. To grant your managed nodes access to these buckets when you are using a VPC endpoint, you create a custom Amazon S3 permissions policy, and then attach it to your instance profile (for EC2 instances) or your service role (for non-EC2 managed nodes). SSM Agent rolling updates by AWS Regions 2273 AWS Systems Manager User Guide For information about using a virtual private cloud (VPC) endpoint in your Systems Manager operations, see Improve the security of EC2 instances by using VPC endpoints for Systems Manager. Note These permissions only provide access to the AWS managed buckets required by SSM Agent. They don't provide the permissions that
|
systems-manager-ug-659
|
systems-manager-ug.pdf
| 659 |
to these buckets when you are using a VPC endpoint, you create a custom Amazon S3 permissions policy, and then attach it to your instance profile (for EC2 instances) or your service role (for non-EC2 managed nodes). SSM Agent rolling updates by AWS Regions 2273 AWS Systems Manager User Guide For information about using a virtual private cloud (VPC) endpoint in your Systems Manager operations, see Improve the security of EC2 instances by using VPC endpoints for Systems Manager. Note These permissions only provide access to the AWS managed buckets required by SSM Agent. They don't provide the permissions that are necessary for other Amazon S3 operations. They also don't provide permission to your own S3 buckets. For more information, see the following topics: • Configure instance permissions required for Systems Manager • Create the IAM service role required for Systems Manager in hybrid and multicloud environments • Reference: Amazon S3 buckets for patching operations Contents • Required bucket permissions • Example • Validating hybrid-activated machines using a hardware fingerprint • SSM Agent on GitHub Required bucket permissions The following table describes each of the S3 buckets that SSM Agent might need to access for Systems Manager operations. Note region represents the identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. SSM Agent communications with AWS managed S3 buckets 2274 AWS Systems Manager User Guide Amazon S3 permissions required by SSM Agent S3 bucket ARN Description arn:aws:s3:::aws-windows-do wnloads- region/* arn:aws:s3:::amazon-ssm- region/* arn:aws:s3:::aws-ssm- region/* arn:aws:s3:::patch-baseline- snapshot- region/* -or- Required for some SSM documents that support only Windows Server operating systems, plus some for cross-platform support, such as AWSEC2-ConfigureSTIG . Required for updating SSM Agent installat ions. These buckets contain the SSM Agent installation packages, and the installation manifests that are referenced by the AWS- UpdateSSMAgent document and plugin. If these permissions aren't provided, the SSM Agent makes an HTTP call to download the update. Provides access to the S3 bucket containing modules required for use with non-patching Systems Manager documents (SSM Command documents). For example: arn:aws:s 3:::aws-ssm-us-east-2/* . The following are some commonly used SSM documents stored in these buckets. • AWS-ConfigureWindowsUpdate • AWS-FindWindowsUpdates • AWS-UpdateSSMAgent • AWS-UpdateEC2Config Provides access to the S3 bucket containing patch baseline snapshots. This is required if you use any of the following SSM Command documents: • AWS-RunPatchBaseline SSM Agent communications with AWS managed S3 buckets 2275 AWS Systems Manager S3 bucket ARN Description User Guide arn:aws:s3:::patch-baseline- • AWS-RunPatchBaselineAssocia snapshot- region-unique-suffix /* tion • AWS-RunPatchBaselineWithHooks • AWS-ApplyPatchBaseline (a legacy SSM document) The buckets for most supported AWS Regions use the following format: arn:aws:s3:::patch-baseline- snapshot- region For some Regions, an additional unique suffix is included in the bucket name. For example, the bucket name for the Middle East (Bahrain) Region (me-south-1) is as follows: • patch-baseline-snapshot-me- south-1-uduvl7q8 For a complete list of patch baseline snapshot bucket names, see Buckets containing AWS managed patch baseline snapshots. Note If you use an on-premises firewall and plan to use Patch Manager, that firewall must also allow access to the appropriate patch baseline endpoint. SSM Agent communications with AWS managed S3 buckets 2276 AWS Systems Manager S3 bucket ARN Description User Guide For Linux and Windows Server managed nodes: arn:aws:s3:::aws-patch-mana Provides access to the S3 bucket containin g SSM Command documents for patching ger- region-unique-suffix /* operations in Patch Manager. Each bucket For Amazon EC2 instances for macOS: arn:aws:s3:::aws-patchmanager- macos- region-unique-suffix /* name includes a unique suffix, such as 552881074 for buckets in the US East (Ohio) (us-east-2) Region: • arn:aws:s3:::aws-patch-mana gerer-us-east-2-552881074/* • arn:aws:s3::: aws-patchmanager-m acos-us-east-2-552881074/* SSM documents The following are some commonly used SSM documents stored in these buckets. • AWS-RunPatchBaseline • AWS-RunPatchBaselineAssocia tion • AWS-RunPatchBaselineWithHooks • AWS-InstanceRebootWithHooks • AWS-PatchAsgInstance • AWS-PatchInstanceWithRollback For complete lists of AWS managed S3 buckets for patching operations, see the following topics: • Buckets containing SSM Command documents for patching operations (Linux and Windows Server) SSM Agent communications with AWS managed S3 buckets 2277 AWS Systems Manager S3 bucket ARN Example User Guide Description • Buckets containing SSM Command documents for patching operations (macOS) The following example illustrates how to provide access to the S3 buckets required for Systems Manager operations in the US East (Ohio) Region (us-east-2). In most cases, you need to provide these permissions explicitly in an instance profile or service role only when using a VPC endpoint. Important We recommend that you avoid using wildcard characters (*) in place of specific Regions in this policy. For example, use arn:aws:s3:::aws-ssm-us-east-2/* and don't use arn:aws:s3:::aws-ssm-*/*. Using wildcards could provide access to S3 buckets that you don’t intend to grant access to. If you want to use the instance profile for
|
systems-manager-ug-660
|
systems-manager-ug.pdf
| 660 |
operations (macOS) The following example illustrates how to provide access to the S3 buckets required for Systems Manager operations in the US East (Ohio) Region (us-east-2). In most cases, you need to provide these permissions explicitly in an instance profile or service role only when using a VPC endpoint. Important We recommend that you avoid using wildcard characters (*) in place of specific Regions in this policy. For example, use arn:aws:s3:::aws-ssm-us-east-2/* and don't use arn:aws:s3:::aws-ssm-*/*. Using wildcards could provide access to S3 buckets that you don’t intend to grant access to. If you want to use the instance profile for more than one Region, we recommend repeating the first Statement block for each Region. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "s3:GetObject", "Resource": [ "arn:aws:s3:::aws-windows-downloads-us-east-2/*", "arn:aws:s3:::amazon-ssm-us-east-2/*", "arn:aws:s3:::aws-ssm-us-east-2/*", "arn:aws:s3:::patch-baseline-snapshot-us-east-2/*", "arn:aws:s3:::aws-patch-manager-us-east-2-552881074/*", "arn:aws:s3:::aws-patchmanager-macos-us-east-2-552881074/*" ] } ] } SSM Agent communications with AWS managed S3 buckets 2278 AWS Systems Manager User Guide Validating hybrid-activated machines using a hardware fingerprint When non-EC2 machines in a hybrid and multicloud environment, SSM Agent gathers a number of system attributes (referred to as the hardware hash) and uses these attributes to compute a fingerprint. The fingerprint is an opaque string that the agent passes to certain Systems Manager APIs. This unique fingerprint associates the caller with a particular hybrid-activated managed node. The agent stores the fingerprint and hardware hash on the local disk in a location called the Vault. The agent computes the hardware hash and fingerprint when the machine is registered for use with Systems Manager. Then, the fingerprint is passed back to the Systems Manager service when the agent sends a RegisterManagedInstance command. Later, when sending a RequestManagedInstanceRoleToken command, the agent checks the fingerprint and hardware hash in the Vault to make sure that the current machine attributes match with the stored hardware hash. If the current machine attributes do match the hardware hash stored in the Vault, the agent passes in the fingerprint from the Vault to RegisterManagedInstance, resulting in a successful call. If the current machine attributes don't match the stored hardware hash, SSM Agent computes a new fingerprint, stores the new hardware hash and fingerprint in the Vault, and passes the new fingerprint to RequestManagedInstanceRoleToken. This causes RequestManagedInstanceRoleToken to fail, and the agent won't be able to obtain a role token to connect to the Systems Manager service. This failure is by design and is used as a verification step to prevent multiple managed nodes from communicating with the Systems Manager service as the same managed node. When comparing the current machine attributes to the hardware hash stored in the Vault, the agent uses the following logic to determine whether the old and new hashes match: • If the SID (system/machine ID) is different, then no match. • Otherwise, if the IP address is the same, then match. • Otherwise, the percentage of machine attributes that match is computed and compared with the user-configured similarity threshold to determine whether there is a match. The similarity threshold is stored in the Vault, as part of the hardware hash. The similarity threshold can be set after an instance is registered using a command like the following. SSM Agent communications with AWS managed S3 buckets 2279 AWS Systems Manager On Linux machines: User Guide sudo amazon-ssm-agent -fingerprint -similarityThreshold 1 On Windows Server machines using PowerShell: cd "C:\Program Files\Amazon\SSM\" ` .\amazon-ssm-agent.exe -fingerprint -similarityThreshold 1 Important If one of the components used to calculate the fingerprint changes, this can cause the agent to hibernate. To help avoid this hibernation, set the similarity threshold to a low value, such as 1. SSM Agent on GitHub The source code for SSM Agent is available on GitHub so that you can adapt the agent to meet your needs. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services doesn't provide support for running modified copies of this software. Find AMIs with the SSM Agent preinstalled AWS Systems Manager Agent (SSM Agent) is preinstalled on some Amazon Machine Images (AMIs) provided by AWS and trusted third-parties. For example, when you launch an Amazon Elastic Compute Cloud (Amazon EC2) instance created from an AMI with one of the following operating systems, you'll likely find that the SSM Agent is already installed: • AlmaLinux • Amazon Linux 1 Base AMIs dated 2017.09 and later • Amazon Linux 2 • Amazon Linux 2 ECS-Optimized Base AMIs • Amazon Linux 2023 (AL2023) • Amazon EKS-Optimized Amazon Linux AMIs Find AMIs with the SSM Agent preinstalled 2280 AWS Systems Manager User Guide • macOS 10.14.x (Mojave), 10.15.x (Catalina), 11.x (Big Sur), 12.x (Monterey), 13.x (Ventura), 14.x (Sonoma), and 15.x (Sequoia) • SUSE Linux Enterprise Server (SLES) 12 and 15 • Ubuntu Server 16.04, 18.04, 20.04, and 22.04 • Windows Server 2008-2012 R2 AMIs published in
|
systems-manager-ug-661
|
systems-manager-ug.pdf
| 661 |
you'll likely find that the SSM Agent is already installed: • AlmaLinux • Amazon Linux 1 Base AMIs dated 2017.09 and later • Amazon Linux 2 • Amazon Linux 2 ECS-Optimized Base AMIs • Amazon Linux 2023 (AL2023) • Amazon EKS-Optimized Amazon Linux AMIs Find AMIs with the SSM Agent preinstalled 2280 AWS Systems Manager User Guide • macOS 10.14.x (Mojave), 10.15.x (Catalina), 11.x (Big Sur), 12.x (Monterey), 13.x (Ventura), 14.x (Sonoma), and 15.x (Sequoia) • SUSE Linux Enterprise Server (SLES) 12 and 15 • Ubuntu Server 16.04, 18.04, 20.04, and 22.04 • Windows Server 2008-2012 R2 AMIs published in November 2016 or later • Windows Server 2016, 2019, 2022 (excluding Nano versions), and 2025 Note The version of SSM Agent preinstalled on an AMI might not be the latest available version. As a best practice, we recommend always using the latest available version of SSM Agent on your managed nodes. For more information about automating SSM Agent updates, see Automating updates to SSM Agent. SSM Agent might be preinstalled on AWS managed AMIs that aren’t on this list. This typically indicates that the operating system (OS) is not fully supported by all Systems Manager tools. SSM Agent might also be preinstalled on AMIs found in AWS Marketplace or in the Community AMIs repository, but AWS doesn’t support these AMIs. Verify the status of SSM Agent Depending on when it was initialized, an instance created from an AMI on the preceding list might not have SSM Agent preinstalled. It's also possible that an instance has the agent preinstalled, but the agent isn't running. Therefore, we recommend that you check the status of SSM Agent before you try to use Systems Manager on an instance for the first time. Use the following procedure to verify that SSM Agent is installed and running on an instance. If you find that the agent is not installed, you can manually install it on Linux, macOS, and Windows Server instances. To verify installation of SSM Agent on an instance 1. After launching a new instance, wait a few minutes for it to initialize. 2. Connect to the instance using your preferred method. For example, you can use SSH to connect to Linux instances or use Remote Desktop to connect to Windows Server instances. Verify the status of SSM Agent 2281 AWS Systems Manager User Guide 3. Check the status of SSM Agent by running the command for your instance's operating system type. Operating system Command Amazon Linux 1 sudo status amazon-ssm-agent Amazon Linux 2 and Amazon Linux 2023 sudo systemctl status amazon-ss macOS m-agent There is no command to check SSM Agent status on macOS. You can check the status by locating and evaluating the agent log file /var/log/amazon/ssm/amazon- . ssm-agent.log SUSE Linux Enterprise Server sudo systemctl status amazon-ss m-agent Ubuntu Server (32-bit) sudo status amazon-ssm-agent Ubuntu Server (64-bit - Deb) sudo systemctl status amazon-ss m-agent Ubuntu Server (64-bit - Snap) sudo systemctl status snap.amaz on-ssm-agent.amazon-ssm-age nt.service Windows Server Get-Service AmazonSSMAgent Tip To view the commands for checking SSM Agent status on all operating system types supported by Systems Manager, see Checking SSM Agent status and starting the agent. 4. Evaluate the command output to learn the status of the SSM Agent. Verify the status of SSM Agent 2282 AWS Systems Manager User Guide Status: Installed and running In most cases, the command output indicates that the agent is installed and running. The following example shows that SSM Agent is installed and running on an Amazon Linux 2 instance. amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: active (running) since Wed 2021-10-20 19:09:29 UTC; 4min 6s ago --truncated-- The following example shows that SSM Agent is installed and running on a Windows Server instance. Status Name DisplayName ------ ---- ----------- Running AmazonSSMAgent Amazon SSM Agent Status: Installed but not running In some cases, the command output indicates that the agent is installed but not running. The following example shows that SSM Agent is installed but not running on an Amazon Linux 2 instance. amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: inactive (dead) since Wed 2021-10-20 22:16:41 UTC; 18s ago --truncated-- The following example shows that SSM Agent is installed but not running on a Windows Server instance. Status Name DisplayName ------ ---- ----------- Verify the status of SSM Agent 2283 AWS Systems Manager User Guide Stopped AmazonSSMAgent Amazon SSM Agent If the agent is installed but not running, you can activate it manually using the commands for your instance's operating system type. Operating system Command Amazon Linux 1 sudo start amazon-ssm-agent Amazon Linux 2 and Amazon Linux 2023 sudo systemctl enable amazon-ss macOS m-agent sudo systemctl start amazon-ssm- agent sudo launchctl load -w /Library/ LaunchDaemons/com.amazon.aw s.ssm.plist sudo launchctl start com.amazo n.aws.ssm SUSE Linux Enterprise Server sudo systemctl enable
|
systems-manager-ug-662
|
systems-manager-ug.pdf
| 662 |
installed but not running on a Windows Server instance. Status Name DisplayName ------ ---- ----------- Verify the status of SSM Agent 2283 AWS Systems Manager User Guide Stopped AmazonSSMAgent Amazon SSM Agent If the agent is installed but not running, you can activate it manually using the commands for your instance's operating system type. Operating system Command Amazon Linux 1 sudo start amazon-ssm-agent Amazon Linux 2 and Amazon Linux 2023 sudo systemctl enable amazon-ss macOS m-agent sudo systemctl start amazon-ssm- agent sudo launchctl load -w /Library/ LaunchDaemons/com.amazon.aw s.ssm.plist sudo launchctl start com.amazo n.aws.ssm SUSE Linux Enterprise Server sudo systemctl enable amazon-ss m-agent sudo systemctl start amazon-ssm- agent Ubuntu Server (32-bit) sudo start amazon-ssm-agent Ubuntu Server (64-bit - Deb) sudo systemctl enable amazon-ss m-agent sudo systemctl start amazon-ssm- agent Ubuntu Server (64-bit - Snap) sudo snap start amazon-ssm-agent Verify the status of SSM Agent 2284 AWS Systems Manager User Guide Operating system Command Windows Server Run the following command in PowerShell. Start-Service AmazonSSMAgent Status: Not installed In some cases, the command output indicates that the agent is not installed. The following example shows that SSM Agent is not installed on an Amazon Linux 2 instance. Unit amazon-ssm-agent.service could not be found. The following example shows that SSM Agent is not installed on a Windows Server instance. Get-Service : Cannot find any service with service name 'AmazonSSMAgent'. --truncated-- If the agent isn't installed, you can install it manually using the procedure for your operating system type: • Manually installing and uninstalling SSM Agent on EC2 instances for Linux • Manually installing and uninstalling SSM Agent on EC2 instances for macOS • Manually installing and uninstalling SSM Agent on EC2 instances for Windows Server Working with SSM Agent on EC2 instances for Linux AWS Systems Manager Agent (SSM Agent) processes Systems Manager requests and configures your machine as specified in the request. Use the procedures in following topics to install, configure, or uninstall SSM Agent on Linux operating systems. Topics • Verifying the signature of SSM Agent • Manually installing and uninstalling SSM Agent on EC2 instances for Linux • Configuring SSM Agent to use a proxy on Linux nodes Working with SSM Agent on EC2 instances for Linux 2285 AWS Systems Manager User Guide Verifying the signature of SSM Agent The AWS Systems Manager Agent (SSM Agent) deb and rpm installer packages for Linux instances are cryptographically signed. You can use a public key to verify that the agent package is original and unmodified. If the files are damaged or have been altered, the verification fails. You can verify the signature of the installer package using either RPM or GPG. The following information is for SSM Agent versions 3.1.1141.0 or later. To find the correct signature file for your instance's architecture and operating system, see the following table. region represents the identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. Architecture Operating system Signature file URL Agent download file name x86_64 AlmaLinux, Amazon Linux 1, Amazon https://s amazon-ssm- 3. region.amazonaw agent.rpm Linux 2, Amazon s.com/amazon- Linux 2023, CentOS, ssm-region/ CentOS Stream, RHEL, Oracle Linux, Rocky Linux, SLES latest/l inux_amd64/ amazon-ssm- agent.rpm.sig https://s 3.amazona ws.com/ec2- downloads- windows/SSMAgen t/latest/ linux_amd64/ amazon-ssm-agen t.rpm.sig Verifying the signature of SSM Agent 2286 AWS Systems Manager User Guide Architecture Operating system Signature file URL Agent download file name x86_64 Debian Server, Ubuntu Server https://s amazon-ssm- 3. region.amazonaw agent.deb s.com/amazon- ssm-region/ latest/d ebian_amd64/ amazon-ssm-agen t.deb.sig https://s 3.amazona ws.com/ec2- downloads- windows/SSMAgen t/latest/ debian_amd64/ amazon-ssm-age nt.deb.sig Verifying the signature of SSM Agent 2287 AWS Systems Manager User Guide Architecture Operating system Signature file URL Agent download file name x86 Amazon Linux 1, Amazon Linux 2, https://s amazon-ssm- 3. region.amazonaw agent.rpm Amazon Linux 2023, s.com/amazon- CentOS, RHEL ssm-region/ latest/l inux_386/ amazon-ssm- agent.rpm.sig https://s 3.amazona ws.com/ec2- downloads- windows/SSMAgen t/latest/ linux_386/ amazon-ssm- agent.rpm.sig Verifying the signature of SSM Agent 2288 AWS Systems Manager User Guide Architecture Operating system Signature file URL Agent download file name x86 Ubuntu Server https://s amazon-ssm- 3. region.amazonaw agent.deb s.com/amazon- ssm-region/ latest/d ebian_386/ amazon-ssm- agent.deb.sig https://s 3.amazona ws.com/ec2- downloads- windows/SSMAgen t/latest/ debian_386/ amazon-ssm- agent.deb.sig Verifying the signature of SSM Agent 2289 AWS Systems Manager User Guide Architecture Operating system Signature file URL Agent download file name ARM64 Amazon Linux 1, Amazon Linux 2, https://s amazon-ssm- 3. region.amazonaw agent.rpm Amazon Linux 2023, s.com/amazon- CentOS, RHEL ssm-region/ latest/l inux_arm64/ amazon-ssm- agent.rpm.sig https://s 3.amazona ws.com/ec2- downloads- windows/SSMAgen t/latest/ linux_arm64/ amazon-ssm-agen t.rpm.sig Verifying the SSM Agent package on a Linux server (v3.3.1802.0 and later) Before you begin The procedures for GPG and RPM in this section apply to SSM Agent version 3.3.1802.0 and later. Before verifying the signature of SSM Agent
|
systems-manager-ug-663
|
systems-manager-ug.pdf
| 663 |
ws.com/ec2- downloads- windows/SSMAgen t/latest/ debian_386/ amazon-ssm- agent.deb.sig Verifying the signature of SSM Agent 2289 AWS Systems Manager User Guide Architecture Operating system Signature file URL Agent download file name ARM64 Amazon Linux 1, Amazon Linux 2, https://s amazon-ssm- 3. region.amazonaw agent.rpm Amazon Linux 2023, s.com/amazon- CentOS, RHEL ssm-region/ latest/l inux_arm64/ amazon-ssm- agent.rpm.sig https://s 3.amazona ws.com/ec2- downloads- windows/SSMAgen t/latest/ linux_arm64/ amazon-ssm-agen t.rpm.sig Verifying the SSM Agent package on a Linux server (v3.3.1802.0 and later) Before you begin The procedures for GPG and RPM in this section apply to SSM Agent version 3.3.1802.0 and later. Before verifying the signature of SSM Agent using the following procedure, ensure that you have downloaded the latest agent package for your operating system. For example, https:// s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_arm64/amazon- ssm-agent.rpm. For more information about downloading SSM Agent packages, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. If you have a reason to continue using agent version 3.3.1611.0 or earlier, follow the instructions in Verifying the SSM Agent package on a Linux server (v3.3.1611.0 and earlier) instead. Verifying the signature of SSM Agent 2290 AWS Systems Manager GPG User Guide To verify the SSM Agent package on a Linux server (v3.3.1802.0 and later) 1. Copy one the following public key and save it to a file named amazon-ssm-agent.gpg. Important The following public key expires on 2026-07-15 (July 15, 2026). Systems Manager will publish a new public key in this topic before the old one expires. We encourage you to subscribe to the RSS feed for this topic to get a notification when the new key is available. -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2.0.22 (GNU/Linux) mQINBGeRNq4BEACrlf5h6Pz+k+M+QCJJ2LfK7d2Tn9J8iJ9qBK2Vwvuxco1rpSO+ KEI3nTeysPuheximps8WOCADX4VlbsKxMZQLjQM4mA26m1Tiw9nAI4kod4bKjiuM BMUTCD1wfnjH3zQi4kDUdbpfAEMiPgNLVLH85Wf+lhK+Zm+V38DYzLyVj03kX4wK iG6RMoxzOBZa5gNsVq+j+oCUITGz/URxH713Rgo8WeoEegI0+7iCBLKg+PM0b7GV 2nzkwWJz796HdkqSg8BwXsYaLTrHxa2P1IpwPCisAkyO7gZaMd6Uj69dtMFO+V8a Qee6b57qGuFKZw7h1Vvc85PbF1Gy/wNIpary57kUHBFUg1vYep/roJuEbJCq97r5 I2liLl4NAyrWb9r/TAVxlXvqM4iZUhxm8GAp0FywMdBr9ZECClKa5HxuVmlm0Wgl TXoYTOZKeDg6ZoCvyhNxWneCNip74fohXymeFF5L/budhBwy5wuwSniOgTGLo/4C VgZHWCcN+d0Q3bx/sl2QNqPg5/xzsxEtymXLdVdwLIsLdEQUnIvy8KTs5jol3Dwi nnEEyhly6wdaw+qDOhkSOT/VnErrSMkYF8VJfa5GjhCBWKw9JVSkaP2CI/VHOgHM MKROnulq0hRQBR7RmLYt98xu38BHJWMmF8Ga/HJuIxzD1VmkZOPvDDESUwARAQAB tCdTU00gQWdlbnQgPHNzbS1hZ2VudC1zaWduZXJAYW1hem9uLmNvbT6JAj8EEwEC ACkFAmeRNq4CGy8FCQLGmIAHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRBR qOBQ0AUuXTdND/9qldQ1E3dYjBVXOnbhiUQL594bkS5VoEX7D4fZ5UMVZa5pGiz+ husnoRUS9rH1cSeq7aHJu9hSCMuMdvRpuoo0CwLB+7HtzJvAO2M01hcEkUYa6Qdj njTzP0ZjnoenJmqF9SYmVqAI/VPa9mNQ1OJ+HQ3qh5i6w+FoWlVqEdXjZGrWijub TqyN33i1Y26t7Os/x8I9fUeNx37y/7Kama8LTdtv9GhWiMVBg2IuVf27HCMYofrQ m2uCGe61IhtsnhsYaYupmljl+6qgdiuCiS9BAsoIGtqTnu8lnKcGyGz6YnRszN+U 1bNE4w+UFpXWJF8ogpYcghJ06aW/LhjZnQSx3VliLdW8eOJzou41yWmiuL3ZY8eW KAlD+7eYKS6N6fEJCeNO2VX2lcKtDfaOX+lqGIVyexKayMfpi+0frNzt/92YCpF5 3jkeS77vMMVqKIUiIp1OCGv3XsFpIr6Bt2c2throYPDoQL3zvq6vvG40BKeRQ4tT Y+5vTc8MeNn3LdzTl9pusxTcKifrJq7f5FIsL2CpAX8uQ+Qz+XWsYQQ5PvyUDtOz nU/MRZaP6HnqY42bzI9ZlKgXi9IE3MXIwoET9YyzFjkIDvat7SlB4uJCpeIqp/KM OIrTMb7paGLYmBU6YqxNBkDWItNG7NeZzyhh/R/Qqb4vJaf4S+ZqD1RZXokCHAQQ AQIABgUCZ5E2rwAKCRB90Jej2tf1/CdnD/46It+RNoE00TesZK5n2bijH5Eljw0E Verifying the signature of SSM Agent 2291 AWS Systems Manager User Guide 4/UpMi1SV6t2zY7lIm7TcKNn18tynJNFqB6YXXOwSbBG/fbN2E9RaoUCZw23TmAv amuHwrfsDqsHb7zzPF0bISYjqEDLQJj/gtEugUc6XY1dEpFSlWJIOvgryG04cFXI uD2KY87ya4s1R+sEVAJ14K4RlUCiMmzJdR0NJNYJOwBi1gkLEp6jG86ttiG2U7fY pE2ibV+c0GeIFq8PIzqqENsn9KBuRH5EcbdBwfnsj2XfM4aR3ZtRIdWXkKkdP9Rs yU5dTF/Y7XPId5h8/gp00+DMlXFBinQ1jE7A7eDYviEFd1ba8P7dIom3Q3gzKiWu KTGpnykShs5NvpQmvGUF6JqDHI4RK9s3kLqsNyZkhenJfRBrJ/45fQAuP4CRedkF 7PSfX0Xp7kDnKuyK6wEUEfXXrqmuLGDmigTXblO5qgdyMwkOLjiY9znBZbHoKs76 VplOoNgGnN19i3nuMcPf2npFICJv7kTIyn5Fh7pjWDCahl3U/PwoLjrrlEzpyStU oXSZrK3kiAADEdSODXJl8KYU0Pb27JbRr1ZbWnxb+O39TOhtssstulkR0v+IDGDQ rQE1b12sKgcNFSzInzWrNGu4S06WN8DYzlrTZ9aSHj+37ZqpXAevi8WOFXKPV3PA E6+O8RI2451Dcg== =aDkv -----END PGP PUBLIC KEY BLOCK----- 2. Import the public key into your keyring, and note the returned key value. gpg --import amazon-ssm-agent.gpg 3. Verify the fingerprint. Be sure to replace key-value with the value from the preceding step. We recommend that you use GPG to verify the fingerprint even if you use RPM to verify the installer package. gpg --fingerprint key-value This command returns output similar to the following: pub 4096R/D0052E5D 2025-01-22 [expires: 2026-07-15] Key fingerprint = 4855 A9E6 8332 16D6 A77D 8FE4 51A8 E050 D005 2E5D uid SSM Agent <[email protected]> The fingerprint should match the following. 4855 A9E6 8332 16D6 A77D 8FE4 51A8 E050 D005 2E5D If the fingerprint doesn't match, don't install the agent. Contact AWS Support. 4. Download the signature file according to your instance's architecture and operating system if you haven't already done so. 5. Verify the installer package signature. Be sure to replace the signature-filename and agent-download-filename with the values you specified when downloading the signature file and agent, as listed in the table earlier in this topic. Verifying the signature of SSM Agent 2292 AWS Systems Manager User Guide gpg --verify signature-filename agent-download-filename For example, for the x86_64 architecture on Amazon Linux 2: gpg --verify amazon-ssm-agent.rpm.sig amazon-ssm-agent.rpm This command returns output similar to the following: gpg: Signature made Sat 08 Feb 2025 12:05:08 AM UTC using RSA key ID D0052E5D gpg: Good signature from "SSM Agent <[email protected]>" gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner. Primary key fingerprint: 4855 A9E6 8332 16D6 A77D 8FE4 51A8 E050 D005 2E5D If the output includes the phrase BAD signature, check whether you performed the procedure correctly. If you continue to get this response, contact Support and don't install the agent. The warning message about the trust doesn't mean that the signature isn't valid, only that you haven't verified the public key. A key is trusted only if you or someone who you trust has signed it. If the output includes the phrase Can't check signature: No public key, verify you downloaded SSM Agent version 3.1.1141.0 or later. RPM To verify the SSM Agent package on a Linux server (v3.3.1802.0 and later) 1. Copy the following public key and save it to a file named amazon-ssm-agent.gpg. Important The following public key expires on 2026-07-15 (July 15, 2026). Systems Manager will publish a new public key in this topic before the old one expires. We encourage you to subscribe to the RSS feed for this topic to get a notification when the new key is available. -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2.0.22 (GNU/Linux) Verifying the signature of SSM Agent 2293 AWS Systems Manager User Guide mQINBGeRNq4BEACrlf5h6Pz+k+M+QCJJ2LfK7d2Tn9J8iJ9qBK2Vwvuxco1rpSO+ KEI3nTeysPuheximps8WOCADX4VlbsKxMZQLjQM4mA26m1Tiw9nAI4kod4bKjiuM BMUTCD1wfnjH3zQi4kDUdbpfAEMiPgNLVLH85Wf+lhK+Zm+V38DYzLyVj03kX4wK iG6RMoxzOBZa5gNsVq+j+oCUITGz/URxH713Rgo8WeoEegI0+7iCBLKg+PM0b7GV 2nzkwWJz796HdkqSg8BwXsYaLTrHxa2P1IpwPCisAkyO7gZaMd6Uj69dtMFO+V8a Qee6b57qGuFKZw7h1Vvc85PbF1Gy/wNIpary57kUHBFUg1vYep/roJuEbJCq97r5 I2liLl4NAyrWb9r/TAVxlXvqM4iZUhxm8GAp0FywMdBr9ZECClKa5HxuVmlm0Wgl TXoYTOZKeDg6ZoCvyhNxWneCNip74fohXymeFF5L/budhBwy5wuwSniOgTGLo/4C VgZHWCcN+d0Q3bx/sl2QNqPg5/xzsxEtymXLdVdwLIsLdEQUnIvy8KTs5jol3Dwi nnEEyhly6wdaw+qDOhkSOT/VnErrSMkYF8VJfa5GjhCBWKw9JVSkaP2CI/VHOgHM MKROnulq0hRQBR7RmLYt98xu38BHJWMmF8Ga/HJuIxzD1VmkZOPvDDESUwARAQAB tCdTU00gQWdlbnQgPHNzbS1hZ2VudC1zaWduZXJAYW1hem9uLmNvbT6JAj8EEwEC ACkFAmeRNq4CGy8FCQLGmIAHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRBR qOBQ0AUuXTdND/9qldQ1E3dYjBVXOnbhiUQL594bkS5VoEX7D4fZ5UMVZa5pGiz+ husnoRUS9rH1cSeq7aHJu9hSCMuMdvRpuoo0CwLB+7HtzJvAO2M01hcEkUYa6Qdj njTzP0ZjnoenJmqF9SYmVqAI/VPa9mNQ1OJ+HQ3qh5i6w+FoWlVqEdXjZGrWijub TqyN33i1Y26t7Os/x8I9fUeNx37y/7Kama8LTdtv9GhWiMVBg2IuVf27HCMYofrQ m2uCGe61IhtsnhsYaYupmljl+6qgdiuCiS9BAsoIGtqTnu8lnKcGyGz6YnRszN+U 1bNE4w+UFpXWJF8ogpYcghJ06aW/LhjZnQSx3VliLdW8eOJzou41yWmiuL3ZY8eW KAlD+7eYKS6N6fEJCeNO2VX2lcKtDfaOX+lqGIVyexKayMfpi+0frNzt/92YCpF5 3jkeS77vMMVqKIUiIp1OCGv3XsFpIr6Bt2c2throYPDoQL3zvq6vvG40BKeRQ4tT Y+5vTc8MeNn3LdzTl9pusxTcKifrJq7f5FIsL2CpAX8uQ+Qz+XWsYQQ5PvyUDtOz nU/MRZaP6HnqY42bzI9ZlKgXi9IE3MXIwoET9YyzFjkIDvat7SlB4uJCpeIqp/KM OIrTMb7paGLYmBU6YqxNBkDWItNG7NeZzyhh/R/Qqb4vJaf4S+ZqD1RZXokCHAQQ AQIABgUCZ5E2rwAKCRB90Jej2tf1/CdnD/46It+RNoE00TesZK5n2bijH5Eljw0E 4/UpMi1SV6t2zY7lIm7TcKNn18tynJNFqB6YXXOwSbBG/fbN2E9RaoUCZw23TmAv amuHwrfsDqsHb7zzPF0bISYjqEDLQJj/gtEugUc6XY1dEpFSlWJIOvgryG04cFXI
|
systems-manager-ug-664
|
systems-manager-ug.pdf
| 664 |
file named amazon-ssm-agent.gpg. Important The following public key expires on 2026-07-15 (July 15, 2026). Systems Manager will publish a new public key in this topic before the old one expires. We encourage you to subscribe to the RSS feed for this topic to get a notification when the new key is available. -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2.0.22 (GNU/Linux) Verifying the signature of SSM Agent 2293 AWS Systems Manager User Guide mQINBGeRNq4BEACrlf5h6Pz+k+M+QCJJ2LfK7d2Tn9J8iJ9qBK2Vwvuxco1rpSO+ KEI3nTeysPuheximps8WOCADX4VlbsKxMZQLjQM4mA26m1Tiw9nAI4kod4bKjiuM BMUTCD1wfnjH3zQi4kDUdbpfAEMiPgNLVLH85Wf+lhK+Zm+V38DYzLyVj03kX4wK iG6RMoxzOBZa5gNsVq+j+oCUITGz/URxH713Rgo8WeoEegI0+7iCBLKg+PM0b7GV 2nzkwWJz796HdkqSg8BwXsYaLTrHxa2P1IpwPCisAkyO7gZaMd6Uj69dtMFO+V8a Qee6b57qGuFKZw7h1Vvc85PbF1Gy/wNIpary57kUHBFUg1vYep/roJuEbJCq97r5 I2liLl4NAyrWb9r/TAVxlXvqM4iZUhxm8GAp0FywMdBr9ZECClKa5HxuVmlm0Wgl TXoYTOZKeDg6ZoCvyhNxWneCNip74fohXymeFF5L/budhBwy5wuwSniOgTGLo/4C VgZHWCcN+d0Q3bx/sl2QNqPg5/xzsxEtymXLdVdwLIsLdEQUnIvy8KTs5jol3Dwi nnEEyhly6wdaw+qDOhkSOT/VnErrSMkYF8VJfa5GjhCBWKw9JVSkaP2CI/VHOgHM MKROnulq0hRQBR7RmLYt98xu38BHJWMmF8Ga/HJuIxzD1VmkZOPvDDESUwARAQAB tCdTU00gQWdlbnQgPHNzbS1hZ2VudC1zaWduZXJAYW1hem9uLmNvbT6JAj8EEwEC ACkFAmeRNq4CGy8FCQLGmIAHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRBR qOBQ0AUuXTdND/9qldQ1E3dYjBVXOnbhiUQL594bkS5VoEX7D4fZ5UMVZa5pGiz+ husnoRUS9rH1cSeq7aHJu9hSCMuMdvRpuoo0CwLB+7HtzJvAO2M01hcEkUYa6Qdj njTzP0ZjnoenJmqF9SYmVqAI/VPa9mNQ1OJ+HQ3qh5i6w+FoWlVqEdXjZGrWijub TqyN33i1Y26t7Os/x8I9fUeNx37y/7Kama8LTdtv9GhWiMVBg2IuVf27HCMYofrQ m2uCGe61IhtsnhsYaYupmljl+6qgdiuCiS9BAsoIGtqTnu8lnKcGyGz6YnRszN+U 1bNE4w+UFpXWJF8ogpYcghJ06aW/LhjZnQSx3VliLdW8eOJzou41yWmiuL3ZY8eW KAlD+7eYKS6N6fEJCeNO2VX2lcKtDfaOX+lqGIVyexKayMfpi+0frNzt/92YCpF5 3jkeS77vMMVqKIUiIp1OCGv3XsFpIr6Bt2c2throYPDoQL3zvq6vvG40BKeRQ4tT Y+5vTc8MeNn3LdzTl9pusxTcKifrJq7f5FIsL2CpAX8uQ+Qz+XWsYQQ5PvyUDtOz nU/MRZaP6HnqY42bzI9ZlKgXi9IE3MXIwoET9YyzFjkIDvat7SlB4uJCpeIqp/KM OIrTMb7paGLYmBU6YqxNBkDWItNG7NeZzyhh/R/Qqb4vJaf4S+ZqD1RZXokCHAQQ AQIABgUCZ5E2rwAKCRB90Jej2tf1/CdnD/46It+RNoE00TesZK5n2bijH5Eljw0E 4/UpMi1SV6t2zY7lIm7TcKNn18tynJNFqB6YXXOwSbBG/fbN2E9RaoUCZw23TmAv amuHwrfsDqsHb7zzPF0bISYjqEDLQJj/gtEugUc6XY1dEpFSlWJIOvgryG04cFXI uD2KY87ya4s1R+sEVAJ14K4RlUCiMmzJdR0NJNYJOwBi1gkLEp6jG86ttiG2U7fY pE2ibV+c0GeIFq8PIzqqENsn9KBuRH5EcbdBwfnsj2XfM4aR3ZtRIdWXkKkdP9Rs yU5dTF/Y7XPId5h8/gp00+DMlXFBinQ1jE7A7eDYviEFd1ba8P7dIom3Q3gzKiWu KTGpnykShs5NvpQmvGUF6JqDHI4RK9s3kLqsNyZkhenJfRBrJ/45fQAuP4CRedkF 7PSfX0Xp7kDnKuyK6wEUEfXXrqmuLGDmigTXblO5qgdyMwkOLjiY9znBZbHoKs76 VplOoNgGnN19i3nuMcPf2npFICJv7kTIyn5Fh7pjWDCahl3U/PwoLjrrlEzpyStU oXSZrK3kiAADEdSODXJl8KYU0Pb27JbRr1ZbWnxb+O39TOhtssstulkR0v+IDGDQ rQE1b12sKgcNFSzInzWrNGu4S06WN8DYzlrTZ9aSHj+37ZqpXAevi8WOFXKPV3PA E6+O8RI2451Dcg== =aDkv -----END PGP PUBLIC KEY BLOCK----- 2. Import the public key into your keyring, and note the returned key value. rpm --import amazon-ssm-agent.gpg Verifying the signature of SSM Agent 2294 AWS Systems Manager User Guide 3. Verify the fingerprint. We recommend that you use GPG to verify the fingerprint even if you use RPM to verify the installer package. rpm -qa gpg-pubkey --qf '%{Description}' | gpg --with-fingerprint | grep -A 1 "[email protected]" This command returns output similar to the following: pub 4096R/D0052E5D 2025-01-22 SSM Agent <[email protected]> Key fingerprint = 4855 A9E6 8332 16D6 A77D 8FE4 51A8 E050 D005 2E5D The fingerprint should match the following. 4855 A9E6 8332 16D6 A77D 8FE4 51A8 E050 D005 2E5D If the fingerprint doesn't match, don't install the agent. Contact AWS Support. 4. Verify the installer package signature. Be sure to replace the agent-download-filename with the values you specified when downloading the agent, as listed in the table earlier in this topic. rpm --checksig agent-download-filename For example, for the x86_64 architecture on Amazon Linux 2: rpm --checksig amazon-ssm-agent.rpm This command returns output similar to the following. amazon-ssm-agent.rpm: rsa sha1 md5 OK If pgp is missing from the output and you have imported the public key, then the agent isn't signed. If the output contains the phrase NOT OK (MISSING KEYS: (MD5) key- id), check whether you performed the procedure correctly and verify you downloaded SSM Agent version 3.1.1141.0 or later. If you continue to get this response, contact Support and don't install the agent. Verifying the signature of SSM Agent 2295 AWS Systems Manager User Guide Verifying the SSM Agent package on a Linux server (v3.3.1611.0 and earlier) Before you begin The procedures for GPG and RPM in this section apply to SSM Agent version 3.3.1611.0 and earlier versions. We recommend always using the latest version of the agent. For information, see Verifying the SSM Agent package on a Linux server (v3.3.1802.0 and later). However, if you have a specific reason to continue using agent version 3.3.1611.0 or earlier, follow the instructions in one of the following procedures. GPG To verify the SSM Agent package on a Linux server (v3.3.1611.0 and earlier) 1. Copy the following public keys and save it to a file named amazon-ssm-agent.gpg. Important The public key shown below expired on 2025-02-17 (February 17, 2025) and works for Version 3.3.1611.0 and earlier versions up to 3.2.1542.0, and only if it was used previously to verify the agent's signature. Systems Manager will publish a new public key in this topic before the old one expires. We encourage you to subscribe to the RSS feed for this topic to get a notification when the new key is available. -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2.0.22 (GNU/Linux) mQENBGTtIoIBCAD2M1aoGIE0FXynAHM/jtuvdAVVaX3Q4ZejTqrX+Jq8ElAMhxyO GzHu2CDtCYxtVxXK3unptLVt2kGgJwNbhYC393jDeZx5dCda4Nk2YXX1UK3P461i axuuXRzMYvfM4RZn+7bJTu635tA07q9Xm6MGD4TCTvsjBfViOxbrxOg5ozWbJdSw fSR8MwUrRfmFpAefRlYfCEuZ8FHywa9U6jLeWt2O/kqrZliJOAGjGzXtB7EZkqKb faCCxikjjvhF1awdEqSK4DQorC/OvQc4I5kP5y2CJbtXvXO73QH2yE75JMDIIx9x rOsIRUoSfK3UrWaOVuAnEEn5ueKzZNqGG1J1ABEBAAG0J1NTTSBBZ2VudCA8c3Nt LWFnZW50LXNpZ25lckBhbWF6b24uY29tPokBPwQTAQIAKQUCZO0iggIbLwUJAsaY gAcLCQgHAwIBBhUIAgkKCwQWAgMBAh4BAheAAAoJELwfSVyX3QTt+icH/A//tJsW I+7Ay8FGJh8dJPNy++HIBjVSFdGNJFWNbw1Z8uZcazHEcUCH3FhW4CLQLTZ3OVPz qvFwzDtRDVIN/Y9EGDhLMFvimrE+/z4olWsJ5DANf6BnX8I5UNIcRt5d8SWH1BEJ 2FWIBZFgKyTDI6XzRC5x4ahtgpOVAGeeKDehs+wh6Ga4W0/K4GsviP1Kyr+Ic2br NAIq0q0IHyN1q9zam3Y0+jKwEuNmTj+Bjyzshyv/X8S0JWWoXJhkexkOvWeBYNNt 5wI4QcSteyfIzp6KlQF8q11Hzz9D9WaPfcBEYyhq7vLEARobkbQMBzpkmaZua241 Verifying the signature of SSM Agent 2296 AWS Systems Manager User Guide 0RaWG50HRvrgm4aJAhwEEAECAAYFAmTtIoMACgkQfdCXo9rX9fwwqBAAzkTgYJ38 sWgxpn7Ux/81F2BWR1sVkmP79i++fXyJlKI8xtcJFQZhzeUos69KBUCy7mgx5bYU P7NA5o9DUbwz/QS0i1Cqm4+jtFlX0MXe4FikXcqfDPnnzN8mVB2H+fa43iHR1PuH GgUWuNdxzSoIYRmLZXWmeN5YXPcmixlhLzcE2TOQn1mOKcu2fKdLtBQ8KiEkmjiu naoLxnUcyk1zMhaha+LzEkQdOyasix0ggylN2ViWVnlmfy0niuXDxW0qZWPdLStF OODiX3iqGmkH3rDfy6nvxxBR4GIs+MGD72fpWzzrINDgkGI2i2t1+0AX/mps3aTy +ftlgrim8stYWB58XXDAb0vad06sNye5/zDzfr0I9HupJrTzFhaYJQjWPaSlINto LDJnBXohiUIPRYRcy/k012oFHDWZHT3H6CyjK9UD5UlxA9H7dsJurANs6FOVRe+7 34uJyxDZ/W7zLG4AVG0zxibrUSoaJxwcOjVPVsQAlrwG/GTs7tcAccsJqbJ1Py/w 9AgJl8VU2qc8POsHNXk348gjP7C8PDnGMpZFzr9f5INctRushpiv7onX+aWJVX7T n2uX/TP3LCyH/MsrNJrJOQnMYFRLQitciP0E+F+eA3v9CY6mDuyb8JSx5HuGGUsG S4bKBOcA8vimEpwPoT8CE7fdsZ3Qkwdu+pw= =zr5w -----END PGP PUBLIC KEY BLOCK----- 2. Import the public key into your keyring, and note the returned key value. gpg --import amazon-ssm-agent.gpg 3. Verify the fingerprint. Be sure to replace key-value with the value from the preceding step. We recommend that you use GPG to verify the fingerprint even if you use RPM to verify the installer package. gpg --fingerprint key-value This command returns output similar to the following. pub 2048R/97DD04ED 2023-08-28 [expired: 2025-02-17] Key fingerprint = DE92 C7DA 3E56 E923 31D6 2A36 BC1F 495C 97DD 04ED uid SSM Agent <[email protected]> The fingerprint should match the following. DE92 C7DA 3E56 E923 31D6 2A36 BC1F 495C 97DD 04ED If the fingerprint doesn't match, don't install the agent. Contact AWS Support. 4. Download the signature file according to your instance's architecture and operating system if you haven't already done so. Verifying the signature of SSM Agent 2297 AWS Systems Manager User Guide 5. Verify the installer package signature. Be sure to replace the signature-filename and agent-download-filename with the values you specified when downloading the signature file and agent, as listed in the table earlier in this topic. gpg --verify signature-filename agent-download-filename For example, for the x86_64 architecture on Amazon Linux 2: gpg
|
systems-manager-ug-665
|
systems-manager-ug.pdf
| 665 |
E923 31D6 2A36 BC1F 495C 97DD 04ED If the fingerprint doesn't match, don't install the agent. Contact AWS Support. 4. Download the signature file according to your instance's architecture and operating system if you haven't already done so. Verifying the signature of SSM Agent 2297 AWS Systems Manager User Guide 5. Verify the installer package signature. Be sure to replace the signature-filename and agent-download-filename with the values you specified when downloading the signature file and agent, as listed in the table earlier in this topic. gpg --verify signature-filename agent-download-filename For example, for the x86_64 architecture on Amazon Linux 2: gpg --verify amazon-ssm-agent.rpm.sig amazon-ssm-agent.rpm This command returns output similar to the following: gpg: Signature made Fri 10 Jan 2025 01:54:18 AM UTC using RSA key ID 97DD04ED gpg: Good signature from "SSM Agent <[email protected]>" gpg: Note: This key has expired! Primary key fingerprint: DE92 C7DA 3E56 E923 31D6 2A36 BC1F 495C 97DD 04ED If the output includes the phrase BAD signature, check whether you performed the procedure correctly. If you continue to get this response, contact Support and don't install the agent. The warning message about the trust doesn't mean that the signature isn't valid, only that you haven't verified the public key. A key is trusted only if you or someone who you trust has signed it. If the output includes the phrase Can't check signature: No public key, verify you downloaded SSM Agent version 3.1.1141.0 or later. RPM To verify the SSM Agent package on a Linux server (v3.3.1611.0 and earlier) 1. Copy the following public key and save it to a file named amazon-ssm-agent.gpg. Important The public key shown below expired on 2025-02-17 (February 17, 2025) and works for Version 3.3.1611.0 and earlier versions up to 3.2.1542.0, and only if it was used previously to verify the agent's signature. Systems Manager will publish a new public key in this topic before the old one expires. We encourage you to subscribe to the RSS feed for this topic to get a notification when the new key is available. Verifying the signature of SSM Agent 2298 AWS Systems Manager User Guide -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2.0.22 (GNU/Linux) mQENBGTtIoIBCAD2M1aoGIE0FXynAHM/jtuvdAVVaX3Q4ZejTqrX+Jq8ElAMhxyO GzHu2CDtCYxtVxXK3unptLVt2kGgJwNbhYC393jDeZx5dCda4Nk2YXX1UK3P461i axuuXRzMYvfM4RZn+7bJTu635tA07q9Xm6MGD4TCTvsjBfViOxbrxOg5ozWbJdSw fSR8MwUrRfmFpAefRlYfCEuZ8FHywa9U6jLeWt2O/kqrZliJOAGjGzXtB7EZkqKb faCCxikjjvhF1awdEqSK4DQorC/OvQc4I5kP5y2CJbtXvXO73QH2yE75JMDIIx9x rOsIRUoSfK3UrWaOVuAnEEn5ueKzZNqGG1J1ABEBAAG0J1NTTSBBZ2VudCA8c3Nt LWFnZW50LXNpZ25lckBhbWF6b24uY29tPokBPwQTAQIAKQUCZO0iggIbLwUJAsaY gAcLCQgHAwIBBhUIAgkKCwQWAgMBAh4BAheAAAoJELwfSVyX3QTt+icH/A//tJsW I+7Ay8FGJh8dJPNy++HIBjVSFdGNJFWNbw1Z8uZcazHEcUCH3FhW4CLQLTZ3OVPz qvFwzDtRDVIN/Y9EGDhLMFvimrE+/z4olWsJ5DANf6BnX8I5UNIcRt5d8SWH1BEJ 2FWIBZFgKyTDI6XzRC5x4ahtgpOVAGeeKDehs+wh6Ga4W0/K4GsviP1Kyr+Ic2br NAIq0q0IHyN1q9zam3Y0+jKwEuNmTj+Bjyzshyv/X8S0JWWoXJhkexkOvWeBYNNt 5wI4QcSteyfIzp6KlQF8q11Hzz9D9WaPfcBEYyhq7vLEARobkbQMBzpkmaZua241 0RaWG50HRvrgm4aJAhwEEAECAAYFAmTtIoMACgkQfdCXo9rX9fwwqBAAzkTgYJ38 sWgxpn7Ux/81F2BWR1sVkmP79i++fXyJlKI8xtcJFQZhzeUos69KBUCy7mgx5bYU P7NA5o9DUbwz/QS0i1Cqm4+jtFlX0MXe4FikXcqfDPnnzN8mVB2H+fa43iHR1PuH GgUWuNdxzSoIYRmLZXWmeN5YXPcmixlhLzcE2TOQn1mOKcu2fKdLtBQ8KiEkmjiu naoLxnUcyk1zMhaha+LzEkQdOyasix0ggylN2ViWVnlmfy0niuXDxW0qZWPdLStF OODiX3iqGmkH3rDfy6nvxxBR4GIs+MGD72fpWzzrINDgkGI2i2t1+0AX/mps3aTy +ftlgrim8stYWB58XXDAb0vad06sNye5/zDzfr0I9HupJrTzFhaYJQjWPaSlINto LDJnBXohiUIPRYRcy/k012oFHDWZHT3H6CyjK9UD5UlxA9H7dsJurANs6FOVRe+7 34uJyxDZ/W7zLG4AVG0zxibrUSoaJxwcOjVPVsQAlrwG/GTs7tcAccsJqbJ1Py/w 9AgJl8VU2qc8POsHNXk348gjP7C8PDnGMpZFzr9f5INctRushpiv7onX+aWJVX7T n2uX/TP3LCyH/MsrNJrJOQnMYFRLQitciP0E+F+eA3v9CY6mDuyb8JSx5HuGGUsG S4bKBOcA8vimEpwPoT8CE7fdsZ3Qkwdu+pw= =zr5w -----END PGP PUBLIC KEY BLOCK----- 2. Import the public key into your keyring, and note the returned key value. rpm --import amazon-ssm-agent.gpg 3. Verify the fingerprint. We recommend that you use GPG to verify the fingerprint even if you use RPM to verify the installer package. rpm -qa gpg-pubkey --qf '%{Description}' | gpg --with-fingerprint | grep -A 1 "[email protected]" Verifying the signature of SSM Agent 2299 AWS Systems Manager User Guide This command returns output similar to the following: pub 2048R/97DD04ED 2023-08-28 SSM Agent <[email protected]> Key fingerprint = DE92 C7DA 3E56 E923 31D6 2A36 BC1F 495C 97DD 04ED The fingerprint should match the following. DE92 C7DA 3E56 E923 31D6 2A36 BC1F 495C 97DD 04ED If the fingerprint doesn't match, don't install the agent. Contact AWS Support. 4. Verify the installer package signature. Be sure to replace the agent-download-filename with the values you specified when downloading the agent, as listed in the table earlier in this topic. rpm --checksig agent-download-filename For example, for the x86_64 architecture on Amazon Linux 2: rpm --checksig amazon-ssm-agent.rpm This command returns output similar to the following. amazon-ssm-agent.rpm: rsa sha1 md5 OK If pgp is missing from the output and you have imported the public key, then the agent isn't signed. If the output contains the phrase NOT OK (MISSING KEYS: (MD5) key- id), check whether you performed the procedure correctly and verify you downloaded SSM Agent version 3.1.1141.0 or later. If you continue to get this response, contact Support and don't install the agent. Manually installing and uninstalling SSM Agent on EC2 instances for Linux Before you manually install AWS Systems Manager Agent (SSM Agent) on an Amazon Elastic Compute Cloud (Amazon EC2) Linux operating system, review the following information. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2300 AWS Systems Manager SSM Agent installation file URLs User Guide You can access the installation files for SSM Agent that are stored in any commercial AWS Region. We also provide installation files in a globally available Amazon Simple Storage Service (Amazon S3) bucket that you can use as an alternative or backup source of files. If you're manually installing the agent on a instance or two, you can use the commands in the Quick installation procedures we provide to save time. The commands provided in these procedures can also be passed to Amazon EC2 instances as scripts through user data. If you're creating a script or template to use for installing the agent on multiple instances, we recommend
|
systems-manager-ug-666
|
systems-manager-ug.pdf
| 666 |
Agent that are stored in any commercial AWS Region. We also provide installation files in a globally available Amazon Simple Storage Service (Amazon S3) bucket that you can use as an alternative or backup source of files. If you're manually installing the agent on a instance or two, you can use the commands in the Quick installation procedures we provide to save time. The commands provided in these procedures can also be passed to Amazon EC2 instances as scripts through user data. If you're creating a script or template to use for installing the agent on multiple instances, we recommend that you use the installation files in or near an AWS Region where you're geographically located. For bulk installations, this can increase the speed of your downloads and reduce latency. In these cases, we recommend using the Create custom installation commands procedures in the installation topics. Amazon Machine Images with the agent preinstalled SSM Agent is preinstalled on some Amazon Machine Images (AMIs) provided by AWS. For information, see Find AMIs with the SSM Agent preinstalled. Installation on other machine types If you need to install the agent on an on-premises server or a virtual machine (VM) so that it can be used with Systems Manager, see How to install the SSM Agent on hybrid Linux nodes. For information about installing the agent on edge devices, see Managing edge devices with Systems Manager. Keeping the agent up to date An updated version of SSM Agent is released whenever new tools are added to Systems Manager or updates are made to existing tools. Failing to use the latest version of the agent can prevent your managed node from using various Systems Manager tools and features. For that reason, we recommend that you automate the process of keeping SSM Agent up to date on your machines. For information, see Automating updates to SSM Agent. Subscribe to the SSM Agent Release Notes page on GitHub to get notifications about SSM Agent updates. Choose your operating system To view the procedure for manually installing SSM Agent on the specified operating system, choose a link from the following list: Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2301 AWS Systems Manager Note User Guide For a list of supported versions of each of the following operating systems, see Supported operating systems for Systems Manager. • AlmaLinux • Amazon Linux 2 and Amazon Linux 2023 • Amazon Linux 1 • CentOS • CentOS Stream • Debian Server • Oracle Linux • Red Hat Enterprise Linux • Rocky Linux • SUSE Linux Enterprise Server • Ubuntu Server Uninstalling SSM Agent from Linux instances Use the package manager for your operating system to uninstall SSM Agent from Linux instances. Depending on the operating system, the uninstall command will be similar to the following example command: sudo dpkg -r amazon-ssm-agent Manually install SSM Agent on AlmaLinux instances Use the information in this section to help you manually install or reinstall SSM Agent on an AlmaLinux instance. Before you begin Before you install SSM Agent on an AlmaLinux instance, note the following: Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2302 AWS Systems Manager User Guide • Ensure that Python 3 is installed on your AlmaLinux instance. This is required in order for SSM Agent to work properly. • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Topics • Quick installation commands for SSM Agent on AlmaLinux • Create custom agent installation commands for AlmaLinux in your Region Quick installation commands for SSM Agent on AlmaLinux Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. Before you begin Before you install SSM Agent on a AlmaLinux instance, note the following: • Ensure that Python 3 is installed on your AlmaLinux instance. This is required in order for SSM Agent to work properly. To install SSM Agent on AlmaLinux 1. Connect to your AlmaLinux instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for AlmaLinux. x86_64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2303 AWS Systems Manager ARM64 instances User Guide sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active
|
systems-manager-ug-667
|
systems-manager-ug.pdf
| 667 |
instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for AlmaLinux. x86_64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2303 AWS Systems Manager ARM64 instances User Guide sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active (running) since Tue 2022-04-19 16:40:41 UTC; 9s ago Main PID: 4898 (amazon-ssm-agen) Tasks: 14 (limit: 4821) Memory: 34.6M CGroup: /system.slice/amazon-ssm-agent.service ##4898 /usr/bin/amazon-ssm-agent ##4954 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: inactive (dead) since Tue 2022-04-19 16:42:05 UTC; 2s ago --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2304 AWS Systems Manager User Guide Create custom agent installation commands for AlmaLinux in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on AlmaLinux earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm ARM64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2305 AWS Systems Manager User Guide Manually installing SSM Agent on Amazon Linux 2 and Amazon Linux 2023 instances Important This topic provides commands for working with SSM Agent on Amazon Linux 2 and Amazon Linux 2023 instances. Some of these commands aren't supported on Amazon Linux 1 instances. Before continuing, ensure you're viewing the correct topic for your instance type. For commands to run on Amazon Linux 1 instances, see Manually installing SSM Agent on Amazon Linux 1 instances. In most cases, the Amazon Machine Images (AMIs) for Amazon Linux 2 and Amazon Linux 2023 that are provided by AWS come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For more information, see Find AMIs with the SSM Agent preinstalled. In the event that SSM Agent isn’t preinstalled on a new Amazon Linux 2 or Amazon Linux 2023 instance, or if you need to manually reinstall the agent, use the information on this page to help you. Before you begin Before you install SSM Agent on an Amazon Linux 2 or Amazon Linux 2023 instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. • If you use a yum command to update SSM Agent on a managed node after the agent has been installed or updated using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Quick installation commands for SSM Agent on Amazon Linux 2 or Amazon Linux 2023 • Create custom agent installation commands for Amazon Linux 2 or Amazon Linux 2023 in your Region Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2306 AWS Systems Manager User Guide Quick installation commands for SSM Agent on Amazon Linux 2 or Amazon Linux 2023 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on Amazon Linux 2 or Amazon Linux 2023 using quick copy and paste commands 1. Connect to your Amazon Linux 2 or Amazon Linux 2023 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Amazon Linux 2 and Amazon Linux 2023. x86_64 sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 sudo yum install -y
|
systems-manager-ug-668
|
systems-manager-ug.pdf
| 668 |
a single instance. This procedure uses globally available installation files. To install SSM Agent on Amazon Linux 2 or Amazon Linux 2023 using quick copy and paste commands 1. Connect to your Amazon Linux 2 or Amazon Linux 2023 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Amazon Linux 2 and Amazon Linux 2023. x86_64 sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2307 AWS Systems Manager User Guide Active: active (running) since Wed 2021-10-20 19:09:29 UTC; 4min 6s ago --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: inactive (dead) since Wed 2021-10-20 22:16:41 UTC; 18s ago --truncated-- To activate the agent in these cases, run the following command. sudo systemctl start amazon-ssm-agent Create custom agent installation commands for Amazon Linux 2 or Amazon Linux 2023 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Amazon Linux 1 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2308 AWS Systems Manager See the following example. User Guide sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm ARM64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Manually installing SSM Agent on Amazon Linux 1 instances Important Amazon Linux 1 reached the end of its standard support on December 31, 2020, and reached end of life on December 31, 2023, as announced in Update on Amazon Linux AMI end-of-life on the AWS News Blog. AWS no longer provides Amazon Machine Images (AMIs) for this operating system. AWS Systems Manager continues to provide support, however, for existing Amazon Linux 1 instances. This topic provides commands for working with SSM Agent on Amazon Linux 1 instances. Some of these commands aren't supported on Amazon Linux 2 and Amazon Linux 2023 instances. Before continuing, verify that you're viewing the correct topic for your instance type. For commands to run on Amazon Linux 2 or Amazon Linux 2023 instances, see Manually installing SSM Agent on Amazon Linux 2 and Amazon Linux 2023 instances. In most cases, the Amazon Machine Images (AMIs) for Amazon Linux 1 that are provided by AWS come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For more information, see Find AMIs with the SSM Agent preinstalled. In the event that you need to manually reinstall the agent on Amazon Linux 1, use the information on this page to help you. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2309 AWS Systems Manager Before you begin User Guide Before you install SSM Agent on an Amazon Linux 1 instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. • If you use a yum command to update SSM Agent on a managed node after the agent has been installed or updated using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Quick installation commands for SSM Agent on Amazon Linux 1 • Create custom agent installation commands for Amazon Linux 1 in your Region Quick installation commands for SSM Agent on Amazon Linux 1 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on Amazon Linux 1 using quick copy and paste commands 1. Connect to
|
systems-manager-ug-669
|
systems-manager-ug.pdf
| 669 |
or updated using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Quick installation commands for SSM Agent on Amazon Linux 1 • Create custom agent installation commands for Amazon Linux 1 in your Region Quick installation commands for SSM Agent on Amazon Linux 1 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on Amazon Linux 1 using quick copy and paste commands 1. Connect to your Amazon Linux 1 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Amazon Linux 1. x86_64 sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2310 AWS Systems Manager x86 User Guide sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_386/amazon-ssm-agent.rpm ARM64 sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the command for your instance’s architecture to verify that the agent is running. x86_64 and x86 sudo status amazon-ssm-agent ARM64 sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following examples. x86_64 and x86 amazon-ssm-agent start/running, process 12345 ARM64 amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: active (running) since Wed 2021-10-20 19:09:29 UTC; 4min 6s ago --truncated-- Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2311 AWS Systems Manager User Guide In rare cases, the command reports that the agent is installed but not running, as shown in the following examples. x86_64 and x86 amazon-ssm-agent stop/waiting ARM64 amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: inactive (dead) since Wed 2021-10-20 22:16:41 UTC; 18s ago --truncated-- To activate the agent in these cases, run the command for your instance's architecture. x86_64 and x86 sudo start amazon-ssm-agent ARM64 sudo systemctl start amazon-ssm-agent Create custom agent installation commands for Amazon Linux 1 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2312 AWS Systems Manager Tip User Guide You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Amazon Linux 1 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm x86 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_386/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_386/amazon-ssm-agent.rpm ARM64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2313 AWS Systems Manager User Guide Manually installing SSM Agent on CentOS instances The Amazon Machine Images (AMIs) for CentOS that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For a list of AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on a CentOS instance. Before you begin Before you install SSM Agent on a CentOS instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. • If you use a yum command to update SSM Agent on a managed node after the agent has been installed or updated using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Install SSM Agent on CentOS 8.x • Install SSM Agent on CentOS 7.x • Install SSM Agent on CentOS 6.x Install SSM Agent on CentOS 8.x The Amazon Machine Images (AMIs) for CentOS 8 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on CentOS 8 instances. Before you
|
systems-manager-ug-670
|
systems-manager-ug.pdf
| 670 |
using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Install SSM Agent on CentOS 8.x • Install SSM Agent on CentOS 7.x • Install SSM Agent on CentOS 6.x Install SSM Agent on CentOS 8.x The Amazon Machine Images (AMIs) for CentOS 8 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on CentOS 8 instances. Before you begin Before you install SSM Agent on a CentOS 8 instance, note the following: • Ensure that either Python 2 or Python 3 is installed on your CentOS 8 instance. This is required in order for SSM Agent to work properly. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2314 AWS Systems Manager Topics User Guide • Quick installation commands for SSM Agent on CentOS 8 • Create custom agent installation commands for CentOS 8 in your Region Quick installation commands for SSM Agent on CentOS 8 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on CentOS 8.x 1. Connect to your CentOS 8 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for CentOS 8. x86_64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2315 AWS Systems Manager User Guide Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active (running) since Tue 2022-04-19 15:48:54 UTC; 19s ago --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; disabled; vend> Active: inactive (dead) --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for CentOS 8 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on CentOS 8 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2316 AWS Systems Manager x86_64 User Guide sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm ARM64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Install SSM Agent on CentOS 7.x The Amazon Machine Images (AMIs) for CentOS 7 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on CentOS 7 instances. Topics • Quick installation commands for SSM Agent on CentOS 7 • Create custom agent installation commands for CentOS 7 in your Region Quick installation commands for SSM Agent on CentOS 7 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on CentOS 7.x 1. Connect to your CentOS 7 instance using your preferred method, such as SSH. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2317 AWS Systems Manager User Guide 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for CentOS 7. x86_64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is
|
systems-manager-ug-671
|
systems-manager-ug.pdf
| 671 |
method, such as SSH. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2317 AWS Systems Manager User Guide 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for CentOS 7. x86_64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: disabled) Active: active (running) since Tue 2022-04-19 15:57:27 UTC; 6s ago --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: disabled) Active: inactive (dead) since Tue 2022-04-19 15:58:44 UTC; 2s ago --truncated-- Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2318 AWS Systems Manager User Guide To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for CentOS 7 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on CentOS 7 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm ARM64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2319 AWS Systems Manager See the following example. User Guide sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Install SSM Agent on CentOS 6.x The Amazon Machine Images (AMIs) for CentOS 6 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on CentOS 6 instances. Topics • Quick installation commands for SSM Agent on CentOS 6 • Create custom agent installation commands for CentOS 6 in your Region Quick installation commands for SSM Agent on CentOS 6 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on CentOS 6.x 1. Connect to your CentOS 6 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for CentOS 6. The following commands specify the version directory 3.0.1479.0 instead of a latest directory. This is because SSM Agent version 3.1 and later are not supported for CentOS 6. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2320 AWS Systems Manager x86_64 instances User Guide sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/ SSMAgent/3.0.1479.0/linux_amd64/amazon-ssm-agent.rpm x86 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/ SSMAgent/3.0.1479.0/linux_386/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. amazon-ssm-agent start/running, process 1744 In rare cases, the command reports that the agent is installed but not running, as shown in the following example. amazon-ssm-agent stop/waiting To activate the agent in these cases, run the following command. sudo start amazon-ssm-agent Create custom agent installation commands for CentOS 6 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2321 AWS Systems Manager Tip User Guide You can also replace a global URL in the procedure Quick installation commands for SSM Agent on CentOS 6 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values,
|
systems-manager-ug-672
|
systems-manager-ug.pdf
| 672 |
recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2321 AWS Systems Manager Tip User Guide You can also replace a global URL in the procedure Quick installation commands for SSM Agent on CentOS 6 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. Note The following commands specify the version directory 3.0.1479.0 instead of a latest directory. This is because SSM Agent version 3.1 and later are not supported for CentOS 6. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/3.0.1479.0/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/3.0.1479.0/linux_amd64/amazon-ssm-agent.rpm x86 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/3.0.1479.0/ linux_386/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/3.0.1479.0/linux_386/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2322 AWS Systems Manager User Guide Manually install SSM Agent on CentOS Stream instances The Amazon Machine Images (AMIs) for CentOS Stream that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For a list of AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on a CentOS Stream instance. Before you begin Before you install SSM Agent on a CentOS Stream instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Topics • Quick installation commands for SSM Agent on CentOS Stream • Create custom agent installation commands for CentOS Stream in your Region Quick installation commands for SSM Agent on CentOS Stream Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. Before you begin Before you install SSM Agent on a CentOS Stream instance, note the following: • Ensure that either Python 2 or Python 3 is installed on your CentOS Stream 8 instance. This is required in order for SSM Agent to work properly. To install SSM Agent on CentOS Stream 1. Connect to your CentOS Stream instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2323 AWS Systems Manager Note User Guide Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for CentOS Stream. x86_64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active (running) since Tue 2022-04-19 16:40:41 UTC; 9s ago Main PID: 4898 (amazon-ssm-agen) Tasks: 14 (limit: 4821) Memory: 34.6M CGroup: /system.slice/amazon-ssm-agent.service ##4898 /usr/bin/amazon-ssm-agent ##4954 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2324 AWS Systems Manager User Guide Active: inactive (dead) since Tue 2022-04-19 16:42:05 UTC; 2s ago --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for CentOS Stream in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on CentOS Stream earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux
|
systems-manager-ug-673
|
systems-manager-ug.pdf
| 673 |
bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on CentOS Stream earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2325 AWS Systems Manager ARM64 User Guide sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Manually installing SSM Agent on Debian Server instances The Amazon Machine Images (AMIs) for Debian Server that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For a list of AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on a Debian Server instance. Before you begin Before you install SSM Agent on a Debian Server instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Topics • Quick installation commands for SSM Agent on Debian Server • Create custom agent installation commands for Debian Server in your Region Quick installation commands for SSM Agent on Debian Server Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on Debian Server 1. Connect to your Debian Server instance using your preferred method, such as SSH. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2326 AWS Systems Manager User Guide 2. Run the following command to create a temporary directory on the instance. mkdir /tmp/ssm 3. Run the following command to change to the temporary directory. cd /tmp/ssm 4. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Debian Server. For Debian Server 8, only the x86_64 architecture is supported. x86_64 instances wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/ debian_amd64/amazon-ssm-agent.deb ARM64 instances wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/ debian_arm64/amazon-ssm-agent.deb 5. Run the following command. sudo dpkg -i amazon-ssm-agent.deb 6. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2327 AWS Systems Manager User Guide Active: active (running) since Tue 2022-04-19 16:25:03 UTC; 4s ago Main PID: 628 (amazon-ssm-agen) CGroup: /system.slice/amazon-ssm-agent.service ##628 /usr/bin/amazon-ssm-agent ##650 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor Active: inactive (dead) since Tue 2022-04-19 16:26:30 UTC; 5s ago Main PID: 628 (code=exited, status=0/SUCCESS) --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for Debian Server in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Debian Server earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2328 AWS Systems Manager Note For Debian Server 8, only the x86_64 architecture is supported. User Guide x86_64 wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/debian_amd64/amazon- ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/debian_amd64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb ARM64 wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/debian_arm64/amazon- ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/debian_arm64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2329 AWS Systems Manager User Guide Manually installing SSM Agent on Oracle Linux instances The Amazon Machine Images (AMIs) for Oracle Linux that are provided by AWS do
|
systems-manager-ug-674
|
systems-manager-ug.pdf
| 674 |
Agent on EC2 instances for Linux 2328 AWS Systems Manager Note For Debian Server 8, only the x86_64 architecture is supported. User Guide x86_64 wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/debian_amd64/amazon- ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/debian_amd64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb ARM64 wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/debian_arm64/amazon- ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/debian_arm64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2329 AWS Systems Manager User Guide Manually installing SSM Agent on Oracle Linux instances The Amazon Machine Images (AMIs) for Oracle Linux that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For a list of AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on an Oracle Linux instance. Before you begin Before you install SSM Agent on an Oracle Linux instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. • If you use a yum command to update SSM Agent on a managed node after the agent has been installed or updated using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Quick installation commands for SSM Agent on Oracle Linux • Create custom agent installation commands for Oracle Linux in your Region Quick installation commands for SSM Agent on Oracle Linux Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on Oracle Linux using quick copy and paste commands 1. Connect to your Oracle Linux instance using your preferred method, such as SSH. 2. Copy the following command and run it on the instance. Note Even though URL in the following command includes an ec2-downloads-windows directory, these are the correct global installation files for Oracle Linux. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2330 AWS Systems Manager x86_64 User Guide sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: active (running) since Wed 2021-10-20 19:09:29 UTC; 4min 6s ago --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled) Active: inactive (dead) since Wed 2021-10-20 22:16:41 UTC; 18s ago --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for Oracle Linux in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2331 AWS Systems Manager User Guide For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Oracle Linux earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm Manually installing SSM Agent on Red Hat Enterprise Linux instances The Amazon Machine Images (AMIs) for Red Hat Enterprise Linux (RHEL) that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For a list of AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on a RHEL instance. Before you begin Before you install SSM Agent on a RHEL instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2332 AWS Systems Manager User Guide • If you
|
systems-manager-ug-675
|
systems-manager-ug.pdf
| 675 |
AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on a RHEL instance. Before you begin Before you install SSM Agent on a RHEL instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2332 AWS Systems Manager User Guide • If you use a yum command to update SSM Agent on a managed node after the agent has been installed or updated using the SSM document AWS-UpdateSSMAgent, you might see the following message: "Warning: RPMDB altered outside of yum." This message is expected and can be safely ignored. Topics • Install SSM Agent on RHEL 8.x and 9.x • Install SSM Agent on RHEL 7.x • Install SSM Agent on RHEL 6.x Install SSM Agent on RHEL 8.x and 9.x The Amazon Machine Images (AMIs) for RHEL 8 and 9 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on RHEL 8 and 9 instances. Before you begin Before you install SSM Agent on a RHEL 8 or 9 instance, note the following: • Ensure that either Python 2 or Python 3 is installed on your RHEL 8 or 9 instance. This is required in order for SSM Agent to work properly. Topics • Quick installation commands for SSM Agent on RHEL 8 or 9 • Create custom agent installation commands for RHEL 8 and 9 in your Region Quick installation commands for SSM Agent on RHEL 8 or 9 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on RHEL 8.x or 9.x 1. Connect to your RHEL 8 or 9 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2333 AWS Systems Manager Note User Guide Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for RHEL 8 and 9. x86_64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active (running) since Tue 2022-04-19 16:40:41 UTC; 9s ago Main PID: 4898 (amazon-ssm-agen) Tasks: 14 (limit: 4821) Memory: 34.6M CGroup: /system.slice/amazon-ssm-agent.service ##4898 /usr/bin/amazon-ssm-agent ##4954 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2334 AWS Systems Manager User Guide Active: inactive (dead) since Tue 2022-04-19 16:42:05 UTC; 2s ago --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for RHEL 8 and 9 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on RHEL 8 or 9 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2335 AWS Systems Manager ARM64 User Guide sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Install SSM Agent on RHEL 7.x The Amazon Machine Images (AMIs) for RHEL 7 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on RHEL
|
systems-manager-ug-676
|
systems-manager-ug.pdf
| 676 |
Reference. x86_64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2335 AWS Systems Manager ARM64 User Guide sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Install SSM Agent on RHEL 7.x The Amazon Machine Images (AMIs) for RHEL 7 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on RHEL 7 instances. Topics • Quick installation commands for SSM Agent on RHEL 7 • Create custom agent installation commands for RHEL 7 in your Region Quick installation commands for SSM Agent on RHEL 7 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on RHEL 7.x 1. Connect to your RHEL 7 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for RHEL 7. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2336 AWS Systems Manager x86_64 instances User Guide sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm ARM64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: disabled) Active: active (running) since Tue 2022-04-19 16:47:36 UTC; 22s ago Main PID: 1342 (amazon-ssm-agen) CGroup: /system.slice/amazon-ssm-agent.service ##1342 /usr/bin/amazon-ssm-agent ##1362 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: disabled) Active: inactive (dead) since Tue 2022-04-19 16:48:56 UTC; 5s ago Process: 1342 ExecStart=/usr/bin/amazon-ssm-agent (code=exited, status=0/SUCCESS) Main PID: 1342 (code=exited, status=0/SUCCESS) --truncated-- To activate the agent in these cases, run the following commands. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2337 AWS Systems Manager User Guide sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for RHEL 7 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on RHEL 7 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm ARM64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2338 AWS Systems Manager User Guide sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Install SSM Agent on RHEL 6.x The Amazon Machine Images (AMIs) for RHEL 6 that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. Use the information on this page to help you install or reinstall the agent on RHEL 6 instances. Topics • Quick installation commands for SSM Agent on RHEL 6 • Create custom agent installation commands for RHEL 6 in your Region Quick installation commands for SSM Agent on RHEL 6 Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on RHEL 6.x 1. Connect to your RHEL 6 instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for RHEL 6. The following commands specify the version directory 3.0.1479.0 instead of a latest directory. This is because SSM Agent version 3.1 and later are not supported for RHEL 6. x86_64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/ SSMAgent/3.0.1479.0/linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2339 AWS Systems Manager x86 instances User Guide sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/ SSMAgent/3.0.1479.0/linux_386/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to
|
systems-manager-ug-677
|
systems-manager-ug.pdf
| 677 |
for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for RHEL 6. The following commands specify the version directory 3.0.1479.0 instead of a latest directory. This is because SSM Agent version 3.1 and later are not supported for RHEL 6. x86_64 instances sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/ SSMAgent/3.0.1479.0/linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2339 AWS Systems Manager x86 instances User Guide sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/ SSMAgent/3.0.1479.0/linux_386/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. amazon-ssm-agent start/running, process 1788 In rare cases, the command reports that the agent is installed but not running, as shown in the following example. amazon-ssm-agent stop/waiting To activate the agent in these cases, run the following command. sudo start amazon-ssm-agent Create custom agent installation commands for RHEL 6 in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on RHEL 6 earlier in this topic with a custom Regional URL you construct. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2340 AWS Systems Manager User Guide In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. Note The following commands specify the version directory 3.0.1479.0 instead of a latest directory. This is because SSM Agent version 3.1 and later are not supported for RHEL 6. x86_64 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/3.0.1479.0/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/3.0.1479.0/linux_amd64/amazon-ssm-agent.rpm x86 sudo yum install -y https://s3.region.amazonaws.com/amazon-ssm-region/3.0.1479.0/ linux_386/amazon-ssm-agent.rpm See the following example. sudo yum install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/3.0.1479.0/linux_386/amazon-ssm-agent.rpm Manually install SSM Agent on Rocky Linux instances The Amazon Machine Images (AMIs) for Rocky Linux that are provided by AWS do not come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For a list of AWS managed AMIs on which the agent might be preinstalled, see Find AMIs with the SSM Agent preinstalled. Use the information in this section to help you manually install or reinstall SSM Agent on an Rocky Linux instance. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2341 AWS Systems Manager Before you begin User Guide Before you install SSM Agent on a Rocky Linux instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Topics • Quick installation commands for SSM Agent on Rocky Linux • Create custom agent installation commands for Rocky Linux in your Region Quick installation commands for SSM Agent on Rocky Linux Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. Before you begin Before you install SSM Agent on a Rocky Linux instance, note the following: • Ensure that either Python 2 or Python 3 is installed on your Rocky Linux instance. This is required in order for SSM Agent to work properly. To install SSM Agent on Rocky Linux 1. Connect to your Rocky Linux instance using your preferred method, such as SSH. 2. Copy the command for your instance’s architecture and run it on the instance. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Rocky Linux. x86_64 instances sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_amd64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2342 AWS Systems Manager ARM64 instances User Guide sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/ latest/linux_arm64/amazon-ssm-agent.rpm 3. (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active (running) since Tue 2022-04-19 16:40:41 UTC; 9s ago Main PID: 4898 (amazon-ssm-agen) Tasks: 14 (limit: 4821) Memory: 34.6M CGroup: /system.slice/amazon-ssm-agent.service ##4898 /usr/bin/amazon-ssm-agent ##4954 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: inactive (dead) since Tue 2022-04-19 16:42:05 UTC; 2s
|
systems-manager-ug-678
|
systems-manager-ug.pdf
| 678 |
that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: active (running) since Tue 2022-04-19 16:40:41 UTC; 9s ago Main PID: 4898 (amazon-ssm-agen) Tasks: 14 (limit: 4821) Memory: 34.6M CGroup: /system.slice/amazon-ssm-agent.service ##4898 /usr/bin/amazon-ssm-agent ##4954 /usr/bin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/etc/systemd/system/amazon-ssm-agent.service; enabled; vendo> Active: inactive (dead) since Tue 2022-04-19 16:42:05 UTC; 2s ago --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2343 AWS Systems Manager User Guide Create custom agent installation commands for Rocky Linux in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Rocky Linux earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. x86_64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_amd64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_amd64/amazon-ssm-agent.rpm ARM64 sudo dnf install -y https://s3.region.amazonaws.com/amazon-ssm-region/latest/ linux_arm64/amazon-ssm-agent.rpm See the following example. sudo dnf install -y https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ linux_arm64/amazon-ssm-agent.rpm Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2344 AWS Systems Manager User Guide Manually install SSM Agent on SUSE Linux Enterprise Server instances In most cases, the Amazon Machine Images (AMIs) for SUSE Linux Enterprise Server (SLES) that are provided by AWS come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For more information, see Find AMIs with the SSM Agent preinstalled. In the event that SSM Agent isn’t preinstalled on a new SLES instance, or if you need to manually reinstall the agent, use the information on this page to help you. Before you begin Before you install SSM Agent on a SLES instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Topics • Quick installation commands for SSM Agent on SLES • Create custom agent installation commands for SLES in your Region Quick installation commands for SSM Agent on SLES Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on SLES using quick copy and paste commands 1. Connect to your SLES instance using your preferred method, such as SSH. 2. Option 1: Use a zypper command: • Run the following command: sudo zypper install amazon-ssm-agent • Enter y in response to any prompts. Option 2: Use an rpm command. • Create a temporary directory on the instance. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2345 AWS Systems Manager User Guide mkdir /tmp/ssm • Change to the temporary directory. cd /tmp/ssm • Run the following commands one at a time to download and run the SSM Agent installer. Note Even though URLs in the following commands include an ec2-downloads- windows directory, these are the correct global installation files for SLES. x86_64 instances: wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/ amazon-ssm-agent.rpm ARM64 instances: wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_arm64/ amazon-ssm-agent.rpm • Run the following command. sudo rpm --install amazon-ssm-agent.rpm • (Recommended) Run the following command to verify that the agent is running. sudo systemctl status amazon-ssm-agent In most cases, the command reports that the agent is running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: disabled) Active: active (running) since Mon 2022-02-21 23:13:28 UTC; 7s ago Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2346 AWS Systems Manager User Guide Main PID: 2102 (amazon-ssm-agen) Tasks: 15 (limit: 512) CGroup: /system.slice/amazon-ssm-agent.service ##2102 /usr/sbin/amazon-ssm-agent ##2107 /usr/sbin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; disabled; vendor preset: disabled) Active: inactive (dead) --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for SLES in your Region When you install SSM Agent on multiple instances using a script or template, we
|
systems-manager-ug-679
|
systems-manager-ug.pdf
| 679 |
Linux 2346 AWS Systems Manager User Guide Main PID: 2102 (amazon-ssm-agen) Tasks: 15 (limit: 512) CGroup: /system.slice/amazon-ssm-agent.service ##2102 /usr/sbin/amazon-ssm-agent ##2107 /usr/sbin/ssm-agent-worker --truncated-- In rare cases, the command reports that the agent is installed but not running, as shown in the following example. # amazon-ssm-agent.service - amazon-ssm-agent Loaded: loaded (/usr/lib/systemd/system/amazon-ssm-agent.service; disabled; vendor preset: disabled) Active: inactive (dead) --truncated-- To activate the agent in these cases, run the following commands. sudo systemctl enable amazon-ssm-agent sudo systemctl start amazon-ssm-agent Create custom agent installation commands for SLES in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Amazon Linux 1 earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2347 AWS Systems Manager x86_64 User Guide wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/linux_amd64/amazon- ssm-agent.rpm sudo rpm --install amazon-ssm-agent.rpm See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/linux_amd64/ amazon-ssm-agent.rpm sudo rpm --install amazon-ssm-agent.rpm ARM64 wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/linux_arm64/amazon- ssm-agent.rpm sudo rpm --install amazon-ssm-agent.rpm See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/linux_arm64/ amazon-ssm-agent.rpm sudo rpm --install amazon-ssm-agent.rpm Manually installing SSM Agent on Ubuntu Server instances Important Before you install SSM Agent on a 64-bit version of Ubuntu Server, ensure that you are using the correct installation tools. Beginning with Amazon Machine Images (AMIs) that are identified with 20180627, SSM Agent is pre-installed on version 16.04 using Snap Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2348 AWS Systems Manager User Guide packages. On instances created from earlier AMIs, SSM Agent must be installed using deb installer packages. For more information, see Determining the correct SSM Agent version to install on 64-bit Ubuntu Server 16.04 instances. In most cases, the Amazon Machine Images (AMIs) for Ubuntu Server that are provided by AWS come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For more information, see Find AMIs with the SSM Agent preinstalled. In the event that SSM Agent isn’t preinstalled on a new Ubuntu Server instance, or if you need to manually reinstall the agent, use the information in this section to help you. Before you begin Before you install SSM Agent on an Ubuntu Server instance, note the following: • For important information that applies to installation of SSM Agent on all Linux-based operating systems, see Manually installing and uninstalling SSM Agent on EC2 instances for Linux. Topics • Install SSM Agent on Ubuntu Server 22.04 LTS, 20.10 STR & 20.04, 18.04, and 16.04 LTS 64-bit (Snap) • Install SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb) • Install SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit • Determining the correct SSM Agent version to install on 64-bit Ubuntu Server 16.04 instances Install SSM Agent on Ubuntu Server 22.04 LTS, 20.10 STR & 20.04, 18.04, and 16.04 LTS 64-bit (Snap) Before you begin Before you install SSM Agent on an Ubuntu Server 22.04 LTS, 20.10 STR & 20.04, 18.04, and 16.04 LTS 64-bit (Snap), note the following: Version 16.04 installation by Snaps or deb installers On Ubuntu Server 16.04, SSM Agent is installed using either Snaps or deb installation packages, depending on the version of the 16.04 AMI. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2349 AWS Systems Manager SSM Agent installer files locations User Guide On Ubuntu Server22.04 LTS, 20.10 STR & 20.04, 18.04, and 16.04 LTS (with Snap), SSM Agent installer files, including agent binaries and config files, are stored in the following directory: / snap/amazon-ssm-agent/current/. If you make changes to any configuration files in this directory, then you must copy these files from the /snap directory to the /etc/amazon/ssm/ directory. Log and library files haven't changed (/var/lib/amazon/ssm, /var/log/amazon/ ssm). Using the Snap candidate channel The candidate channel in the Snap store contains the latest version of SSM Agent (including all of the latest bug fixes); not the stable channel. To learn more about the differences between the candidate and stable channels, see Risk-levels at https://snapcraft.io/docs/channels. If you want to track SSM Agent version information on the candidate channel, run the following command on your Ubuntu Server 20.10 STR & 20.04, 18.04, and 16.04 LTS 64-bit instances. sudo snap switch --channel=candidate amazon-ssm-agent Snaps recommended on versions 18.04 and later On Ubuntu Server 22.04 LTS, 20.10 STR & 20.04 and 18.04 LTS, we recommend you only use Snaps. Also
|
systems-manager-ug-680
|
systems-manager-ug.pdf
| 680 |
in the Snap store contains the latest version of SSM Agent (including all of the latest bug fixes); not the stable channel. To learn more about the differences between the candidate and stable channels, see Risk-levels at https://snapcraft.io/docs/channels. If you want to track SSM Agent version information on the candidate channel, run the following command on your Ubuntu Server 20.10 STR & 20.04, 18.04, and 16.04 LTS 64-bit instances. sudo snap switch --channel=candidate amazon-ssm-agent Snaps recommended on versions 18.04 and later On Ubuntu Server 22.04 LTS, 20.10 STR & 20.04 and 18.04 LTS, we recommend you only use Snaps. Also verify that only one instance of the agent is installed and running on your instances. If you want to use SSM Agent without Snaps, uninstall the SSM Agent. Then install the SSM Agent as a debian package using the instructions for installing SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb). Before installing, ensure you don't have any Snaps installed that overlap with the list of packages you want managed as debian packages. Maximum timeout exceeded error message Because of a known issue with Snap, you might see a Maximum timeout exceeded error with snap commands. If you get this error, run the following commands one at a time to start the agent, stop it, and check its status: sudo systemctl start snap.amazon-ssm-agent.amazon-ssm-agent.service sudo systemctl stop snap.amazon-ssm-agent.amazon-ssm-agent.service sudo systemctl status snap.amazon-ssm-agent.amazon-ssm-agent.service Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2350 AWS Systems Manager User Guide To install SSM Agent on Ubuntu Server 22.04 LTS, 20.10 STR & 20.04, 18.04, and 16.04 LTS 64- bit instances (with Snap package) 1. SSM Agent is installed, by default, on Ubuntu Server 22.04 LTS, 20.04, 18.04, and 16.04 LTS 64-bit AMIs with an identifier of 20180627 or later. You can use the following script if you need to install SSM Agent on an on-premises server or if you need to reinstall the agent. You don't need to specify a URL for the download, because the snap command automatically downloads the agent from the Snap app store at https:// snapcraft.io. sudo snap install amazon-ssm-agent --classic 2. Run the following command to determine if SSM Agent is running. sudo snap list amazon-ssm-agent 3. Run the following command to start the service if the previous command returned amazon- ssm-agent is stopped, inactive, or disabled. sudo snap start amazon-ssm-agent 4. Check the status of the agent. sudo snap services amazon-ssm-agent Install SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb) Important Before you install SSM Agent on a 64-bit version of Ubuntu Server, ensure that you are using the correction installation tools. Beginning with Amazon Machine Images (AMIs) that are identified with 20180627, SSM Agent is pre-installed on version 16.04 using Snap packages. On instances created from earlier AMIs, SSM Agent must be installed using deb installer packages. For more information, see Determining the correct SSM Agent version to install on 64-bit Ubuntu Server 16.04 instances.If SSM Agent is installed on your instance in conjunction with a Snap and you install or update SSM Agent using a deb installer package, the installation or SSM Agent operations might fail. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2351 AWS Systems Manager User Guide In most cases, the Amazon Machine Images (AMIs) Ubuntu Server 16.04 that are provided by AWS come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For more information, see Find AMIs with the SSM Agent preinstalled. In the event that SSM Agent isn’t preinstalled on a new Ubuntu Server 16.04 instance prior to version 20180627, you are installing on Ubuntu Server 14.04, or you need to manually reinstall the agent, use the information on this page to help you. Quick installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb) Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. To install SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb) using quick copy and paste commands 1. Connect to your Ubuntu Server instance using your preferred method, such as SSH. 2. Run the following command to create a temporary directory on the instance. mkdir /tmp/ssm 3. Change to the temporary directory. cd /tmp/ssm 4. Run the following commands. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Ubuntu Server 16.04 and 14.04 64-bit. wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb 5. (Recommended) Run one of the following commands to determine if SSM Agent is running. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2352 AWS Systems Manager Ubuntu Server 16.04 User Guide sudo systemctl status amazon-ssm-agent Ubuntu Server 14.04 sudo status amazon-ssm-agent In most cases, the command
|
systems-manager-ug-681
|
systems-manager-ug.pdf
| 681 |
the instance. mkdir /tmp/ssm 3. Change to the temporary directory. cd /tmp/ssm 4. Run the following commands. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Ubuntu Server 16.04 and 14.04 64-bit. wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb 5. (Recommended) Run one of the following commands to determine if SSM Agent is running. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2352 AWS Systems Manager Ubuntu Server 16.04 User Guide sudo systemctl status amazon-ssm-agent Ubuntu Server 14.04 sudo status amazon-ssm-agent In most cases, the command reports that the agent is running. In rare cases, the command reports that the agent is installed but not running, as shown in the following example. 6. Run one of the following commands to start the service if the previous command returned amazon-ssm-agent is stopped, inactive, or disabled. Ubuntu Server 16.04: sudo systemctl enable amazon-ssm-agent Ubuntu Server 14.04: sudo start amazon-ssm-agent Create custom installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb) in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2353 AWS Systems Manager Tip User Guide You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 64-bit (deb) earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/debian_amd64/amazon-ssm- agent.deb sudo dpkg -i amazon-ssm-agent.deb See the following example. wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/debian_amd64/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb Install SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit In most cases, the Amazon Machine Images (AMIs) Ubuntu Server 16.04 that are provided by AWS come with AWS Systems Manager Agent (SSM Agent) preinstalled by default. For more information, see Find AMIs with the SSM Agent preinstalled. In the event that SSM Agent isn’t preinstalled on a new Ubuntu Server 16.04 instance, you are installing on Ubuntu Server 14.04, or you need to manually reinstall the agent, use the information on this page to help you. Quick installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit (deb) Use the following steps to manually install SSM Agent on a single instance. This procedure uses globally available installation files. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2354 AWS Systems Manager User Guide To install SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit (deb) using quick copy and paste commands 1. Connect to your Ubuntu Server instance using your preferred method, such as SSH. 2. Run the following command to create a temporary directory on the instance. mkdir /tmp/ssm 3. Change to the temporary directory. cd /tmp/ssm 4. Run the following commands. Note Even though URLs in the following commands include an ec2-downloads-windows directory, these are the correct global installation files for Ubuntu Server 16.04 and 14.04 32-bit. wget https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_386/ amazon-ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb 5. (Recommended) Run one of the following commands to determine if SSM Agent is running. Ubuntu Server 16.04 sudo systemctl status amazon-ssm-agent Ubuntu Server 14.04 sudo status amazon-ssm-agent In most cases, the command reports that the agent is running. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2355 AWS Systems Manager User Guide In rare cases, the command reports that the agent is installed but not running, as shown in the following example. 6. Run one of the following commands to start the service if the previous command returned amazon-ssm-agent is stopped, inactive, or disabled. Ubuntu Server 16.04: sudo systemctl enable amazon-ssm-agent Ubuntu Server 14.04: sudo start amazon-ssm-agent Create custom installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit (deb) in your Region When you install SSM Agent on multiple instances using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit (deb) earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems
|
systems-manager-ug-682
|
systems-manager-ug.pdf
| 682 |
using a script or template, we recommend using installation files that are stored in the AWS Region you're working in. For the following commands, we provide examples that use a publicly accessible S3 bucket in the US East (Ohio) Region (us-east-2). Tip You can also replace a global URL in the procedure Quick installation commands for SSM Agent on Ubuntu Server 16.04 and 14.04 32-bit (deb) earlier in this topic with a custom Regional URL you construct. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/debian_386/amazon-ssm- agent.deb sudo dpkg -i amazon-ssm-agent.deb Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2356 AWS Systems Manager See the following example. User Guide wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/debian_386/amazon- ssm-agent.deb sudo dpkg -i amazon-ssm-agent.deb Determining the correct SSM Agent version to install on 64-bit Ubuntu Server 16.04 instances Important Before you install SSM Agent on a 64-bit version of Ubuntu Server, ensure that you are using the correction installation tools. Beginning with Amazon Machine Images (AMIs) that are identified with 20180627, SSM Agent is pre-installed on version 16.04 using Snap packages. On instances created from earlier AMIs, SSM Agent must be installed using deb installer packages. For more information, see Determining the correct SSM Agent version to install on 64-bit Ubuntu Server 16.04 instances Be aware that if an instance has more than one installation of the SSM Agent (for example, one installed using a Snap and one installed using a deb installer), your agent operations won't work correctly. You can verify the source AMI ID creation date for an instance using either of the following methods. These procedures apply only to AWS managed AMIs. Verify a source AMI ID creation date (console) 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. 3. In the left navigation pane, choose Instances. Select an instance. 4. On the Details tab, check for a YYYYMMDD identifier in the value under AMI name field. For example: ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server-20180627. Verify a source AMI ID creation date (AWS CLI) • Run the following command. Manually installing and uninstalling SSM Agent on EC2 instances for Linux 2357 AWS Systems Manager User Guide aws ec2 describe-images --image-ids ami-id ami-id represents the ID of an AMI provided by AWS, such as ami-07c8bc5c1ce9598c3. If successful, the command returns information like the following, in which you can check the CreationDate and Name fields for information. { "Images": [ { "Architecture": "x86_64", "CreationDate": "2020-07-24T20:40:27.000Z", "ImageId": "ami-07c8bc5c1ce9598c3", -- truncated -- "ImageOwnerAlias": "amazon", "Name": "amzn2-ami-hvm-2.0.20200722.0-x86_64-gp2", "RootDeviceName": "/dev/xvda", "RootDeviceType": "ebs", "SriovNetSupport": "simple", "VirtualizationType": "hvm" } ] } Configuring SSM Agent to use a proxy on Linux nodes You can configure AWS Systems Manager Agent (SSM Agent) to communicate through an HTTP proxy by creating an override configuration file and adding http_proxy, https_proxy, and no_proxy settings to the file. An override file also preserves the proxy settings if you install newer or older versions of SSM Agent. This section includes procedures for creating an override file in both upstart and systemd environments. If you intend to use Session Manager, note that HTTPS proxy servers aren't supported. Topics • Configure SSM Agent to use a proxy (upstart) • Configure SSM Agent to use a proxy (systemd) Configuring SSM Agent to use a proxy on Linux nodes 2358 AWS Systems Manager User Guide Configure SSM Agent to use a proxy (upstart) Use the following procedure to create an override configuration file for an upstart environment. To configure SSM Agent to use a proxy (upstart) 1. Connect to the managed instance where you installed SSM Agent. 2. Open a simple editor like VIM, and depending on whether you're using an HTTP proxy server or HTTPS proxy server, add one of the following configurations. For an HTTP proxy server: env http_proxy=http://hostname:port env https_proxy=http://hostname:port env no_proxy=IP address for instance metadata services (IMDS) For an HTTPS proxy server: env http_proxy=http://hostname:port env https_proxy=https://hostname:port env no_proxy=IP address for instance metadata services (IMDS) Important Add the no_proxy setting to the file and specify the IP address. The IP address for no_proxy is the instance metadata services (IMDS) endpoint for Systems Manager. If you don't specify no_proxy, calls to Systems Manager take on the identity from the proxy service (if IMDSv1 fallback is enabled) or calls to Systems Manager fail (if IMDSv2 is enforced). • For IPv4, specify no_proxy=169.254.169.254. • For IPv6, specify no_proxy=[fd00:ec2::254]. The IPv6 address of the instance metadata service is compatible with IMDSv2 commands. The IPv6 address is only accessible on instances built on the AWS Nitro System. For more information, see How Instance Metadata Service Version 2 works in the Amazon EC2 User Guide. 3. Save the file with the name amazon-ssm-agent.override in the following location: /etc/ init/ Configuring SSM Agent to
|
systems-manager-ug-683
|
systems-manager-ug.pdf
| 683 |
no_proxy, calls to Systems Manager take on the identity from the proxy service (if IMDSv1 fallback is enabled) or calls to Systems Manager fail (if IMDSv2 is enforced). • For IPv4, specify no_proxy=169.254.169.254. • For IPv6, specify no_proxy=[fd00:ec2::254]. The IPv6 address of the instance metadata service is compatible with IMDSv2 commands. The IPv6 address is only accessible on instances built on the AWS Nitro System. For more information, see How Instance Metadata Service Version 2 works in the Amazon EC2 User Guide. 3. Save the file with the name amazon-ssm-agent.override in the following location: /etc/ init/ Configuring SSM Agent to use a proxy on Linux nodes 2359 AWS Systems Manager User Guide 4. Stop and restart SSM Agent using the following commands. sudo service stop amazon-ssm-agent sudo service start amazon-ssm-agent Note For more information about working with .override files in Upstart environments, see init: Upstart init daemon job configuration. Configure SSM Agent to use a proxy (systemd) Use the following procedure to configure SSM Agent to use a proxy in a systemd environment. Note Some of the steps in this procedure contain explicit instructions for Ubuntu Server instances where SSM Agent was installed using Snap. 1. Connect to the instance where you installed SSM Agent. 2. Run one of the follow commands, depending on the operating system type. • On Ubuntu Server instances where SSM Agent is installed by using a snap: sudo systemctl edit snap.amazon-ssm-agent.amazon-ssm-agent On other operating systems: sudo systemctl edit amazon-ssm-agent 3. Open a simple editor like VIM, and depending on whether you're using an HTTP proxy server or HTTPS proxy server, add one of the following configurations. Ensure that you enter the information above the comment that says "### Lines below this comment will be discarded", as indicated in the following image. Configuring SSM Agent to use a proxy on Linux nodes 2360 AWS Systems Manager User Guide For an HTTP proxy server: [Service] Environment="http_proxy=http://hostname:port" Environment="https_proxy=http://hostname:port" Environment="no_proxy=IP address for instance metadata services (IMDS)" For an HTTPS proxy server: [Service] Environment="http_proxy=http://hostname:port" Environment="https_proxy=https://hostname:port" Environment="no_proxy=IP address for instance metadata services (IMDS)" Important Add the no_proxy setting to the file and specify the IP address. The IP address for no_proxy is the instance metadata services (IMDS) endpoint for Systems Manager. If you don't specify no_proxy, calls to Systems Manager take on the identity from the proxy service (if IMDSv1 fallback is enabled) or calls to Systems Manager fail (if IMDSv2 is enforced). • For IPv4, specify no_proxy=169.254.169.254. • For IPv6, specify no_proxy=[fd00:ec2::254]. The IPv6 address of the instance metadata service is compatible with IMDSv2 commands. The IPv6 address is only Configuring SSM Agent to use a proxy on Linux nodes 2361 AWS Systems Manager User Guide accessible on instances built on the AWS Nitro System. For more information, see How Instance Metadata Service Version 2 works in the Amazon EC2 User Guide. 4. Save your changes. The system automatically creates one of the following files, depending on the operating system type. • On Ubuntu Server instances where SSM Agent is installed by using a snap: /etc/systemd/system/snap.amazon-ssm-agent.amazon-ssm- agent.service.d/override.conf • On Amazon Linux 2 and Amazon Linux 2023 instances: /etc/systemd/system/amazon-ssm-agent.service.d/override.conf • On other operating systems: /etc/systemd/system/amazon-ssm-agent.service.d/amazon-ssm- agent.override 5. Restart SSM Agent by using one of the following commands, depending on the operating system type. • On Ubuntu Server instances installed by using a snap: sudo systemctl daemon-reload && sudo systemctl restart snap.amazon-ssm- agent.amazon-ssm-agent • On other operating systems: sudo systemctl daemon-reload && sudo systemctl restart amazon-ssm-agent Note For more information about working with .override files in systemd environments, see Modifying Existing Unit Files in the Red Hat Enterprise Linux 7 System Administrator's Guide. Configuring SSM Agent to use a proxy on Linux nodes 2362 AWS Systems Manager User Guide Working with SSM Agent on EC2 instances for macOS AWS Systems Manager (SSM Agent) processes Systems Manager requests and configures your machine as specified in the request. Use the following procedures to install, configure, or uninstall SSM Agent for macOS. Note SSM Agent is preinstalled, by default, on Amazon Machine Images (AMIs) for macOS. You don't need to install SSM Agent on an Amazon Elastic Compute Cloud (Amazon EC2) instance for macOS unless you have uninstalled it. The source code for SSM Agent is available on GitHub so that you can adapt the agent to meet your needs. We encourage you to submit pull requests for changes that you would like to have included. However, AWS doesn't provide support for running modified copies of this software. Note To view details about the different versions of SSM Agent, see the release notes. Before you manually install SSM Agent on a macOS operating system, review the following information. • SSM Agent is installed by default on the EC2 instances and Amazon Machine Images supported by Systems Manager. For more information, see the list of supported
|
systems-manager-ug-684
|
systems-manager-ug.pdf
| 684 |
is available on GitHub so that you can adapt the agent to meet your needs. We encourage you to submit pull requests for changes that you would like to have included. However, AWS doesn't provide support for running modified copies of this software. Note To view details about the different versions of SSM Agent, see the release notes. Before you manually install SSM Agent on a macOS operating system, review the following information. • SSM Agent is installed by default on the EC2 instances and Amazon Machine Images supported by Systems Manager. For more information, see the list of supported operating systems for macOS. SSM Agent doesn't need to be manually installed on macOS EC2 instances unless it has been uninstalled. • EC2 instances for macOS are not supported in all AWS Regions. For lists of Regions where x86- based and M1 EC2 instances for macOS are supported, see macOS workloads in the Amazon EC2 FAQs. • An updated version of SSM Agent is released whenever new tools are added to Systems Manager or updates are made to existing tools. Failing to use the latest version of the agent can prevent your managed node from using various Systems Manager tools and features. For that reason, we recommend that you automate the process of keeping SSM Agent up to date on your machines. Working with SSM Agent on EC2 instances for macOS 2363 AWS Systems Manager User Guide For information, see Automating updates to SSM Agent. Subscribe to the SSM Agent Release Notes page on GitHub to get notifications about SSM Agent updates. Topics • Manually installing and uninstalling SSM Agent on EC2 instances for macOS Manually installing and uninstalling SSM Agent on EC2 instances for macOS Connect to your macOS instance and perform the following steps to install AWS Systems Manager Agent (SSM Agent). Perform these steps on each instance that will run commands using Systems Manager. The commands provided in this procedure can also be passed to Amazon EC2 instances as scripts through user data. Before you begin Install wget using Homebrew. To install SSM Agent on macOS 1. Download the agent installer file for x86_64 instances using the following command. In the following command, replace region with your own information. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. sudo wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/darwin_amd64/ amazon-ssm-agent.pkg For Apple silicon instances use the following command. sudo wget https://s3.region.amazonaws.com/amazon-ssm-region/latest/darwin_arm64/ amazon-ssm-agent.pkg Here is an example. sudo wget https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/latest/ darwin_amd64/amazon-ssm-agent.pkg Manually installing and uninstalling SSM Agent on EC2 instances for macOS 2364 AWS Systems Manager User Guide 2. Use the following command to run the SSM Agent installer. x86_64: sudo installer -pkg amazon-ssm-agent.pkg -target / 3. Check the status of the agent. To determine if SSM Agent is running, check the agent log at /var/log/amazon/ssm/ amazon-ssm-agent.log . 4. Run the following command to start the service if the the agent log indicates that "amazon- ssm-agent is stopped." sudo launchctl load -w /Library/LaunchDaemons/com.amazon.aws.ssm.plist && sudo launchctl start com.amazon.aws.ssm Important An updated version of SSM Agent is released whenever new tools are added to Systems Manager or updates are made to existing tools. Failing to use the latest version of the agent can prevent your managed node from using various Systems Manager tools and features. For that reason, we recommend that you automate the process of keeping SSM Agent up to date on your machines. For information, see Automating updates to SSM Agent. Subscribe to the SSM Agent Release Notes page on GitHub to get notifications about SSM Agent updates. Uninstall SSM Agent from macOS instances macOS doesn't natively support uninstallation of PKG files. To uninstall AWS Systems Manager Agent (SSM Agent) from an Amazon Elastic Compute Cloud (Amazon EC2) instance for macOS, you can use the AWS managed script from the following location. https://github.com/aws/amazon-ssm-agent/blob/mainline/Tools/src/update/darwin/uninstall.sh Manually installing and uninstalling SSM Agent on EC2 instances for macOS 2365 AWS Systems Manager User Guide Working with SSM Agent on EC2 instances for Windows Server AWS Systems Manager Agent (SSM Agent) is preinstalled, by default, on the Amazon Machine Images (AMIs) for Windows Server that are provided by AWS. Support is provided for the following operating system (OS) versions. • Windows Server 2008-2012 R2 AMIs published in November 2016 or later • Windows Server 2016, 2019, 2022 (excluding Nano versions), and 2025 Support notes for previous versions Windows Server AMIs published before November 2016 use the EC2Config service to process requests and configure instances. Unless you have a specific reason for using the EC2Config service, or an earlier version of SSM Agent, to process Systems Manager requests, we recommend that you download and install the latest version of SSM Agent to each of your Amazon Elastic Compute Cloud (Amazon EC2) instances or non-EC2 machines that are
|
systems-manager-ug-685
|
systems-manager-ug.pdf
| 685 |
system (OS) versions. • Windows Server 2008-2012 R2 AMIs published in November 2016 or later • Windows Server 2016, 2019, 2022 (excluding Nano versions), and 2025 Support notes for previous versions Windows Server AMIs published before November 2016 use the EC2Config service to process requests and configure instances. Unless you have a specific reason for using the EC2Config service, or an earlier version of SSM Agent, to process Systems Manager requests, we recommend that you download and install the latest version of SSM Agent to each of your Amazon Elastic Compute Cloud (Amazon EC2) instances or non-EC2 machines that are configured for Systems Manager in a hybrid and multicloud environment. As of January 14, 2020, Windows Server 2008 is no longer supported for feature or security updates from Microsoft. Legacy Amazon Machine Images (AMIs) for Windows Server 2008 and 2008 R2 still include version 2 of SSM Agent preinstalled, but Systems Manager no longer officially supports 2008 versions and no longer updates the agent for these versions of Windows Server. In addition, SSM Agent version 3 might not be compatible with all operations on Windows Server 2008 and 2008 R2. The final officially supported version of SSM Agent for Windows Server 2008 versions is 2.3.1644.0. Keeping SSM Agent up to date An updated version of SSM Agent is released whenever new tools are added to Systems Manager or updates are made to existing tools. Failing to use the latest version of the agent can prevent your managed node from using various Systems Manager tools and features. For that reason, we recommend that you automate the process of keeping SSM Agent up to date on your machines. For information, see Automating updates to SSM Agent. Subscribe to the SSM Agent Release Notes page on GitHub to get notifications about SSM Agent updates. To view details about the different versions of SSM Agent, see the release notes. Working with SSM Agent on EC2 instances for Windows Server 2366 AWS Systems Manager Topics User Guide • Manually installing and uninstalling SSM Agent on EC2 instances for Windows Server • Configure SSM Agent to use a proxy for Windows Server instances Manually installing and uninstalling SSM Agent on EC2 instances for Windows Server AWS Systems Manager Agent (SSM Agent) is preinstalled, by default, on the following Amazon Machine Images (AMIs) for Windows Server provided by Amazon: • Windows Server 2008-2012 R2 AMIs published in November 2016 or later • Windows Server 2016, 2019, 2022 (excluding Nano versions), and 2025 Install SSM Agent on EC2 instances for Windows Server If necessary, you can manually download and install the latest version of SSM Agent on your Amazon Elastic Compute Cloud (Amazon EC2) instance for Windows Server by using the following procedure. The commands provided in this procedure can also be passed to Amazon EC2 instances as scripts through user data. SSM Agent requires Windows PowerShell 3.0 or later to run certain AWS Systems Manager documents (SSM documents) on Windows Server instances (for example, the legacy AWS- ApplyPatchBaseline document). Verify that your Windows Server instances are running Windows Management Framework 3.0 or later. This framework includes Windows PowerShell. For more information, see Windows Management Framework 3.0. Note This procedure applies to installing or reinstalling SSM Agent on an EC2 instance for Windows Server. If you need to install the agent on an on-premises server or a virtual machine (VM) so it can be used with Systems Manager, see How to install the SSM Agent on hybrid Windows nodes. Manually installing and uninstalling SSM Agent on EC2 instances for Windows Server 2367 AWS Systems Manager User Guide To manually install the latest version of SSM Agent on EC2 instances for Windows Server 1. Connect to your instance by using Remote Desktop or Windows PowerShell. For more information, see Connect to your instance in the Amazon EC2 User Guide. 2. Download the latest version of SSM Agent to your instance. You can download using either PowerShell commands or a direct download link. Note The URLs in this step let you download SSM Agent from any AWS Region. If you want to download the agent from a specific Region, use a Region-specific URL instead: https://amazon-ssm-region.s3.region.amazonaws.com/latest/ windows_amd64/AmazonSSMAgentSetup.exe region represents the identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. PowerShell Run the following three PowerShell commands in order. These commands allow you to download SSM Agent without adjusting Internet Explorer (IE) Enhanced Security settings, and then install the agent and remove the installation file. 64-bit [System.Net.ServicePointManager]::SecurityProtocol = 'TLS12' $progressPreference = 'silentlyContinue' Invoke-WebRequest ` https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/ windows_amd64/AmazonSSMAgentSetup.exe ` -OutFile $env:USERPROFILE\Desktop\SSMAgent_latest.exe 32-bit [System.Net.ServicePointManager]::SecurityProtocol = 'TLS12' $progressPreference = 'silentlyContinue' Invoke-WebRequest ` Manually
|
systems-manager-ug-686
|
systems-manager-ug.pdf
| 686 |
for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. PowerShell Run the following three PowerShell commands in order. These commands allow you to download SSM Agent without adjusting Internet Explorer (IE) Enhanced Security settings, and then install the agent and remove the installation file. 64-bit [System.Net.ServicePointManager]::SecurityProtocol = 'TLS12' $progressPreference = 'silentlyContinue' Invoke-WebRequest ` https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/ windows_amd64/AmazonSSMAgentSetup.exe ` -OutFile $env:USERPROFILE\Desktop\SSMAgent_latest.exe 32-bit [System.Net.ServicePointManager]::SecurityProtocol = 'TLS12' $progressPreference = 'silentlyContinue' Invoke-WebRequest ` Manually installing and uninstalling SSM Agent on EC2 instances for Windows Server 2368 AWS Systems Manager User Guide https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/ windows_386/AmazonSSMAgentSetup.exe ` -OutFile $env:USERPROFILE\Desktop\SSMAgent_latest.exe Start-Process ` -FilePath $env:USERPROFILE\Desktop\SSMAgent_latest.exe ` -ArgumentList "/S" ` -Wait rm -Force $env:USERPROFILE\Desktop\SSMAgent_latest.exe Direct download Download the latest version of SSM Agent to your instance by using the following link. If you want, update this URL with an AWS Region-specific URL. https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/windows_amd64/ AmazonSSMAgentSetup.exe Run the downloaded AmazonSSMAgentSetup.exe file to install SSM Agent. 3. Start or restart SSM Agent by sending the following command in PowerShell: Restart-Service AmazonSSMAgent Note To uninstall the SSM Agent from a Windows Server instance, open Control Panel, Programs. Choose the Uninstall a program option. Open the context (right-click) menu for Amazon SSM Agent and choose Uninstall. Configure SSM Agent to use a proxy for Windows Server instances The information in this topic applies to Windows Server instances created on or after November 2016 that do not use the Nano installation option. If you intend to use Session Manager, note that HTTPS proxy servers aren't supported. Configure SSM Agent to use a proxy for Windows Server instances 2369 AWS Systems Manager Note User Guide As of January 14, 2020, Windows Server 2008 is no longer supported for feature or security updates from Microsoft. Legacy Amazon Machine Images (AMIs) for Windows Server 2008 and 2008 R2 still include version 2 of SSM Agent preinstalled, but Systems Manager no longer officially supports 2008 versions and no longer updates the agent for these versions of Windows Server. In addition, SSM Agent version 3 might not be compatible with all operations on Windows Server 2008 and 2008 R2. The final officially supported version of SSM Agent for Windows Server 2008 versions is 2.3.1644.0. Before you begin Before you configure SSM Agent to use a proxy, note the following important information. In the following procedure, you run a command to configure SSM Agent to use a proxy. The command includes a no_proxy setting with an IP address. The IP address is the instance metadata services (IMDS) endpoint for Systems Manager. If you don't specify no_proxy, calls to Systems Manager take on the identity from the proxy service (if IMDSv1 fallback is enabled) or calls to Systems Manager fail (if IMDSv2 is enforced). • For IPv4, specify no_proxy=169.254.169.254. • For IPv6, specify no_proxy=[fd00:ec2::254]. The IPv6 address of the instance metadata service is compatible with IMDSv2 commands. The IPv6 address is only accessible on instances built on the AWS Nitro System. For more information, see How Instance Metadata Service Version 2 works in the Amazon EC2 User Guide. To configure SSM Agent to use a proxy 1. Using Remote Desktop or Windows PowerShell, connect to the instance that you would like to configure to use a proxy. 2. Run the following command block in PowerShell. Replace hostname and port with the information about your proxy. $serviceKey = "HKLM:\SYSTEM\CurrentControlSet\Services\AmazonSSMAgent" $keyInfo = (Get-Item -Path $serviceKey).GetValue("Environment") $proxyVariables = @("http_proxy=hostname:port", "https_proxy=hostname:port", "no_proxy=IP address for instance metadata services (IMDS)") Configure SSM Agent to use a proxy for Windows Server instances 2370 AWS Systems Manager User Guide if ($keyInfo -eq $null) { New-ItemProperty -Path $serviceKey -Name Environment -Value $proxyVariables - PropertyType MultiString -Force } else { Set-ItemProperty -Path $serviceKey -Name Environment -Value $proxyVariables } Restart-Service AmazonSSMAgent After running the preceding command, you can review the SSM Agent logs to confirm the proxy settings were applied. Entries in the logs look similar to the following. For more information about SSM Agent logs, see Viewing SSM Agent logs. 2020-02-24 15:31:54 INFO Getting IE proxy configuration for current user: The operation completed successfully. 2020-02-24 15:31:54 INFO Getting WinHTTP proxy default configuration: The operation completed successfully. 2020-02-24 15:31:54 INFO Proxy environment variables: 2020-02-24 15:31:54 INFO http_proxy: hostname:port 2020-02-24 15:31:54 INFO https_proxy: hostname:port 2020-02-24 15:31:54 INFO no_proxy: IP address for instance metadata services (IMDS) 2020-02-24 15:31:54 INFO Starting Agent: amazon-ssm-agent - v2.3.871.0 2020-02-24 15:31:54 INFO OS: windows, Arch: amd64 To reset SSM Agent proxy configuration 1. Using Remote Desktop or Windows PowerShell, connect to the instance to configure. 2. If you connected using Remote Desktop, launch PowerShell as an administrator. 3. Run the following command block in PowerShell. Remove-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\Services\AmazonSSMAgent - Name Environment Restart-Service AmazonSSMAgent SSM Agent proxy setting precedence When configuring proxy
|
systems-manager-ug-687
|
systems-manager-ug.pdf
| 687 |
operation completed successfully. 2020-02-24 15:31:54 INFO Proxy environment variables: 2020-02-24 15:31:54 INFO http_proxy: hostname:port 2020-02-24 15:31:54 INFO https_proxy: hostname:port 2020-02-24 15:31:54 INFO no_proxy: IP address for instance metadata services (IMDS) 2020-02-24 15:31:54 INFO Starting Agent: amazon-ssm-agent - v2.3.871.0 2020-02-24 15:31:54 INFO OS: windows, Arch: amd64 To reset SSM Agent proxy configuration 1. Using Remote Desktop or Windows PowerShell, connect to the instance to configure. 2. If you connected using Remote Desktop, launch PowerShell as an administrator. 3. Run the following command block in PowerShell. Remove-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\Services\AmazonSSMAgent - Name Environment Restart-Service AmazonSSMAgent SSM Agent proxy setting precedence When configuring proxy settings for the SSM Agent on Windows Server instances, it's important to understand these settings are evaluated and applied to the agent configuration when the Configure SSM Agent to use a proxy for Windows Server instances 2371 AWS Systems Manager User Guide SSM Agent is started. How you configure your proxy settings for a Windows Server instance can determine whether other settings might supersede your intended settings. The agent uses the first proxy settings it finds. Important SSM Agent communicates using the HTTPS protocol. For this reason, you must configure the HTTPS proxy parameter by using one of the following settings options. SSM Agent proxy settings are evaluated in the following order. 1. AmazonSSMAgent Registry settings (HKLM:\SYSTEM\CurrentControlSet\Services \AmazonSSMAgent) 2. System environment variables (http_proxy, https_proxy, no_proxy) 3. LocalSystem user account environment variables http_proxy, https_proxy, no_proxy) 4. Browser settings (HTTP, secure, exceptions) 5. WinHTTP proxy settings (http=, https=, bypass-list=) SSM Agent proxy settings and Systems Manager services If you configured the SSM Agent to use a proxy and are using AWS Systems Manager tools, such as Run Command and Patch Manager, that use PowerShell or the Windows Update client during their execution on Windows Server instances, configure additional proxy settings. Otherwise, the operation might fail because proxy settings used by PowerShell and the Windows Update client aren't inherited from the SSM Agent proxy configuration. For Run Command, configure WinINet proxy settings on your Windows Server instances. The [System.Net.WebRequest] commands provided are per-session. To apply these configurations to subsequent network commands that are run in Run Command, these commands must precede other PowerShell commands in the same aws:runPowershellScript plugin input. The following PowerShell commands return the current WinINet proxy settings, and apply your proxy settings to WinINet. [System.Net.WebRequest]::DefaultWebProxy Configure SSM Agent to use a proxy for Windows Server instances 2372 AWS Systems Manager User Guide $proxyServer = "http://hostname:port" $proxyBypass = "169.254.169.254" $WebProxy = New-Object System.Net.WebProxy($proxyServer,$true,$proxyBypass) [System.Net.WebRequest]::DefaultWebProxy = $WebProxy For Patch Manager, configure system-wide proxy settings so the Windows Update client can scan for and download updates. We recommend that you use Run Command to run the following commands because they run on the SYSTEM account, and the settings apply system-wide. The following netsh commands return the current proxy settings, and apply your proxy settings to the local system. netsh winhttp show proxy netsh winhttp set proxy proxy-server="hostname:port" bypass-list="169.254.169.254" For more information about using Run Command, see AWS Systems Manager Run Command. Checking SSM Agent status and starting the agent This topic lists the commands to check whether AWS Systems Manager Agent (SSM Agent) is running on each supported operating system. It also provides the commands to start the agent if it isn't running. Operating system Command to check SSM Agent status Command to start SSM Agent Amazon Linux 1 sudo status amazon-ss sudo start amazon-ss m-agent m-agent Amazon Linux 2, Amazon Linux 2022, and Amazon Linux 2023 sudo systemctl status sudo systemctl enable amazon-ssm-agent amazon-ssm-agent sudo systemctl start amazon-ssm-agent CentOS 6.x sudo status amazon-ss sudo start amazon-ss m-agent m-agent Checking SSM Agent status and starting the agent 2373 AWS Systems Manager Operating system Command to check SSM Agent status Command to start SSM Agent User Guide CentOS 7.x and CentOS 8.x sudo systemctl status sudo systemctl enable amazon-ssm-agent amazon-ssm-agent sudo systemctl start amazon-ssm-agent Debian Server 8, 9, and 10 sudo systemctl status sudo systemctl enable amazon-ssm-agent amazon-ssm-agent macOS Check the agent log file at / sudo launchctl load - var/log/amazon/ssm/ w /Library/LaunchDae amazon-ssm-agent.log mons/com.amazon.aw sudo systemctl start amazon-ssm-agent s.ssm.plist sudo launchctl start com.amazon.aws.ssm Oracle Linux sudo systemctl status sudo systemctl enable amazon-ssm-agent amazon-ssm-agent sudo systemctl start amazon-ssm-agent Red Hat Enterprise Linux (RHEL) 6.x Red Hat Enterprise Linux (RHEL) 7.x, 8.x, and 9.x sudo status amazon-ss sudo start amazon-ss m-agent m-agent sudo systemctl status sudo systemctl enable amazon-ssm-agent amazon-ssm-agent sudo systemctl start amazon-ssm-agent Checking SSM Agent status and starting the agent 2374 AWS Systems Manager Operating system Command to check SSM Agent status Command to start SSM Agent User Guide SUSE Linux Enterprise Server (SLES) sudo systemctl status sudo systemctl enable amazon-ssm-agent amazon-ssm-agent sudo systemctl start amazon-ssm-agent Ubuntu Server 14.04 (all) and 16.04 (32-bit) sudo status amazon-ss sudo start amazon-ss m-agent m-agent Ubuntu Server 16.04 64- bit instances (deb package installation) sudo systemctl status
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.