deployable_patch_snapshot_for_instances
Creates, updates, deletes, gets or lists a deployable_patch_snapshot_for_instances resource.
Overview
| Name | deployable_patch_snapshot_for_instances |
| Type | Resource |
| Id | aws.ssm.deployable_patch_snapshot_for_instances |
Fields
The following fields are returned by SELECT queries:
- get_deployable_patch_snapshot_for_instance
| Name | Datatype | Description |
|---|---|---|
instance_id | string | The managed node ID. (pattern: <code>(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)</code>) |
product | string | Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot. |
snapshot_download_url | string | A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot. |
snapshot_id | string | The user-defined snapshot ID. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_deployable_patch_snapshot_for_instance | select | region | Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document). If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_deployable_patch_snapshot_for_instance
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document). If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.
SELECT
instance_id,
product,
snapshot_download_url,
snapshot_id
FROM aws.ssm.deployable_patch_snapshot_for_instances
WHERE region = '{{ region }}' -- required
;