class Amazonite::Ssm::ServiceSetting

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.

Included Modules

Defined in:

ssm/service_setting.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(setting_id : String | Nil = nil, setting_value : String | Nil = nil, last_modified_date : Time | Nil = nil, last_modified_user : String | Nil = nil, arn : String | Nil = nil, status : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def arn : String | Nil #

The ARN of the service setting.


[View source]
def arn=(arn : String | Nil) #

The ARN of the service setting.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def last_modified_date : Time | Nil #

The last time the service setting was modified.


[View source]
def last_modified_date=(last_modified_date : Time | Nil) #

The last time the service setting was modified.


[View source]
def last_modified_user : String | Nil #

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


[View source]
def last_modified_user=(last_modified_user : String | Nil) #

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


[View source]
def setting_id : String | Nil #

The ID of the service setting.


[View source]
def setting_id=(setting_id : String | Nil) #

The ID of the service setting.


[View source]
def setting_value : String | Nil #

The value of the service setting.


[View source]
def setting_value=(setting_value : String | Nil) #

The value of the service setting.


[View source]
def status : String | Nil #

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.


[View source]
def status=(status : String | Nil) #

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.


[View source]
def validate! : Nil #

[View source]