@aws-lite/ssm

> Official aws-lite plugin for SSM

> Maintained by: @architect

Install

``sh
npm i @aws-lite/ssm
`

Optionally install types:

`sh
npm i -D @aws-lite/ssm-types
`

Reference

Reference documentation with examples at aws-lite.org

Methods

$3

Canonical AWS API doc

Properties:
- Name (string) [required]
- The name of the parameter

$3

Canonical AWS API doc

Properties:
- Names (array) [required]
- Array of parameter names to delete

$3

Canonical AWS API doc

Properties:
- Name (string) [required]
- The name of the parameter
- WithDecryption (boolean)
- Decrypt encrypted parameter values

$3

Canonical AWS API doc

Properties:
- Names (array) [required]
- Array of parameter names to query
- WithDecryption (boolean)
- Decrypt encrypted parameter values

$3

Canonical AWS API doc

Properties:
- Path (string) [required]
- Parameter path hierarchy, beginning with /
- MaxResults (number)
- Limit the maximum number of items returned
- NextToken (string)
- Pagination token to start the next set of results
- ParameterFilters (array)
- Array of filters to limit results
- Recursive (boolean)
- Retrieve all parameters within a hierarchy
- WithDecryption (boolean)
- Decrypt encrypted parameter values
- paginate (boolean)
- Enable automatic result pagination; use this instead of making your own individual pagination requests

$3

Canonical AWS API doc

Properties:
- Name (string) [required]
- The name of the parameter, including the complete path hierarchy
- Value (string) [required]
- Value of the parameter; can be up to 4KB by default, or 8KB if Advanced
- AllowedPattern (string)
- Regular expression used to validate the parameter value
- DataType (string)
- Data type for a String parameter; can be one of: text, aws:ec2:image, aws:ssm:integration
- Description (string)
- Description of the parameter
- KeyId (string)
- AWS KMS ID to use to encrypt the parameter
- Overwrite (boolean)
- Overwrite an existing parameter (defaults to false)
- Policies (array)
- Array of policies to apply; supports Expiration, ExpirationNotification, NoChangeNotification
- More details (AWS)
- Tags (array)
- Array of tags, such as Key=OS,Value=macOS
- More details (AWS)
- Tier (string)
- Parameter tier; can be one of: Standard, Advanced, Intelligent-Tiering
- More details (AWS)
- Type (string)
- Parameter type; can be one of: String, StringList,SecureString

$3

> Please help out by opening a PR!

- AddTagsToResource
- AssociateOpsItemRelatedItem
- CancelCommand
- CancelMaintenanceWindowExecution
- CreateActivation
- CreateAssociation
- CreateAssociationBatch
- CreateDocument
- CreateMaintenanceWindow
- CreateOpsItem
- CreateOpsMetadata
- CreatePatchBaseline
- CreateResourceDataSync
- DeleteActivation
- DeleteAssociation
- DeleteDocument
- DeleteInventory
- DeleteMaintenanceWindow
- DeleteOpsMetadata
- DeletePatchBaseline
- DeleteResourceDataSync
- DeleteResourcePolicy
- DeregisterManagedInstance
- DeregisterPatchBaselineForPatchGroup
- DeregisterTargetFromMaintenanceWindow
- DeregisterTaskFromMaintenanceWindow
- DescribeActivations
- DescribeAssociation
- DescribeAssociationExecutions
- DescribeAssociationExecutionTargets
- DescribeAutomationExecutions
- DescribeAutomationStepExecutions
- DescribeAvailablePatches
- DescribeDocument
- DescribeDocumentPermission
- DescribeEffectiveInstanceAssociations
- DescribeEffectivePatchesForPatchBaseline
- DescribeInstanceAssociationsStatus
- DescribeInstanceInformation
- DescribeInstancePatches
- DescribeInstancePatchStates
- DescribeInstancePatchStatesForPatchGroup
- DescribeInventoryDeletions
- DescribeMaintenanceWindowExecutions
- DescribeMaintenanceWindowExecutionTaskInvocations
- DescribeMaintenanceWindowExecutionTasks
- DescribeMaintenanceWindows
- DescribeMaintenanceWindowSchedule
- DescribeMaintenanceWindowsForTarget
- DescribeMaintenanceWindowTargets
- DescribeMaintenanceWindowTasks
- DescribeOpsItems
- DescribeParameters
- DescribePatchBaselines
- DescribePatchGroups
- DescribePatchGroupState
- DescribePatchProperties
- DescribeSessions
- DisassociateOpsItemRelatedItem
- GetAutomationExecution
- GetCalendarState
- GetCommandInvocation
- GetConnectionStatus
- GetDefaultPatchBaseline
- GetDeployablePatchSnapshotForInstance
- GetDocument
- GetInventory
- GetInventorySchema
- GetMaintenanceWindow
- GetMaintenanceWindowExecution
- GetMaintenanceWindowExecutionTask
- GetMaintenanceWindowExecutionTaskInvocation
- GetMaintenanceWindowTask
- GetOpsItem
- GetOpsMetadata
- GetOpsSummary
- GetParameterHistory
- GetPatchBaseline
- GetPatchBaselineForPatchGroup
- GetResourcePolicies
- GetServiceSetting
- LabelParameterVersion
- ListAssociations
- ListAssociationVersions
- ListCommandInvocations
- ListCommands
- ListComplianceItems
- ListComplianceSummaries
- ListDocumentMetadataHistory
- ListDocuments
- ListDocumentVersions
- ListInventoryEntries
- ListOpsItemEvents
- ListOpsItemRelatedItems
- ListOpsMetadata
- ListResourceComplianceSummaries
- ListResourceDataSync
- ListTagsForResource
- ModifyDocumentPermission
- PutComplianceItems
- PutInventory
- PutResourcePolicy
- RegisterDefaultPatchBaseline
- RegisterPatchBaselineForPatchGroup
- RegisterTargetWithMaintenanceWindow
- RegisterTaskWithMaintenanceWindow
- RemoveTagsFromResource
- ResetServiceSetting
- ResumeSession
- SendAutomationSignal
- SendCommand
- StartAssociationsOnce
- StartAutomationExecution
- StartChangeRequestExecution
- StartSession
- StopAutomationExecution
- TerminateSession
- UnlabelParameterVersion
- UpdateAssociation
- UpdateAssociationStatus
- UpdateDocument
- UpdateDocumentDefaultVersion
- UpdateDocumentMetadata
- UpdateMaintenanceWindow
- UpdateMaintenanceWindowTarget
- UpdateMaintenanceWindowTask
- UpdateManagedInstanceRole
- UpdateOpsItem
- UpdateOpsMetadata
- UpdatePatchBaseline
- UpdateResourceDataSync
- UpdateServiceSetting


Learn more

- More information about the aws-lite plugin API
- Learn about contributing to this and other aws-lite` plugins