-
Notifications
You must be signed in to change notification settings - Fork 1.1k
add auth "use existing resources" #7613
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
Closed
josefaidt
wants to merge
4
commits into
aws-amplify:main
from
josefaidt:add-gen2-auth-manual-configure
Closed
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
194 changes: 194 additions & 0 deletions
194
src/pages/[platform]/build-a-backend/auth/use-existing-resources/index.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; | ||
|
||
export const meta = { | ||
title: 'Use existing resources', | ||
description: 'Learn how to use existing auth resources', | ||
platforms: [ | ||
'android', | ||
'angular', | ||
'flutter', | ||
'javascript', | ||
'nextjs', | ||
'react', | ||
'react-native', | ||
'swift', | ||
'vue' | ||
] | ||
}; | ||
|
||
export function getStaticPaths() { | ||
return getCustomStaticPath(meta.platforms); | ||
} | ||
|
||
export function getStaticProps() { | ||
return { | ||
props: { | ||
meta | ||
} | ||
}; | ||
} | ||
|
||
Amplify Auth can be configured to use a existing resources. If you are in a team setting or part of a company that has previously created auth resources, you have a few different options to configure your application to use existing auth resources: | ||
|
||
- [Add auth configuration as an output of the backend](#add-auth-as-a-backend-output) | ||
<InlineFilter filters={["angular", "javascript", "nextjs", "react", "react-native", "vue"]}> | ||
- [Configure the client library directly (without an Amplify backend)](#configure-the-client-library-directly) | ||
</InlineFilter> | ||
|
||
<Callout info> | ||
|
||
**Note:** when using existing auth resources, it may be necessary to add policies or permissions for your authenticated and unauthenticated IAM roles. These changes must be performed manually using the [AWS Cloud Development Kit (AWS CDK)](https://aws.amazon.com/cdk/) | ||
|
||
</Callout> | ||
|
||
## Add auth as a backend output | ||
|
||
The easiest way to get started with your existing resource is to use `backend.addOutput` to surface auth configuration to `amplify_outputs.json` automatically. In it's simplest form: | ||
|
||
```ts title="amplify/backend.ts" | ||
import { defineBackend } from "@aws-amplify/backend" | ||
|
||
/** | ||
* @see https://docs.amplify.aws/react/build-a-backend/ to add storage, functions, and more | ||
*/ | ||
const backend = defineBackend({}) | ||
|
||
backend.addOutput({ | ||
auth: { | ||
aws_region: "<your-cognito-aws-region>", | ||
user_pool_id: "<your-cognito-user-pool-id>", | ||
user_pool_client_id: "<your-cognito-user-pool-client-id>", | ||
identity_pool_id: "<your-cognito-identity-pool-id>", | ||
username_attributes: ["email"], | ||
standard_required_attributes: ["email"], | ||
user_verification_types: ["email"], | ||
unauthenticated_identities_enabled: true, | ||
password_policy: { | ||
min_length: 8, | ||
require_lowercase: true, | ||
require_uppercase: true, | ||
require_numbers: true, | ||
require_symbols: true, | ||
} | ||
} | ||
}) | ||
``` | ||
|
||
<Callout warning> | ||
|
||
**Warning:** if you are creating an auth resource with `defineAuth`, you cannot override the default auth configuration automatically surfaced to `amplify_outputs.json` by Amplify. | ||
|
||
</Callout> | ||
|
||
You can also use the CDK to dynamically reference existing resources, and use metadata from that resource to set up IAM policies for other resources, or reference as an authorizer for a custom REST API: | ||
|
||
```ts title="amplify/backend.ts" | ||
import { defineBackend } from "@aws-amplify/backend" | ||
import { UserPool, UserPoolClient } from "aws-cdk-lib/aws-cognito" | ||
|
||
/** | ||
* @see https://docs.amplify.aws/react/build-a-backend/ to add storage, functions, and more | ||
*/ | ||
const backend = defineBackend({}) | ||
|
||
const authStack = backend.createStack("ExistingAuth") | ||
const userPool = UserPool.fromUserPoolId( | ||
authStack, | ||
"UserPool", | ||
"<your-cognito-user-pool-id>" | ||
) | ||
const userPoolClient = UserPoolClient.fromUserPoolClientId( | ||
authStack, | ||
"UserPoolClient", | ||
"<your-cognito-user-pool-client-id>" | ||
) | ||
// Cognito Identity Pools can be referenced directly | ||
const identityPoolId = "<your-cognito-identity-pool-id>" | ||
|
||
backend.addOutput({ | ||
auth: { | ||
aws_region: authStack.region, | ||
user_pool_id: userPool.userPoolId, | ||
user_pool_client_id: userPoolClient.userPoolClientId, | ||
identity_pool_id: identityPoolId, | ||
// this property configures the Authenticator's sign-up/sign-in views | ||
username_attributes: ["email"], | ||
// this property configures the Authenticator's sign-up/sign-in views | ||
standard_required_attributes: ["email"], | ||
// this property configures the Authenticator confirmation views | ||
user_verification_types: ["email"], | ||
unauthenticated_identities_enabled: true, | ||
// this property configures the validation for the Authenticator's password field | ||
password_policy: { | ||
min_length: 8, | ||
require_lowercase: true, | ||
require_uppercase: true, | ||
require_numbers: true, | ||
require_symbols: true, | ||
}, | ||
}, | ||
}) | ||
``` | ||
|
||
{/* double-filter as a placeholder pending examples for other platforms */} | ||
{/* when others are added, remove the outer filter to keep the same prose */} | ||
<InlineFilter filters={["angular", "javascript", "nextjs", "react", "react-native", "vue"]}> | ||
|
||
## Configure the client library directly | ||
|
||
Alternatively, you can use existing resources without an Amplify backend. | ||
|
||
<InlineFilter filters={["angular", "javascript", "nextjs", "react", "react-native", "vue"]}> | ||
|
||
```ts title="src/main.ts" | ||
import { Amplify } from "aws-amplify" | ||
|
||
Amplify.configure({ | ||
Auth: { | ||
Cognito: { | ||
userPoolId: "<your-cognito-user-pool-id>", | ||
userPoolClientId: "<your-cognito-user-pool-client-id>", | ||
identityPoolId: "<your-cognito-identity-pool-id>", | ||
loginWith: { | ||
email: true, | ||
}, | ||
signUpVerificationMethod: "code", | ||
userAttributes: { | ||
email: { | ||
required: true, | ||
}, | ||
}, | ||
allowGuestAccess: true, | ||
passwordFormat: { | ||
minLength: 8, | ||
requireLowercase: true, | ||
requireUppercase: true, | ||
requireNumbers: true, | ||
requireSpecialCharacters: true, | ||
}, | ||
}, | ||
}, | ||
}) | ||
``` | ||
|
||
</InlineFilter> | ||
<InlineFilter filters={["flutter"]}> | ||
|
||
|
||
|
||
</InlineFilter> | ||
<InlineFilter filters={["android"]}> | ||
|
||
|
||
|
||
</InlineFilter> | ||
<InlineFilter filters={["swift"]}> | ||
|
||
|
||
|
||
</InlineFilter> | ||
</InlineFilter> | ||
|
||
## Next steps | ||
|
||
- [Learn how to connect your frontend](/[platform]/build-a-backend/auth/connect-your-frontend/) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the plan for filling these in? Do they leave empty lines in the docs page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not in this section but I did notice the filter mid-unordered list creates a break. fixing...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated