<!--
{
  "availability" : [
    "iOS: 17.0.0 -",
    "iPadOS: 17.0.0 -",
    "macCatalyst: 17.0.0 -",
    "macOS: 14.0.0 -",
    "tvOS: 17.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 10.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "CloudKit",
  "identifier" : "/documentation/CloudKit/CKSyncEngineConfiguration",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "CloudKit"
    ],
    "preciseIdentifier" : "c:objc(cs)CKSyncEngineConfiguration"
  },
  "title" : "CKSyncEngineConfiguration"
}
-->

# CKSyncEngineConfiguration

A type that configures the attributes and behavior of a sync engine.

```
@interface CKSyncEngineConfiguration : NSObject
```

## Topics

### Creating configurations

[`initWithDatabase:stateSerialization:delegate:`](/documentation/CloudKit/CKSyncEngineConfiguration/initWithDatabase:stateSerialization:delegate:)

Creates a configuration for the specified database and serialized state.

### Handling record changes

[`delegate`](/documentation/CloudKit/CKSyncEngineConfiguration/delegate)

The object that provides the records to sync and handles any related events.

[`CKSyncEngineDelegate`](/documentation/CloudKit/CKSyncEngineDelegate-3c38p)

An interface for providing record data to a sync engine and customizing that engine’s behavior.

### Managing attributes

[`automaticallySync`](/documentation/CloudKit/CKSyncEngineConfiguration/automaticallySync)

A Boolean value that determines whether the engine syncs automatically.

[`database`](/documentation/CloudKit/CKSyncEngineConfiguration/database)

The associated database.

[`subscriptionID`](/documentation/CloudKit/CKSyncEngineConfiguration/subscriptionID)

The subscription identifier for the associated database.

[`stateSerialization`](/documentation/CloudKit/CKSyncEngineConfiguration/stateSerialization)

The sync engine’s serialized state.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)