Function secret

secret(name: string): BackendSecret

Use a secret from AWS Systems Manager (SSM) Parameter Store

Parameters

name: string

Returns BackendSecret

See

https://docs.amplify.aws/gen2/deploy-and-host/fullstack-branching/secrets-and-vars/
AWS documentation for SSM Parameter Store

Example: Creating a sandbox secret with the CLI

> ampx sandbox secret set MY_SECRET

Example: Using a secret

secret('MY_SECRET')

Example: <caption>Using with `defineAuth`</caption>

         defineAuth({
           loginWith: {
             email: {},
             externalProviders: {
               loginWithAmazon: {
                 clientId: secret('LOGIN_WITH_AMAZON_CLIENT_ID'),
                 clientSecret: secret('LOGIN_WITH_AMAZON_CLIENT_SECRET'),
               },
              },
            },
          })

Function secret

Parameters

Returns BackendSecret

See

Example: Creating a sandbox secret with the CLI

Example: Using a secret

Example: <caption>Using with `defineAuth`</caption>

Settings