Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@aws-amplify/auth-construct
Advanced tools
This package vends an L3 CDK Construct that enables faster, easier and secure app authentication and authorization powered by Amazon Cognito. Amplify Auth lets you quickly set up secure authentication flows with a fully-managed user directory. Control wha
This package vends an L3 CDK Construct that enables faster, easier and secure app authentication and authorization powered by Amazon Cognito. Amplify Auth lets you quickly set up secure authentication flows with a fully-managed user directory. Control what users have access to in your mobile and web apps with Amplify Auth's built-in authorization capabilities.
The primary way to use this construct is to invoke it with a configuration object. You can declare the individual settings for your authentication by passing them as properties to the AmplifyAuth construct.
Note: only a single instance of the AmplifyAuth
construct can be invoked within a CDK synthesis at this point in time.
In this example, you will create a simple stack with email login enabled (by default). Deploying this will create a UserPool, UserPoolClient, IdentityPool, and Authenticated/Unauthenticated IAM Roles.
import { App, Stack } from 'aws-cdk-lib';
import { AmplifyAuth } from '@aws-amplify/auth-construct';
const app = new App();
const stack = new Stack(app, 'AuthStack');
new AmplifyAuth(stack, 'Auth');
In this example, you will create a simple stack with email login enabled and with customized multi factor authentication (MFA) settings.
import { App, Stack } from 'aws-cdk-lib';
import { AmplifyAuth } from '@aws-amplify/auth-construct';
const app = new App();
const stack = new Stack(app, 'AuthStack');
new AmplifyAuth(stack, 'Auth', {
loginWith: {
email: true,
},
multifactor: {
mode: 'OPTIONAL',
sms: {
smsMessage: (code: string) => `Your verification code is ${code}`,
},
totp: false,
},
});
In this example, you will create a stack with email, phone, and external login providers. Additionally, you can customize the email and phone verification messages.
import { App, Stack, SecretValue } from 'aws-cdk-lib';
import { AmplifyAuth } from '@aws-amplify/auth-construct';
const app = new App();
const stack = new Stack(app, 'AuthStack');
new AmplifyAuth(stack, 'Auth', {
loginWith: {
email: {
verificationEmailStyle: 'CODE',
verificationEmailBody: (code: string) =>
`Your verification code is ${code}.`,
verificationEmailSubject: 'My custom email subject',
},
phone: {
verificationMessage: (code: string) =>
`Your verification code is ${code}.`,
},
externalProviders: {
google: {
clientId: 'googleClientId',
// see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html
clientSecret: SecretValue.unsafePlainText('googleClientSecret'),
},
facebook: {
clientId: 'facebookClientId',
clientSecret: 'facebookClientSecret',
},
signInWithApple: {
clientId: 'appleClientId',
keyId: 'appleKeyId',
privateKey: 'applePrivateKey',
teamId: 'appleTeamId',
},
loginWithAmazon: {
clientId: 'amazonClientId',
clientSecret: 'amazonClientSecret',
},
oidc: {
clientId: 'oidcClientId',
clientSecret: 'oidcClientSecret',
issuerUrl: 'oidcIssuerUrl',
name: 'oidcProviderName',
},
saml: {
name: 'samlProviderName',
metadata: {
metadataContent: 'samlMetadataContent',
metadataType: 'FILE',
},
},
},
},
});
In this example, you will customize the set of attributes that are required for every user in the UserPool.
import { App, Stack } from 'aws-cdk-lib';
import { AmplifyAuth } from '@aws-amplify/auth-construct';
const app = new App();
const stack = new Stack(app, 'AuthStack');
new AmplifyAuth(stack, 'Auth', {
loginWith: { email: true },
userAttributes: {
address: {
mutable: false,
},
familyName: {
required: true,
},
},
});
FAQs
This package vends an L3 CDK Construct that enables faster, easier and secure app authentication and authorization powered by Amazon Cognito. Amplify Auth lets you quickly set up secure authentication flows with a fully-managed user directory. Control wha
The npm package @aws-amplify/auth-construct receives a total of 21,812 weekly downloads. As such, @aws-amplify/auth-construct popularity was classified as popular.
We found that @aws-amplify/auth-construct demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.