libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.Types.ServiceSetting

Description

 
Synopsis

Documentation

data ServiceSetting Source #

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.

See: newServiceSetting smart constructor.

Constructors

ServiceSetting' 

Fields

  • status :: Maybe Text

    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.
  • lastModifiedDate :: Maybe POSIX

    The last time the service setting was modified.

  • arn :: Maybe Text

    The ARN of the service setting.

  • settingId :: Maybe Text

    The ID of the service setting.

  • lastModifiedUser :: Maybe Text

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

  • settingValue :: Maybe Text

    The value of the service setting.

Instances

Instances details
Eq ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

Read ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

Show ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

Generic ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

Associated Types

type Rep ServiceSetting :: Type -> Type #

NFData ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

Methods

rnf :: ServiceSetting -> () #

Hashable ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

FromJSON ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

type Rep ServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.Types.ServiceSetting

type Rep ServiceSetting = D1 ('MetaData "ServiceSetting" "Amazonka.SSM.Types.ServiceSetting" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ServiceSetting'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "settingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "settingValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newServiceSetting :: ServiceSetting Source #

Create a value of ServiceSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:ServiceSetting', serviceSetting_status - 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.

$sel:lastModifiedDate:ServiceSetting', serviceSetting_lastModifiedDate - The last time the service setting was modified.

$sel:arn:ServiceSetting', serviceSetting_arn - The ARN of the service setting.

$sel:settingId:ServiceSetting', serviceSetting_settingId - The ID of the service setting.

$sel:lastModifiedUser:ServiceSetting', serviceSetting_lastModifiedUser - The ARN of the last modified user. This field is populated only if the setting value was overwritten.

$sel:settingValue:ServiceSetting', serviceSetting_settingValue - The value of the service setting.

serviceSetting_status :: Lens' ServiceSetting (Maybe Text) Source #

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.

serviceSetting_lastModifiedDate :: Lens' ServiceSetting (Maybe UTCTime) Source #

The last time the service setting was modified.

serviceSetting_arn :: Lens' ServiceSetting (Maybe Text) Source #

The ARN of the service setting.

serviceSetting_settingId :: Lens' ServiceSetting (Maybe Text) Source #

The ID of the service setting.

serviceSetting_lastModifiedUser :: Lens' ServiceSetting (Maybe Text) Source #

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

serviceSetting_settingValue :: Lens' ServiceSetting (Maybe Text) Source #

The value of the service setting.