Class ServiceSetting
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ServiceSetting.Builder,
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the service setting.static ServiceSetting.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The last time the service setting was modified.final String
The ARN of the last modified user.static Class
<? extends ServiceSetting.Builder> final String
The ID of the service setting.final String
The value of the service setting.final String
status()
The status of the service setting.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
settingId
The ID of the service setting.
- Returns:
- The ID of the service setting.
-
settingValue
The value of the service setting.
- Returns:
- The value of the service setting.
-
lastModifiedDate
The last time the service setting was modified.
- Returns:
- The last time the service setting was modified.
-
lastModifiedUser
The ARN of the last modified user. This field is populated only if the setting value was overwritten.
- Returns:
- The ARN of the last modified user. This field is populated only if the setting value was overwritten.
-
arn
The ARN of the service setting.
- Returns:
- The ARN of the service setting.
-
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.
- Returns:
- 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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ServiceSetting.Builder,
ServiceSetting> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-