Update Service Setting
ssm_update_service_setting | R Documentation |
ServiceSetting is an account-level setting for an Amazon Web Services service¶
Description¶
ServiceSetting
is an account-level setting for an Amazon Web Services
service. This setting defines how a user interacts with or uses a
service or a feature of a service. For example, if an Amazon Web
Services service charges money to the account based on feature or
service usage, then the Amazon Web Services service team might create a
default setting of "false". This means the user can't use this feature
unless they change the setting to "true" and intentionally opt in for a
paid feature.
Services map a SettingId
object to a setting value. Amazon Web
Services services teams define the default value for a SettingId
. You
can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting.
Use the get_service_setting
API operation to view the current value.
Or, use the reset_service_setting
to change the value back to the
original value defined by the Amazon Web Services service team.
Update the service setting for the account.
Usage¶
Arguments¶
SettingId
[required] The Amazon Resource Name (ARN) of the service setting to update. For example,
arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled
. The setting ID can be one of the following./ssm/managed-instance/default-ec2-instance-management-role
/ssm/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission
/ssm/managed-instance/activation-tier
/ssm/opsinsights/opscenter
/ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled
Permissions to update the
/ssm/managed-instance/default-ec2-instance-management-role
setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.SettingValue
[required] The new value to specify for the service setting. The following list specifies the available values for each setting.
For
/ssm/managed-instance/default-ec2-instance-management-role
, enter the name of an IAM role.For
/ssm/automation/customer-script-log-destination
, enterCloudWatch
.For
/ssm/automation/customer-script-log-group-name
, enter the name of an Amazon CloudWatch Logs log group.For
/ssm/documents/console/public-sharing-permission
, enterEnable
orDisable
.For
/ssm/managed-instance/activation-tier
, enterstandard
oradvanced
.For
/ssm/opsinsights/opscenter
, enterEnabled
orDisabled
.For
/ssm/parameter-store/default-parameter-tier
, enterStandard
,Advanced
, orIntelligent-Tiering
For
/ssm/parameter-store/high-throughput-enabled
, entertrue
orfalse
.
Value¶
An empty list.