Class: Aws::SSM::Types::ServiceSetting

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the service setting.

Returns:

  • (String)

18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
# File 'lib/aws-sdk-ssm/types.rb', line 18350

class ServiceSetting < Struct.new(
  :setting_id,
  :setting_value,
  :last_modified_date,
  :last_modified_user,
  :arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateTime

The last time the service setting was modified.

Returns:

  • (Time)

18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
# File 'lib/aws-sdk-ssm/types.rb', line 18350

class ServiceSetting < Struct.new(
  :setting_id,
  :setting_value,
  :last_modified_date,
  :last_modified_user,
  :arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_userString

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

Returns:

  • (String)

18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
# File 'lib/aws-sdk-ssm/types.rb', line 18350

class ServiceSetting < Struct.new(
  :setting_id,
  :setting_value,
  :last_modified_date,
  :last_modified_user,
  :arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#setting_idString

The ID of the service setting.

Returns:

  • (String)

18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
# File 'lib/aws-sdk-ssm/types.rb', line 18350

class ServiceSetting < Struct.new(
  :setting_id,
  :setting_value,
  :last_modified_date,
  :last_modified_user,
  :arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#setting_valueString

The value of the service setting.

Returns:

  • (String)

18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
# File 'lib/aws-sdk-ssm/types.rb', line 18350

class ServiceSetting < Struct.new(
  :setting_id,
  :setting_value,
  :last_modified_date,
  :last_modified_user,
  :arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

  • Default: The current setting uses a default value provisioned by the Amazon Web Services service team.

  • Customized: The current setting use a custom value specified by the customer.

  • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

Returns:

  • (String)

18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
# File 'lib/aws-sdk-ssm/types.rb', line 18350

class ServiceSetting < Struct.new(
  :setting_id,
  :setting_value,
  :last_modified_date,
  :last_modified_user,
  :arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end