Skip to content
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

[POC] Introduce and enforce new stack structure #2158

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

rtpascual
Copy link
Contributor

@rtpascual rtpascual commented Oct 28, 2024

Problem

Issue number, if available:

Changes

Introduces defineStack for passing backend resources into (auth, data, etc.) and update DefineBackendProps to only take in backend stacks from defineStack. These changes would be part of the next major version, intermediate changes are in #2157.

The code using this solution looks like this:

import { defineAuth, defineData, defineFunction, defineStack } from '@aws-amplify/backend';

// define resources
const auth = defineAuth({ ... });
const data = defineData({ ... });
const function = defineFunction({ ... });

export const stack1 = defineStack('stack1', { auth, data, function });
// amplify/backend.ts
import { defineBackend } from '@aws-amplify/backend';

const backend = defineBackend({ stack1 });

// examples of accessing resources
backend.stack1.resources.stack
backend.stack1.resources.auth.resources.userPool
backend.stack1.resources.function.resources.cfnResources.cfnFunction
backend.stack1.resources.function.addEnvironment(...)

Corresponding docs PR, if applicable:

Validation

Checklist

  • If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
  • If this PR requires a change to the Project Architecture README, I have included that update in this PR.
  • If this PR requires a docs update, I have linked to that docs PR above.
  • If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link

changeset-bot bot commented Oct 28, 2024

⚠️ No Changeset found

Latest commit: 5b136f6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant