Amplify Toolbox
    Preparing search index...

    Type Alias DataProps

    Exposed props for Data which are configurable by the end user.

    type DataProps = {
        authorizationModes?: AuthorizationModes;
        functions?: Record<string, ConstructFactory<AmplifyFunction>>;
        logging?: DataLoggingOptions;
        migratedAmplifyGen1DynamoDbTableMappings?: AmplifyGen1DynamoDbTableMapping[];
        name?: string;
        schema: DataSchemaInput;
        stackMappings?: Record<string, string>;
    }
    Index

    Properties

    authorizationModes? functions? logging? migratedAmplifyGen1DynamoDbTableMappings? name? schema stackMappings?

    Properties

    authorizationModes?: AuthorizationModes

    Override authorization config, which will apply on top of defaults based on availability of auth, etc.

    functions?: Record<string, ConstructFactory<AmplifyFunction>>

    Functions invokable by the API. The specific input type of the function is subject to change or removal.

    logging?: DataLoggingOptions

    Logging configuration for the API.

    migratedAmplifyGen1DynamoDbTableMappings?: AmplifyGen1DynamoDbTableMapping[]

    Mapping of model name to existing DynamoDB table that should be used as the data source. Each element in the array represents a mapping for a specific branch.

    name?: string

    Optional name for the generated Api.

    schema: DataSchemaInput

    Graphql Schema as a string to be passed into the CDK construct.

    stackMappings?: Record<string, string>

    Override the assigned nested stack on a per-resource basis. Only applies to resolvers, and takes the form { : }. Use this to distribute resolver resources across multiple stacks. You can discover resolver logical IDs by running npx ampx sandbox and examining the CloudFormation output, or by running cdk synth.

    stackMappings: {
      "CreateOrderResolver": "OrderMutations",
      "UpdateOrderResolver": "OrderMutations",
    }

    Settings

    Member Visibility

    On This Page

    Properties