@aws-lite/ssm
v0.2.5
Published
Official `aws-lite` plugin for SSM
Downloads
8,849
Readme
@aws-lite/ssm
Official
aws-liteplugin for SSM
Maintained by: @architect
Install
npm i @aws-lite/ssmOptionally install types:
npm i -D @aws-lite/ssm-typesReference
Reference documentation with examples at aws-lite.org
Methods
DeleteParameter
Properties:
Name(string) [required]- The name of the parameter
DeleteParameters
Properties:
Names(array) [required]- Array of parameter names to delete
GetParameter
Properties:
Name(string) [required]- The name of the parameter
WithDecryption(boolean)- Decrypt encrypted parameter values
GetParameters
Properties:
Names(array) [required]- Array of parameter names to query
WithDecryption(boolean)- Decrypt encrypted parameter values
GetParametersByPath
Properties:
Path(string) [required]- Parameter path hierarchy, beginning with
/
- 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
PutParameter
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
Stringparameter; can be one of:text,aws:ec2:image,aws:ssm:integration
- Data type for a
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)
- Overwrite an existing parameter (defaults to
Policies(array)- Array of policies to apply; supports
Expiration,ExpirationNotification,NoChangeNotification - More details (AWS)
- Array of policies to apply; supports
Tags(array)- Array of tags, such as
Key=OS,Value=macOS - More details (AWS)
- Array of tags, such as
Tier(string)- Parameter tier; can be one of:
Standard,Advanced,Intelligent-Tiering - More details (AWS)
- Parameter tier; can be one of:
Type(string)- Parameter type; can be one of:
String,StringList,SecureString
- Parameter type; can be one of:
Methods yet to be implemented
Please help out by opening a PR!
AddTagsToResourceAssociateOpsItemRelatedItemCancelCommandCancelMaintenanceWindowExecutionCreateActivationCreateAssociationCreateAssociationBatchCreateDocumentCreateMaintenanceWindowCreateOpsItemCreateOpsMetadataCreatePatchBaselineCreateResourceDataSyncDeleteActivationDeleteAssociationDeleteDocumentDeleteInventoryDeleteMaintenanceWindowDeleteOpsMetadataDeletePatchBaselineDeleteResourceDataSyncDeleteResourcePolicyDeregisterManagedInstanceDeregisterPatchBaselineForPatchGroupDeregisterTargetFromMaintenanceWindowDeregisterTaskFromMaintenanceWindowDescribeActivationsDescribeAssociationDescribeAssociationExecutionsDescribeAssociationExecutionTargetsDescribeAutomationExecutionsDescribeAutomationStepExecutionsDescribeAvailablePatchesDescribeDocumentDescribeDocumentPermissionDescribeEffectiveInstanceAssociationsDescribeEffectivePatchesForPatchBaselineDescribeInstanceAssociationsStatusDescribeInstanceInformationDescribeInstancePatchesDescribeInstancePatchStatesDescribeInstancePatchStatesForPatchGroupDescribeInventoryDeletionsDescribeMaintenanceWindowExecutionsDescribeMaintenanceWindowExecutionTaskInvocationsDescribeMaintenanceWindowExecutionTasksDescribeMaintenanceWindowsDescribeMaintenanceWindowScheduleDescribeMaintenanceWindowsForTargetDescribeMaintenanceWindowTargetsDescribeMaintenanceWindowTasksDescribeOpsItemsDescribeParametersDescribePatchBaselinesDescribePatchGroupsDescribePatchGroupStateDescribePatchPropertiesDescribeSessionsDisassociateOpsItemRelatedItemGetAutomationExecutionGetCalendarStateGetCommandInvocationGetConnectionStatusGetDefaultPatchBaselineGetDeployablePatchSnapshotForInstanceGetDocumentGetInventoryGetInventorySchemaGetMaintenanceWindowGetMaintenanceWindowExecutionGetMaintenanceWindowExecutionTaskGetMaintenanceWindowExecutionTaskInvocationGetMaintenanceWindowTaskGetOpsItemGetOpsMetadataGetOpsSummaryGetParameterHistoryGetPatchBaselineGetPatchBaselineForPatchGroupGetResourcePoliciesGetServiceSettingLabelParameterVersionListAssociationsListAssociationVersionsListCommandInvocationsListCommandsListComplianceItemsListComplianceSummariesListDocumentMetadataHistoryListDocumentsListDocumentVersionsListInventoryEntriesListOpsItemEventsListOpsItemRelatedItemsListOpsMetadataListResourceComplianceSummariesListResourceDataSyncListTagsForResourceModifyDocumentPermissionPutComplianceItemsPutInventoryPutResourcePolicyRegisterDefaultPatchBaselineRegisterPatchBaselineForPatchGroupRegisterTargetWithMaintenanceWindowRegisterTaskWithMaintenanceWindowRemoveTagsFromResourceResetServiceSettingResumeSessionSendAutomationSignalSendCommandStartAssociationsOnceStartAutomationExecutionStartChangeRequestExecutionStartSessionStopAutomationExecutionTerminateSessionUnlabelParameterVersionUpdateAssociationUpdateAssociationStatusUpdateDocumentUpdateDocumentDefaultVersionUpdateDocumentMetadataUpdateMaintenanceWindowUpdateMaintenanceWindowTargetUpdateMaintenanceWindowTaskUpdateManagedInstanceRoleUpdateOpsItemUpdateOpsMetadataUpdatePatchBaselineUpdateResourceDataSyncUpdateServiceSetting