ServiceSetting

The service setting data structure.

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 UpdateServiceSetting API operation to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

The ARN of the service setting.

Link copied to clipboard

The last time the service setting was modified.

Link copied to clipboard

The ARN of the last modified user. This field is populated only if the setting value was overwritten.

Link copied to clipboard

The ID of the service setting.

Link copied to clipboard

The value of the service setting.

Link copied to clipboard

The status of the service setting. The value can be Default, Customized or PendingUpdate.

Functions

Link copied to clipboard
inline fun copy(block: ServiceSetting.Builder.() -> Unit = {}): ServiceSetting
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String