Skip to content

Disable operations #8275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/directory/directory.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,9 @@ export const directory = {
},
{
path: 'src/pages/[platform]/build-a-backend/data/data-modeling/secondary-index/index.mdx'
},
{
path: 'src/pages/[platform]/build-a-backend/data/data-modeling/disable-operations/index.mdx'
}
]
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
import { getCustomStaticPath } from '@/utils/getCustomStaticPath';

export const meta = {
title: 'Disable Operations',
description:
'Disable Operations for your data model',
platforms: [
'android',
'angular',
'flutter',
'javascript',
'nextjs',
'react',
'react-native',
'swift',
'vue'
]
};

export const getStaticPaths = async () => {
return getCustomStaticPath(meta.platforms);
};

export function getStaticProps(context) {
return {
props: {
platform: context.params.platform,
meta
}
};
}

The `disableOperations` method allows you to selectively disable specific GraphQL operations for a model in your Amplify application. This can be useful for implementing specialized API designs and reduce the number of resources being deployed.

You can disable operations by adding the `disableOperations` method to your model definition:

```ts title="amplify/data/resource.ts"
export const schema = a.schema({
Customer: a
.model({
name: a.string(),
phoneNumber: a.phone(),
accountRepresentativeId: a.id().required(),
})
// highlight-next-line
.disableOperations(["mutations", "subscriptions", "queries"])
.authorization(allow => [allow.publicApiKey()]),
});
```

## Available Operation Types

The `disableOperations` method accepts an array of operation types that you want to disable:

### General Operation Categories

- `mutations`: Disables all mutation operations (create, update, delete)
- `subscriptions`: Disables all real-time subscription operations (onCreate, onUpdate, onDelete)
- `queries`: Disables all query operations (get, list)

### Specific Operations
You can also disable more granular operations:
Query Operations

- `get`: Disables the ability to fetch a single item by ID
- `list`: Disables the ability to fetch multiple items

### Mutation Operations

- `create`: Disables the ability to create new items
- `update`: Disables the ability to update existing items
- `delete`: Disables the ability to delete items

### Subscription Operations

- `onCreate`: Disables real-time notifications when items are created
- `onUpdate`: Disables real-time notifications when items are updated
- `onDelete`: Disables real-time notifications when items are deleted

You can specify one or more operation types in the array to disable them:

```
// Disable all mutations
disableOperations: ["mutations"]

// Disable both subscriptions and queries
disableOperations: ["subscriptions", "queries"]

// Disable specific operations
disableOperations: ["create", "update", "list"]

// Disable specific subscription types
disableOperations: ["onCreate", "onUpdate"]

// Mix general categories with specific operations
disableOperations: ["queries", "create", "onDelete"]
```
Loading