Configuring permissions to change Parameter Store throughput Increasing or resetting throughput using the console Increasing or resetting throughput using the Amazon CLI Increasing or resetting throughput (PowerShell)

Increasing or resetting Parameter Store throughput

Increasing Parameter Store throughput increases the maximum number of transactions per second (TPS) that Parameter Store, a tool in Amazon Systems Manager, can process. Increased throughput allows you to operate Parameter Store at higher volumes to support applications and workloads that need concurrent access to multiple parameters. You can increase the quota up to the max throughput on the Settings tab.

For more information about max throughput default and maximum limits, see Amazon Systems Manager endpoints and quotas.

Increasing the throughput quota incurs a charge on your Amazon Web Services account. For more information, see Amazon Systems Manager Pricing.

Note

The Parameter Store throughput setting applies to all transactions created by all IAM users in the current Amazon Web Services account and Amazon Web Services Region. The throughput setting applies to standard and advanced parameters.

Topics

Configuring permissions to change Parameter Store throughput
Increasing or resetting throughput using the console
Increasing or resetting throughput using the Amazon CLI
Increasing or resetting throughput (PowerShell)

Configuring permissions to change Parameter Store throughput

Verify that you have permission in IAM to change Parameter Store throughput by doing one of the following:

Make sure that the AdministratorAccess policy is attached to your IAM entity (user, group, or role).
Make sure that you have permission to change the throughput service setting by using the following API operations:

Grant the following permissions to the IAM entity to allow a user to view and change the parameter-throughput setting for parameters in a specific Amazon Web Services Region in an Amazon Web Services account.


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ssm:GetServiceSetting"                
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "ssm:UpdateServiceSetting"
            ],
            "Resource": "arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled"
        }
    ]
}

Administrators can specify read-only permission by assigning the following permissions.


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ssm:GetServiceSetting"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Deny",
            "Action": [
                "ssm:ResetServiceSetting",
                "ssm:UpdateServiceSetting"
            ],
            "Resource": "*"
        }
    ]
}

To provide access, add permissions to your users, groups, or roles:

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.

Increasing or resetting throughput using the console

The following procedure shows how to use the Systems Manager console to increase the number of transactions per second that Parameter Store can process for the current Amazon Web Services account and Amazon Web Services Region. It also shows how to revert to the standard settings if you no longer need increased throughput or no longer want to incur charges.

Tip

If you haven't created a parameter yet, you can use the Amazon Command Line Interface (Amazon CLI) or Amazon Tools for Windows PowerShell to increase throughput. For information, see Increasing or resetting throughput using the Amazon CLI and Increasing or resetting throughput (PowerShell).

To increase or reset Parameter Store throughput

Open the Amazon Systems Manager console at https://console.amazonaws.cn/systems-manager/.
In the navigation pane, choose Parameter Store.
Choose the Settings tab.
To increase throughput, choose Set limit.

-or-

To revert to the default limit, choose Reset limit.
If you are increasing the limit, do the following:
- Select the check box for I accept that changing this setting incurs charges on my Amazon Web Services account.
- Choose Set limit.
-or-

If you are resetting the limit to the default, do the following:
- Select the check box for I accept that resetting to the default throughput limit causes Parameter Store to process fewer transactions per second.
- Choose Reset limit.

Increasing or resetting throughput using the Amazon CLI

The following procedure shows how to use the Amazon CLI to increase the number of transactions per second that Parameter Store can process for the current Amazon Web Services account and Amazon Web Services Region. You can also revert to the default limit.

To increase Parameter Store throughput using the Amazon CLI

Open the Amazon CLI and run the following command to increase the transactions per second that Parameter Store can process in the current Amazon Web Services account and Amazon Web Services Region.
```
aws ssm update-service-setting --setting-id arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled --setting-value true
```
There is no output if the command succeeds.

Run the following command to view the current throughput service settings for Parameter Store in the current Amazon Web Services account and Amazon Web Services Region.


aws ssm get-service-setting --setting-id arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled

The system returns information similar to the following:

{
    "ServiceSetting": {
        "SettingId": "/ssm/parameter-store/high-throughput-enabled",
        "SettingValue": "true",
        "LastModifiedDate": 1556551683.923,
        "LastModifiedUser": "arn:aws:sts::123456789012:assumed-role/Administrator/Jasper",
        "ARN": "arn:aws:ssm:us-east-2:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled",
        "Status": "Customized"
    }
}

If you no longer need increased throughput, or if you no longer want to incur charges, you can revert to the standard settings. To revert your settings, run the following command.


aws ssm reset-service-setting --setting-id arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled

{
    "ServiceSetting": {
        "SettingId": "/ssm/parameter-store/high-throughput-enabled",
        "SettingValue": "false",
        "LastModifiedDate": 1555532818.578,
        "LastModifiedUser": "System",
        "ARN": "arn:aws:ssm:us-east-2:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled",
        "Status": "Default"
    }
}

Increasing or resetting throughput (PowerShell)

The following procedure shows how to use the Tools for Windows PowerShell to increase the number of transactions per second that Parameter Store can process for the current Amazon Web Services account and Amazon Web Services Region. You can also revert to the default limit.

To increase Parameter Store throughput using PowerShell

Increase Parameter Store throughput in the current Amazon Web Services account and Amazon Web Services Region using the Amazon Tools for PowerShell (Tools for PowerShell).
```
Update-SSMServiceSetting -SettingId "arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled" -SettingValue "true" -Region region
```
There is no output if the command succeeds.

Run the following command to view the current throughput service settings for Parameter Store in the current Amazon Web Services account and Amazon Web Services Region.


Get-SSMServiceSetting -SettingId "arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled" -Region region

The systems returns information similar to the following:

ARN              : arn:aws:ssm:us-east-2:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled
LastModifiedDate : 4/29/2019 3:35:44 PM
LastModifiedUser : arn:aws:sts::123456789012:assumed-role/Administrator/Jasper
SettingId        : /ssm/parameter-store/high-throughput-enabled
SettingValue     : true
Status           : Customized

If you no longer need increased throughput, or if you no longer want to incur charges, you can revert to the standard settings. To revert your settings, run the following command.


Reset-SSMServiceSetting -SettingId "arn:aws-cn:ssm:region:account-id:servicesetting/ssm/parameter-store/high-throughput-enabled" -Region region

The system returns information similar to the following:

ARN              : arn:aws:ssm:us-east-2:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled
LastModifiedDate : 4/17/2019 8:26:58 PM
LastModifiedUser : System
SettingId        : /ssm/parameter-store/high-throughput-enabled
SettingValue     : false
Status           : Default

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Managing parameter tiers

Setting up notifications or triggering actions based on Parameter Store events