Interface AWSAmplifyBackendOutputs

Config format for Amplify Gen 2 client libraries to communicate with backend services.

interface AWSAmplifyBackendOutputs {
    analytics?: { amazon_pinpoint?: { app_id: string; aws_region: string } };
    auth?: {
        aws_region: string;
        groups?: { [k: string]: clientConfigTypesV1_4.AmplifyUserGroupConfig }[];
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: (
                "GOOGLE"
                | "FACEBOOK"
                | "LOGIN_WITH_AMAZON"
                | "SIGN_IN_WITH_APPLE"
            )[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_4.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    };
    custom?: { [k: string]: unknown };
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_4.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_4.AwsAppsyncAuthorizationType;
        model_introspection?: { [k: string]: unknown };
        url: string;
    };
    geo?: {
        aws_region: string;
        geofence_collections?: { default: string; items: string[] };
        maps?: {
            default: string;
            items: { [k: string]: clientConfigTypesV1_4.AmazonLocationServiceConfig };
        };
        search_indices?: { default: string; items: string[] };
    };
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_4.AmazonPinpointChannels[];
    };
    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_4.AmplifyStorageBucket[];
    };
    version: "1.4";
}

Index

Properties

analytics? auth? custom? data? geo? notifications? storage? version

Properties

`Optional`analytics

analytics?: { amazon_pinpoint?: { app_id: string; aws_region: string } }

Outputs manually specified by developers for use with frontend library

`Optional`auth

auth?: {
    aws_region: string;
    groups?: { [k: string]: clientConfigTypesV1_4.AmplifyUserGroupConfig }[];
    identity_pool_id?: string;
    mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
    mfa_methods?: ("SMS" | "TOTP")[];
    oauth?: {
        domain: string;
        identity_providers: (
            "GOOGLE"
            | "FACEBOOK"
            | "LOGIN_WITH_AMAZON"
            | "SIGN_IN_WITH_APPLE"
        )[];
        redirect_sign_in_uri: string[];
        redirect_sign_out_uri: string[];
        response_type: "code" | "token";
        scopes: string[];
    };
    password_policy?: {
        min_length: number;
        require_lowercase: boolean;
        require_numbers: boolean;
        require_symbols: boolean;
        require_uppercase: boolean;
    };
    standard_required_attributes?: clientConfigTypesV1_4.AmazonCognitoStandardAttributes[];
    unauthenticated_identities_enabled?: boolean;
    user_pool_client_id: string;
    user_pool_id: string;
    user_verification_types?: ("email" | "phone_number")[];
    username_attributes?: ("email" | "phone_number" | "username")[];
}

Outputs generated from defineAuth

Type declaration

aws_region: string
AWS Region of Amazon Cognito resources
Optionalgroups?: { [k: string]: clientConfigTypesV1_4.AmplifyUserGroupConfig }[]
Optionalidentity_pool_id?: string
Cognito Identity Pool ID
Optionalmfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
Optionalmfa_methods?: ("SMS" | "TOTP")[]
Optionaloauth?: {
    domain: string;
    identity_providers: (
        "GOOGLE"
        | "FACEBOOK"
        | "LOGIN_WITH_AMAZON"
        | "SIGN_IN_WITH_APPLE"
    )[];
    redirect_sign_in_uri: string[];
    redirect_sign_out_uri: string[];
    response_type: "code" | "token";
    scopes: string[];
}
- domain: string
  Domain used for identity providers
- identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[]
  Identity providers set on Cognito User Pool
  
  Min Items
  0
- redirect_sign_in_uri: string[]
  URIs used to redirect after signing in using an identity provider
  
  Min Items
  1
- redirect_sign_out_uri: string[]
  URIs used to redirect after signing out
  
  Min Items
  1
- response_type: "code" | "token"
- scopes: string[]
  Min Items
  0
Optionalpassword_policy?: {
    min_length: number;
    require_lowercase: boolean;
    require_numbers: boolean;
    require_symbols: boolean;
    require_uppercase: boolean;
}
Cognito User Pool password policy
Optionalstandard_required_attributes?: clientConfigTypesV1_4.AmazonCognitoStandardAttributes[]
Cognito User Pool standard attributes required for signup

Min Items
0
Optionalunauthenticated_identities_enabled?: boolean
user_pool_client_id: string
Cognito User Pool Client ID
user_pool_id: string
Cognito User Pool ID
Optionaluser_verification_types?: ("email" | "phone_number")[]
Optionalusername_attributes?: ("email" | "phone_number" | "username")[]
Cognito User Pool username attributes

Min Items
1

`Optional`custom

custom?: { [k: string]: unknown }

Outputs generated from backend.addOutput({ custom: })

`Optional`data

data?: {
    api_key?: string;
    authorization_types: clientConfigTypesV1_4.AwsAppsyncAuthorizationType[];
    aws_region: string;
    default_authorization_type: clientConfigTypesV1_4.AwsAppsyncAuthorizationType;
    model_introspection?: { [k: string]: unknown };
    url: string;
}

Outputs generated from defineData

Type declaration

Optionalapi_key?: string
authorization_types: clientConfigTypesV1_4.AwsAppsyncAuthorizationType[]
aws_region: string
default_authorization_type: clientConfigTypesV1_4.AwsAppsyncAuthorizationType
Optionalmodel_introspection?: { [k: string]: unknown }
generated model introspection schema for use with generateClient
url: string
AppSync endpoint URL

`Optional`geo

geo?: {
    aws_region: string;
    geofence_collections?: { default: string; items: string[] };
    maps?: {
        default: string;
        items: { [k: string]: clientConfigTypesV1_4.AmazonLocationServiceConfig };
    };
    search_indices?: { default: string; items: string[] };
}

Outputs manually specified by developers for use with frontend library

Type declaration

aws_region: string
AWS Region of Amazon Location Service resources
Optionalgeofence_collections?: { default: string; items: string[] }
Geofencing (visualize virtual perimeters)
- default: string
- items: string[]
  Min Items
  1
Optionalmaps?: {
default: string;
items: { [k: string]: clientConfigTypesV1_4.AmazonLocationServiceConfig };
}
Maps from Amazon Location Service
Optionalsearch_indices?: { default: string; items: string[] }
Location search (search by places, addresses, coordinates)
- default: string
- items: string[]
  Min Items
  1

`Optional`notifications

notifications?: {
    amazon_pinpoint_app_id: string;
    aws_region: string;
    channels: clientConfigTypesV1_4.AmazonPinpointChannels[];
}

Outputs manually specified by developers for use with frontend library

Type declaration

amazon_pinpoint_app_id: string
aws_region: string
channels: clientConfigTypesV1_4.AmazonPinpointChannels[]
Min Items
1

`Optional`storage

storage?: {
    aws_region: string;
    bucket_name: string;
    buckets?: clientConfigTypesV1_4.AmplifyStorageBucket[];
}

Outputs generated from defineStorage

version

version: "1.4"

Version of this schema

Interface AWSAmplifyBackendOutputs

Index

Properties

Properties

Optionalanalytics

Optionalauth

Type declaration

aws_region: string

Optionalgroups?: { [k: string]: clientConfigTypesV1_4.AmplifyUserGroupConfig }[]

Optionalidentity_pool_id?: string

Optionalmfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"

Optionalmfa_methods?: ("SMS" | "TOTP")[]

Optionaloauth?: { domain: string; identity_providers: ( "GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE" )[]; redirect_sign_in_uri: string[]; redirect_sign_out_uri: string[]; response_type: "code" | "token"; scopes: string[];}

domain: string

identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[]

Min Items

redirect_sign_in_uri: string[]

Min Items

redirect_sign_out_uri: string[]

Min Items

response_type: "code" | "token"

scopes: string[]

Min Items

Optionalpassword_policy?: { min_length: number; require_lowercase: boolean; require_numbers: boolean; require_symbols: boolean; require_uppercase: boolean;}

Optionalstandard_required_attributes?: clientConfigTypesV1_4.AmazonCognitoStandardAttributes[]

Min Items

Optionalunauthenticated_identities_enabled?: boolean

user_pool_client_id: string

user_pool_id: string

Optionaluser_verification_types?: ("email" | "phone_number")[]

Optionalusername_attributes?: ("email" | "phone_number" | "username")[]

Min Items

Optionalcustom

Optionaldata

Type declaration

Optionalapi_key?: string

authorization_types: clientConfigTypesV1_4.AwsAppsyncAuthorizationType[]

aws_region: string

default_authorization_type: clientConfigTypesV1_4.AwsAppsyncAuthorizationType

Optionalmodel_introspection?: { [k: string]: unknown }

url: string

Optionalgeo

Type declaration

aws_region: string

Optionalgeofence_collections?: { default: string; items: string[] }

default: string

items: string[]

Min Items

Optionalmaps?: { default: string; items: { [k: string]: clientConfigTypesV1_4.AmazonLocationServiceConfig };}

Optionalsearch_indices?: { default: string; items: string[] }

default: string

items: string[]

Min Items

Optionalnotifications

Type declaration

amazon_pinpoint_app_id: string

aws_region: string

channels: clientConfigTypesV1_4.AmazonPinpointChannels[]

Min Items

Optionalstorage

version

Settings

On This Page

`Optional`analytics

`Optional`auth

`Optional`groups?: { [k: string]: clientConfigTypesV1_4.AmplifyUserGroupConfig }[]

`Optional`identity_pool_id?: string

`Optional`mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"

`Optional`mfa_methods?: ("SMS" | "TOTP")[]

`Optional`oauth?: {
domain: string;
identity_providers: (
"GOOGLE"
| "FACEBOOK"
| "LOGIN_WITH_AMAZON"
| "SIGN_IN_WITH_APPLE"
)[];
redirect_sign_in_uri: string[];
redirect_sign_out_uri: string[];
response_type: "code" | "token";
scopes: string[];
}

`Optional`password_policy?: {
min_length: number;
require_lowercase: boolean;
require_numbers: boolean;
require_symbols: boolean;
require_uppercase: boolean;
}

`Optional`standard_required_attributes?: clientConfigTypesV1_4.AmazonCognitoStandardAttributes[]

`Optional`unauthenticated_identities_enabled?: boolean

`Optional`user_verification_types?: ("email" | "phone_number")[]

`Optional`username_attributes?: ("email" | "phone_number" | "username")[]

`Optional`custom

`Optional`data

`Optional`api_key?: string

`Optional`model_introspection?: { [k: string]: unknown }

`Optional`geo

`Optional`geofence_collections?: { default: string; items: string[] }

`Optional`maps?: {
default: string;
items: { [k: string]: clientConfigTypesV1_4.AmazonLocationServiceConfig };
}

`Optional`search_indices?: { default: string; items: string[] }

`Optional`notifications

`Optional`storage