@aws-amplify/graphql-api-construct 1.3.0 → 1.4.0-construct-publish-test.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +903 -176
- package/API.md +80 -1
- package/CHANGELOG.md +11 -0
- package/README.md +623 -10
- package/lib/amplify-dynamodb-table-wrapper.d.ts +128 -0
- package/lib/amplify-dynamodb-table-wrapper.js +102 -0
- package/lib/amplify-graphql-api.d.ts +4 -0
- package/lib/amplify-graphql-api.js +10 -3
- package/lib/amplify-graphql-definition.d.ts +19 -2
- package/lib/amplify-graphql-definition.js +57 -5
- package/lib/index.d.ts +2 -1
- package/lib/index.js +5 -2
- package/lib/internal/construct-exports.js +8 -1
- package/lib/internal/data-source-config.d.ts +7 -0
- package/lib/internal/data-source-config.js +37 -0
- package/lib/internal/index.d.ts +1 -1
- package/lib/internal/index.js +2 -2
- package/lib/internal/model-type-name.d.ts +8 -0
- package/lib/internal/model-type-name.js +27 -0
- package/lib/types.d.ts +47 -7
- package/lib/types.js +1 -1
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/index.js +7 -9
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/v1.js +15 -18
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/index.js +10 -16
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/v1.js +22 -20
- package/node_modules/@aws-amplify/backend-output-schemas/lib/index.d.ts +12 -1
- package/node_modules/@aws-amplify/backend-output-schemas/lib/index.js +37 -63
- package/node_modules/@aws-amplify/backend-output-schemas/lib/platform/index.js +16 -14
- package/node_modules/@aws-amplify/backend-output-schemas/lib/platform/stack_metadata_schemas.js +7 -11
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/index.d.ts +5 -0
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/index.js +7 -9
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/v1.d.ts +5 -0
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/v1.js +9 -11
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/index.js +7 -9
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/v1.js +9 -12
- package/node_modules/@aws-amplify/backend-output-schemas/package.json +4 -23
- package/node_modules/@aws-amplify/backend-output-storage/lib/index.d.ts +1 -0
- package/node_modules/@aws-amplify/backend-output-storage/lib/index.js +17 -14
- package/node_modules/@aws-amplify/backend-output-storage/lib/stack_metadata_output_storage_strategy.js +28 -32
- package/node_modules/@aws-amplify/backend-output-storage/lib/store_attribution_metadata.d.ts +50 -0
- package/node_modules/@aws-amplify/backend-output-storage/lib/store_attribution_metadata.js +104 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/backend_deployment_type.d.ts +5 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/backend_deployment_type.js +9 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/cdk_context_key.d.ts +9 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/cdk_context_key.js +13 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/index.d.ts +4 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/index.js +22 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/unique_backend_identifier.d.ts +53 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/lib/unique_backend_identifier.js +74 -0
- package/node_modules/@aws-amplify/backend-output-storage/node_modules/@aws-amplify/platform-core/package.json +23 -0
- package/node_modules/@aws-amplify/backend-output-storage/package.json +6 -4
- package/node_modules/@aws-amplify/graphql-auth-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/package.json +11 -10
- package/node_modules/@aws-amplify/graphql-default-value-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-default-value-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-default-value-transformer/package.json +8 -7
- package/node_modules/@aws-amplify/graphql-function-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-function-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-function-transformer/package.json +7 -6
- package/node_modules/@aws-amplify/graphql-http-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-http-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-http-transformer/package.json +7 -6
- package/node_modules/@aws-amplify/graphql-index-transformer/API.md +3 -0
- package/node_modules/@aws-amplify/graphql-index-transformer/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-index-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/graphql-index-transformer.js +4 -0
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/graphql-index-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/graphql-primary-key-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/graphql-primary-key-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/index.js +2 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.d.ts +5 -5
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.js +34 -8
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/package.json +8 -7
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/assets/mapping-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/package.json +11 -10
- package/node_modules/@aws-amplify/graphql-model-transformer/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.d.ts +2 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.js +52 -47
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/rds-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/rds-notification-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/rds-patching-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamo-model-resource-generator.d.ts +15 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamo-model-resource-generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamo-model-resource-generator.js +169 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamo-model-resource-generator.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamodb-table-construct/index.d.ts +40 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamodb-table-construct/index.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamodb-table-construct/index.js +242 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-dynamodb-table-construct/index.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-table-manager-lambda/amplify-table-manager-handler.d.ts +12 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-table-manager-lambda/amplify-table-manager-handler.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-table-manager-lambda/amplify-table-manager-handler.js +663 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/amplify-dynamodb-table/amplify-table-manager-lambda/amplify-table-manager-handler.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/dynamo-model-resource-generator.d.ts +5 -2
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/dynamo-model-resource-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/dynamo-model-resource-generator.js +47 -60
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/dynamo-model-resource-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/package.json +9 -6
- package/node_modules/@aws-amplify/graphql-predictions-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/lib/predictionsLambdaFunction.zip +0 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/package.json +7 -6
- package/node_modules/@aws-amplify/graphql-relational-transformer/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.js +3 -10
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/package.json +9 -8
- package/node_modules/@aws-amplify/graphql-searchable-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-searchable-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/streaming-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-searchable-transformer/package.json +8 -7
- package/node_modules/@aws-amplify/graphql-transformer/API.md +2 -2
- package/node_modules/@aws-amplify/graphql-transformer/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.d.ts +3 -3
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer/package.json +15 -14
- package/node_modules/@aws-amplify/graphql-transformer/src/graphql-transformer.ts +3 -8
- package/node_modules/@aws-amplify/graphql-transformer-core/API.md +9 -11
- package/node_modules/@aws-amplify/graphql-transformer-core/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/index.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.d.ts +3 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.js +3 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/index.d.ts +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/index.js +3 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/types.d.ts +2 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/types.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/utils.d.ts +2 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/utils.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/utils.js +12 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/utils.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformer-context/index.d.ts +3 -4
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformer-context/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.d.ts +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.js +3 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/provision-strategy-utils.d.ts +3 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/provision-strategy-utils.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/provision-strategy-utils.js +15 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/provision-strategy-utils.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/package.json +5 -4
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/API.md +25 -3
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.js +2 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-context-provider.d.ts +2 -2
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-datasource-provider.d.ts +7 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-datasource-provider.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-datasource-provider.js +6 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-datasource-provider.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/package.json +3 -2
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/index.ts +4 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-context-provider.ts +2 -2
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-datasource-provider.ts +16 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/tsconfig.tsbuildinfo +1 -1
- package/node_modules/@aws-amplify/platform-core/lib/backend_deployment_type.d.ts +5 -0
- package/node_modules/@aws-amplify/platform-core/lib/backend_deployment_type.js +9 -0
- package/node_modules/@aws-amplify/platform-core/lib/cdk_context_key.d.ts +9 -0
- package/node_modules/@aws-amplify/platform-core/lib/cdk_context_key.js +13 -0
- package/node_modules/@aws-amplify/platform-core/lib/index.d.ts +4 -0
- package/node_modules/@aws-amplify/platform-core/lib/index.js +22 -0
- package/node_modules/@aws-amplify/platform-core/lib/unique_backend_identifier.d.ts +53 -0
- package/node_modules/@aws-amplify/platform-core/lib/unique_backend_identifier.js +74 -0
- package/node_modules/@aws-amplify/platform-core/package.json +24 -0
- package/node_modules/@aws-amplify/plugin-types/lib/amplify_function.d.ts +4 -0
- package/node_modules/@aws-amplify/plugin-types/lib/amplify_function.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/amplify_output_writer.d.ts +9 -0
- package/node_modules/@aws-amplify/plugin-types/lib/amplify_output_writer.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/auth_resources.d.ts +42 -0
- package/node_modules/@aws-amplify/plugin-types/lib/auth_resources.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_output.d.ts +6 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_output.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_secret_resolver.d.ts +13 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_secret_resolver.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_stack_creator.d.ts +8 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_stack_creator.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_stack_resolver.d.ts +7 -0
- package/node_modules/@aws-amplify/plugin-types/lib/backend_stack_resolver.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/construct_container.d.ts +26 -0
- package/node_modules/@aws-amplify/plugin-types/lib/construct_container.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/construct_factory.d.ts +21 -0
- package/node_modules/@aws-amplify/plugin-types/lib/construct_factory.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/function_resources.d.ts +5 -0
- package/node_modules/@aws-amplify/plugin-types/lib/function_resources.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/import_path_verifier.d.ts +14 -0
- package/node_modules/@aws-amplify/plugin-types/lib/import_path_verifier.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/index.d.ts +16 -0
- package/node_modules/@aws-amplify/plugin-types/lib/index.js +32 -0
- package/node_modules/@aws-amplify/plugin-types/lib/output_retrieval_strategy.d.ts +11 -0
- package/node_modules/@aws-amplify/plugin-types/lib/output_retrieval_strategy.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/output_storage_strategy.d.ts +8 -0
- package/node_modules/@aws-amplify/plugin-types/lib/output_storage_strategy.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/resource_provider.d.ts +7 -0
- package/node_modules/@aws-amplify/plugin-types/lib/resource_provider.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/lib/unique_backend_identifier.d.ts +25 -0
- package/node_modules/@aws-amplify/plugin-types/lib/unique_backend_identifier.js +3 -0
- package/node_modules/@aws-amplify/plugin-types/package.json +20 -0
- package/node_modules/graphql-transformer-common/API.md +3 -0
- package/node_modules/graphql-transformer-common/CHANGELOG.md +6 -0
- package/node_modules/graphql-transformer-common/LICENSE +201 -0
- package/node_modules/graphql-transformer-common/lib/ResourceConstants.d.ts +3 -0
- package/node_modules/graphql-transformer-common/lib/ResourceConstants.d.ts.map +1 -1
- package/node_modules/graphql-transformer-common/lib/ResourceConstants.js +3 -0
- package/node_modules/graphql-transformer-common/lib/ResourceConstants.js.map +1 -1
- package/node_modules/graphql-transformer-common/package.json +3 -2
- package/package.json +24 -24
- package/src/amplify-dynamodb-table-wrapper.ts +177 -0
- package/src/amplify-graphql-api.ts +10 -3
- package/src/amplify-graphql-definition.ts +63 -3
- package/src/index.ts +13 -0
- package/src/internal/construct-exports.ts +7 -0
- package/src/internal/data-source-config.ts +39 -0
- package/src/internal/index.ts +1 -1
- package/src/internal/model-type-name.ts +30 -0
- package/src/types.ts +54 -7
- package/babel.config.js +0 -13
- package/lib/internal/amplify-metadata.d.ts +0 -6
- package/lib/internal/amplify-metadata.js +0 -58
- package/node_modules/@aws-amplify/backend-output-schemas/lib/index.internal.d.ts +0 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/index.internal.js +0 -27
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/project-config.d.ts +0 -6
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/project-config.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/project-config.js +0 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/project-config.js.map +0 -1
- package/remove-module-type-from-package-json.ts +0 -19
- package/src/internal/amplify-metadata.ts +0 -58
package/README.md
CHANGED
|
@@ -812,6 +812,47 @@ The functions runtime.
|
|
|
812
812
|
|
|
813
813
|
---
|
|
814
814
|
|
|
815
|
+
### AmplifyDynamoDbModelDataSourceDefinitionStrategy <a name="AmplifyDynamoDbModelDataSourceDefinitionStrategy" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy"></a>
|
|
816
|
+
|
|
817
|
+
Use custom resource type 'Custom::AmplifyDynamoDBTable' to provision table.
|
|
818
|
+
|
|
819
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.Initializer"></a>
|
|
820
|
+
|
|
821
|
+
```typescript
|
|
822
|
+
import { AmplifyDynamoDbModelDataSourceDefinitionStrategy } from '@aws-amplify/graphql-api-construct'
|
|
823
|
+
|
|
824
|
+
const amplifyDynamoDbModelDataSourceDefinitionStrategy: AmplifyDynamoDbModelDataSourceDefinitionStrategy = { ... }
|
|
825
|
+
```
|
|
826
|
+
|
|
827
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
828
|
+
|
|
829
|
+
| **Name** | **Type** | **Description** |
|
|
830
|
+
| --- | --- | --- |
|
|
831
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.dbType">dbType</a></code> | <code>string</code> | *No description.* |
|
|
832
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy">provisionStrategy</a></code> | <code>string</code> | *No description.* |
|
|
833
|
+
|
|
834
|
+
---
|
|
835
|
+
|
|
836
|
+
##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.dbType"></a>
|
|
837
|
+
|
|
838
|
+
```typescript
|
|
839
|
+
public readonly dbType: string;
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
- *Type:* string
|
|
843
|
+
|
|
844
|
+
---
|
|
845
|
+
|
|
846
|
+
##### `provisionStrategy`<sup>Required</sup> <a name="provisionStrategy" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy"></a>
|
|
847
|
+
|
|
848
|
+
```typescript
|
|
849
|
+
public readonly provisionStrategy: string;
|
|
850
|
+
```
|
|
851
|
+
|
|
852
|
+
- *Type:* string
|
|
853
|
+
|
|
854
|
+
---
|
|
855
|
+
|
|
815
856
|
### AmplifyGraphqlApiCfnResources <a name="AmplifyGraphqlApiCfnResources" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources"></a>
|
|
816
857
|
|
|
817
858
|
L1 CDK resources from the Api which were generated as part of the transform.
|
|
@@ -1168,6 +1209,7 @@ const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }
|
|
|
1168
1209
|
|
|
1169
1210
|
| **Name** | **Type** | **Description** |
|
|
1170
1211
|
| --- | --- | --- |
|
|
1212
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.amplifyDynamoDbTables">amplifyDynamoDbTables</a></code> | <code>{[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper">AmplifyDynamoDbTableWrapper</a>}</code> | The Generated Amplify DynamoDb Table wrapped if produced, keyed by name. |
|
|
1171
1213
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.cfnResources">cfnResources</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources">AmplifyGraphqlApiCfnResources</a></code> | L1 Cfn Resources, for when dipping down a level of abstraction is desirable. |
|
|
1172
1214
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.functions">functions</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}</code> | The Generated Lambda Function L1 Resources, keyed by function name. |
|
|
1173
1215
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.graphqlApi">graphqlApi</a></code> | <code>aws-cdk-lib.aws_appsync.IGraphqlApi</code> | The Generated AppSync Api L2 Resource, includes the Schema. |
|
|
@@ -1177,6 +1219,18 @@ const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }
|
|
|
1177
1219
|
|
|
1178
1220
|
---
|
|
1179
1221
|
|
|
1222
|
+
##### `amplifyDynamoDbTables`<sup>Required</sup> <a name="amplifyDynamoDbTables" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.amplifyDynamoDbTables"></a>
|
|
1223
|
+
|
|
1224
|
+
```typescript
|
|
1225
|
+
public readonly amplifyDynamoDbTables: {[ key: string ]: AmplifyDynamoDbTableWrapper};
|
|
1226
|
+
```
|
|
1227
|
+
|
|
1228
|
+
- *Type:* {[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper">AmplifyDynamoDbTableWrapper</a>}
|
|
1229
|
+
|
|
1230
|
+
The Generated Amplify DynamoDb Table wrapped if produced, keyed by name.
|
|
1231
|
+
|
|
1232
|
+
---
|
|
1233
|
+
|
|
1180
1234
|
##### `cfnResources`<sup>Required</sup> <a name="cfnResources" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.cfnResources"></a>
|
|
1181
1235
|
|
|
1182
1236
|
```typescript
|
|
@@ -1605,6 +1659,47 @@ For more information, refer to https://docs.aws.amazon.com/appsync/latest/devgui
|
|
|
1605
1659
|
|
|
1606
1660
|
---
|
|
1607
1661
|
|
|
1662
|
+
### DefaultDynamoDbModelDataSourceDefinitionStrategy <a name="DefaultDynamoDbModelDataSourceDefinitionStrategy" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy"></a>
|
|
1663
|
+
|
|
1664
|
+
Use default CloudFormation type 'AWS::DynamoDB::Table' to provision table.
|
|
1665
|
+
|
|
1666
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.Initializer"></a>
|
|
1667
|
+
|
|
1668
|
+
```typescript
|
|
1669
|
+
import { DefaultDynamoDbModelDataSourceDefinitionStrategy } from '@aws-amplify/graphql-api-construct'
|
|
1670
|
+
|
|
1671
|
+
const defaultDynamoDbModelDataSourceDefinitionStrategy: DefaultDynamoDbModelDataSourceDefinitionStrategy = { ... }
|
|
1672
|
+
```
|
|
1673
|
+
|
|
1674
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1675
|
+
|
|
1676
|
+
| **Name** | **Type** | **Description** |
|
|
1677
|
+
| --- | --- | --- |
|
|
1678
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.dbType">dbType</a></code> | <code>string</code> | *No description.* |
|
|
1679
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy">provisionStrategy</a></code> | <code>string</code> | *No description.* |
|
|
1680
|
+
|
|
1681
|
+
---
|
|
1682
|
+
|
|
1683
|
+
##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.dbType"></a>
|
|
1684
|
+
|
|
1685
|
+
```typescript
|
|
1686
|
+
public readonly dbType: string;
|
|
1687
|
+
```
|
|
1688
|
+
|
|
1689
|
+
- *Type:* string
|
|
1690
|
+
|
|
1691
|
+
---
|
|
1692
|
+
|
|
1693
|
+
##### `provisionStrategy`<sup>Required</sup> <a name="provisionStrategy" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy"></a>
|
|
1694
|
+
|
|
1695
|
+
```typescript
|
|
1696
|
+
public readonly provisionStrategy: string;
|
|
1697
|
+
```
|
|
1698
|
+
|
|
1699
|
+
- *Type:* string
|
|
1700
|
+
|
|
1701
|
+
---
|
|
1702
|
+
|
|
1608
1703
|
### FunctionSlotBase <a name="FunctionSlotBase" id="@aws-amplify/graphql-api-construct.FunctionSlotBase"></a>
|
|
1609
1704
|
|
|
1610
1705
|
Common slot parameters.
|
|
@@ -1838,6 +1933,54 @@ How long the results are cached.
|
|
|
1838
1933
|
|
|
1839
1934
|
---
|
|
1840
1935
|
|
|
1936
|
+
### ModelDataSourceDefinition <a name="ModelDataSourceDefinition" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition"></a>
|
|
1937
|
+
|
|
1938
|
+
Defines a datasource for resolving GraphQL operations against `@model` types in a GraphQL schema.
|
|
1939
|
+
|
|
1940
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.Initializer"></a>
|
|
1941
|
+
|
|
1942
|
+
```typescript
|
|
1943
|
+
import { ModelDataSourceDefinition } from '@aws-amplify/graphql-api-construct'
|
|
1944
|
+
|
|
1945
|
+
const modelDataSourceDefinition: ModelDataSourceDefinition = { ... }
|
|
1946
|
+
```
|
|
1947
|
+
|
|
1948
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1949
|
+
|
|
1950
|
+
| **Name** | **Type** | **Description** |
|
|
1951
|
+
| --- | --- | --- |
|
|
1952
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.name">name</a></code> | <code>string</code> | The name of the ModelDataSource. |
|
|
1953
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.strategy">strategy</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy">DefaultDynamoDbModelDataSourceDefinitionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy">AmplifyDynamoDbModelDataSourceDefinitionStrategy</a></code> | The ModelDataSourceDefinitionStrategy. |
|
|
1954
|
+
|
|
1955
|
+
---
|
|
1956
|
+
|
|
1957
|
+
##### `name`<sup>Required</sup> <a name="name" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.name"></a>
|
|
1958
|
+
|
|
1959
|
+
```typescript
|
|
1960
|
+
public readonly name: string;
|
|
1961
|
+
```
|
|
1962
|
+
|
|
1963
|
+
- *Type:* string
|
|
1964
|
+
|
|
1965
|
+
The name of the ModelDataSource.
|
|
1966
|
+
|
|
1967
|
+
This will be used to name the AppSynce DataSource itself, plus any associated resources like resolver
|
|
1968
|
+
Lambdas, custom CDK resources. This name must be unique across all schema definitions in a GraphQL API.
|
|
1969
|
+
|
|
1970
|
+
---
|
|
1971
|
+
|
|
1972
|
+
##### `strategy`<sup>Required</sup> <a name="strategy" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.strategy"></a>
|
|
1973
|
+
|
|
1974
|
+
```typescript
|
|
1975
|
+
public readonly strategy: DefaultDynamoDbModelDataSourceDefinitionStrategy | AmplifyDynamoDbModelDataSourceDefinitionStrategy;
|
|
1976
|
+
```
|
|
1977
|
+
|
|
1978
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy">DefaultDynamoDbModelDataSourceDefinitionStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy">AmplifyDynamoDbModelDataSourceDefinitionStrategy</a>
|
|
1979
|
+
|
|
1980
|
+
The ModelDataSourceDefinitionStrategy.
|
|
1981
|
+
|
|
1982
|
+
---
|
|
1983
|
+
|
|
1841
1984
|
### MutationFunctionSlot <a name="MutationFunctionSlot" id="@aws-amplify/graphql-api-construct.MutationFunctionSlot"></a>
|
|
1842
1985
|
|
|
1843
1986
|
Slot types for Mutation Resolvers.
|
|
@@ -2245,6 +2388,51 @@ Ensure that oidc and userPool auth use the `sub` field in the for the username f
|
|
|
2245
2388
|
|
|
2246
2389
|
---
|
|
2247
2390
|
|
|
2391
|
+
### ProvisionedThroughput <a name="ProvisionedThroughput" id="@aws-amplify/graphql-api-construct.ProvisionedThroughput"></a>
|
|
2392
|
+
|
|
2393
|
+
Wrapper for provisioned throughput config in DDB.
|
|
2394
|
+
|
|
2395
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.ProvisionedThroughput.Initializer"></a>
|
|
2396
|
+
|
|
2397
|
+
```typescript
|
|
2398
|
+
import { ProvisionedThroughput } from '@aws-amplify/graphql-api-construct'
|
|
2399
|
+
|
|
2400
|
+
const provisionedThroughput: ProvisionedThroughput = { ... }
|
|
2401
|
+
```
|
|
2402
|
+
|
|
2403
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2404
|
+
|
|
2405
|
+
| **Name** | **Type** | **Description** |
|
|
2406
|
+
| --- | --- | --- |
|
|
2407
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ProvisionedThroughput.property.readCapacityUnits">readCapacityUnits</a></code> | <code>number</code> | The read capacity units on the table or index. |
|
|
2408
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ProvisionedThroughput.property.writeCapacityUnits">writeCapacityUnits</a></code> | <code>number</code> | The write capacity units on the table or index. |
|
|
2409
|
+
|
|
2410
|
+
---
|
|
2411
|
+
|
|
2412
|
+
##### `readCapacityUnits`<sup>Required</sup> <a name="readCapacityUnits" id="@aws-amplify/graphql-api-construct.ProvisionedThroughput.property.readCapacityUnits"></a>
|
|
2413
|
+
|
|
2414
|
+
```typescript
|
|
2415
|
+
public readonly readCapacityUnits: number;
|
|
2416
|
+
```
|
|
2417
|
+
|
|
2418
|
+
- *Type:* number
|
|
2419
|
+
|
|
2420
|
+
The read capacity units on the table or index.
|
|
2421
|
+
|
|
2422
|
+
---
|
|
2423
|
+
|
|
2424
|
+
##### `writeCapacityUnits`<sup>Required</sup> <a name="writeCapacityUnits" id="@aws-amplify/graphql-api-construct.ProvisionedThroughput.property.writeCapacityUnits"></a>
|
|
2425
|
+
|
|
2426
|
+
```typescript
|
|
2427
|
+
public readonly writeCapacityUnits: number;
|
|
2428
|
+
```
|
|
2429
|
+
|
|
2430
|
+
- *Type:* number
|
|
2431
|
+
|
|
2432
|
+
The write capacity units on the table or index.
|
|
2433
|
+
|
|
2434
|
+
---
|
|
2435
|
+
|
|
2248
2436
|
### QueryFunctionSlot <a name="QueryFunctionSlot" id="@aws-amplify/graphql-api-construct.QueryFunctionSlot"></a>
|
|
2249
2437
|
|
|
2250
2438
|
Slot types for Query Resolvers.
|
|
@@ -2333,6 +2521,112 @@ This slot type applies to the Query type on the Api definition.
|
|
|
2333
2521
|
|
|
2334
2522
|
---
|
|
2335
2523
|
|
|
2524
|
+
### SSESpecification <a name="SSESpecification" id="@aws-amplify/graphql-api-construct.SSESpecification"></a>
|
|
2525
|
+
|
|
2526
|
+
Represents the settings used to enable server-side encryption.
|
|
2527
|
+
|
|
2528
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.SSESpecification.Initializer"></a>
|
|
2529
|
+
|
|
2530
|
+
```typescript
|
|
2531
|
+
import { SSESpecification } from '@aws-amplify/graphql-api-construct'
|
|
2532
|
+
|
|
2533
|
+
const sSESpecification: SSESpecification = { ... }
|
|
2534
|
+
```
|
|
2535
|
+
|
|
2536
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2537
|
+
|
|
2538
|
+
| **Name** | **Type** | **Description** |
|
|
2539
|
+
| --- | --- | --- |
|
|
2540
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SSESpecification.property.sseEnabled">sseEnabled</a></code> | <code>boolean</code> | Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. |
|
|
2541
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SSESpecification.property.kmsMasterKeyId">kmsMasterKeyId</a></code> | <code>string</code> | The AWS KMS key that should be used for the AWS KMS encryption. |
|
|
2542
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SSESpecification.property.sseType">sseType</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.SSEType">SSEType</a></code> | Server-side encryption type. |
|
|
2543
|
+
|
|
2544
|
+
---
|
|
2545
|
+
|
|
2546
|
+
##### `sseEnabled`<sup>Required</sup> <a name="sseEnabled" id="@aws-amplify/graphql-api-construct.SSESpecification.property.sseEnabled"></a>
|
|
2547
|
+
|
|
2548
|
+
```typescript
|
|
2549
|
+
public readonly sseEnabled: boolean;
|
|
2550
|
+
```
|
|
2551
|
+
|
|
2552
|
+
- *Type:* boolean
|
|
2553
|
+
|
|
2554
|
+
Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key.
|
|
2555
|
+
|
|
2556
|
+
If enabled (true), server-side encryption type is set to `KMS` and an AWS managed key is used ( AWS KMS charges apply).
|
|
2557
|
+
If disabled (false) or not specified, server-side encryption is set to AWS owned key.
|
|
2558
|
+
|
|
2559
|
+
---
|
|
2560
|
+
|
|
2561
|
+
##### `kmsMasterKeyId`<sup>Optional</sup> <a name="kmsMasterKeyId" id="@aws-amplify/graphql-api-construct.SSESpecification.property.kmsMasterKeyId"></a>
|
|
2562
|
+
|
|
2563
|
+
```typescript
|
|
2564
|
+
public readonly kmsMasterKeyId: string;
|
|
2565
|
+
```
|
|
2566
|
+
|
|
2567
|
+
- *Type:* string
|
|
2568
|
+
|
|
2569
|
+
The AWS KMS key that should be used for the AWS KMS encryption.
|
|
2570
|
+
|
|
2571
|
+
To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide
|
|
2572
|
+
this parameter if the key is different from the default DynamoDB key `alias/aws/dynamodb` .
|
|
2573
|
+
|
|
2574
|
+
---
|
|
2575
|
+
|
|
2576
|
+
##### `sseType`<sup>Optional</sup> <a name="sseType" id="@aws-amplify/graphql-api-construct.SSESpecification.property.sseType"></a>
|
|
2577
|
+
|
|
2578
|
+
```typescript
|
|
2579
|
+
public readonly sseType: SSEType;
|
|
2580
|
+
```
|
|
2581
|
+
|
|
2582
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.SSEType">SSEType</a>
|
|
2583
|
+
|
|
2584
|
+
Server-side encryption type.
|
|
2585
|
+
|
|
2586
|
+
The only supported value is:
|
|
2587
|
+
`KMS` Server-side encryption that uses AWS Key Management Service.
|
|
2588
|
+
The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
|
|
2589
|
+
|
|
2590
|
+
---
|
|
2591
|
+
|
|
2592
|
+
### StreamSpecification <a name="StreamSpecification" id="@aws-amplify/graphql-api-construct.StreamSpecification"></a>
|
|
2593
|
+
|
|
2594
|
+
Represents the DynamoDB Streams configuration for a table in DynamoDB.
|
|
2595
|
+
|
|
2596
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.StreamSpecification.Initializer"></a>
|
|
2597
|
+
|
|
2598
|
+
```typescript
|
|
2599
|
+
import { StreamSpecification } from '@aws-amplify/graphql-api-construct'
|
|
2600
|
+
|
|
2601
|
+
const streamSpecification: StreamSpecification = { ... }
|
|
2602
|
+
```
|
|
2603
|
+
|
|
2604
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2605
|
+
|
|
2606
|
+
| **Name** | **Type** | **Description** |
|
|
2607
|
+
| --- | --- | --- |
|
|
2608
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.StreamSpecification.property.streamViewType">streamViewType</a></code> | <code>aws-cdk-lib.aws_dynamodb.StreamViewType</code> | When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table. |
|
|
2609
|
+
|
|
2610
|
+
---
|
|
2611
|
+
|
|
2612
|
+
##### `streamViewType`<sup>Required</sup> <a name="streamViewType" id="@aws-amplify/graphql-api-construct.StreamSpecification.property.streamViewType"></a>
|
|
2613
|
+
|
|
2614
|
+
```typescript
|
|
2615
|
+
public readonly streamViewType: StreamViewType;
|
|
2616
|
+
```
|
|
2617
|
+
|
|
2618
|
+
- *Type:* aws-cdk-lib.aws_dynamodb.StreamViewType
|
|
2619
|
+
|
|
2620
|
+
When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table.
|
|
2621
|
+
|
|
2622
|
+
Valid values for `StreamViewType` are:
|
|
2623
|
+
- `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
|
|
2624
|
+
- `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
|
|
2625
|
+
- `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
|
|
2626
|
+
- `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
|
|
2627
|
+
|
|
2628
|
+
---
|
|
2629
|
+
|
|
2336
2630
|
### SubscriptionFunctionSlot <a name="SubscriptionFunctionSlot" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot"></a>
|
|
2337
2631
|
|
|
2338
2632
|
Slot types for Subscription Resolvers.
|
|
@@ -2421,6 +2715,51 @@ This slot type applies to the Subscription type on the Api definition.
|
|
|
2421
2715
|
|
|
2422
2716
|
---
|
|
2423
2717
|
|
|
2718
|
+
### TimeToLiveSpecification <a name="TimeToLiveSpecification" id="@aws-amplify/graphql-api-construct.TimeToLiveSpecification"></a>
|
|
2719
|
+
|
|
2720
|
+
Shape for TTL config.
|
|
2721
|
+
|
|
2722
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.TimeToLiveSpecification.Initializer"></a>
|
|
2723
|
+
|
|
2724
|
+
```typescript
|
|
2725
|
+
import { TimeToLiveSpecification } from '@aws-amplify/graphql-api-construct'
|
|
2726
|
+
|
|
2727
|
+
const timeToLiveSpecification: TimeToLiveSpecification = { ... }
|
|
2728
|
+
```
|
|
2729
|
+
|
|
2730
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2731
|
+
|
|
2732
|
+
| **Name** | **Type** | **Description** |
|
|
2733
|
+
| --- | --- | --- |
|
|
2734
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TimeToLiveSpecification.property.enabled">enabled</a></code> | <code>boolean</code> | Boolean determining if the ttl is enabled or not. |
|
|
2735
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TimeToLiveSpecification.property.attributeName">attributeName</a></code> | <code>string</code> | Attribute name to apply to the ttl spec. |
|
|
2736
|
+
|
|
2737
|
+
---
|
|
2738
|
+
|
|
2739
|
+
##### `enabled`<sup>Required</sup> <a name="enabled" id="@aws-amplify/graphql-api-construct.TimeToLiveSpecification.property.enabled"></a>
|
|
2740
|
+
|
|
2741
|
+
```typescript
|
|
2742
|
+
public readonly enabled: boolean;
|
|
2743
|
+
```
|
|
2744
|
+
|
|
2745
|
+
- *Type:* boolean
|
|
2746
|
+
|
|
2747
|
+
Boolean determining if the ttl is enabled or not.
|
|
2748
|
+
|
|
2749
|
+
---
|
|
2750
|
+
|
|
2751
|
+
##### `attributeName`<sup>Optional</sup> <a name="attributeName" id="@aws-amplify/graphql-api-construct.TimeToLiveSpecification.property.attributeName"></a>
|
|
2752
|
+
|
|
2753
|
+
```typescript
|
|
2754
|
+
public readonly attributeName: string;
|
|
2755
|
+
```
|
|
2756
|
+
|
|
2757
|
+
- *Type:* string
|
|
2758
|
+
|
|
2759
|
+
Attribute name to apply to the ttl spec.
|
|
2760
|
+
|
|
2761
|
+
---
|
|
2762
|
+
|
|
2424
2763
|
### TranslationBehavior <a name="TranslationBehavior" id="@aws-amplify/graphql-api-construct.TranslationBehavior"></a>
|
|
2425
2764
|
|
|
2426
2765
|
Strongly typed set of shared parameters for all transformers, and core layer.
|
|
@@ -2443,7 +2782,7 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
|
2443
2782
|
| --- | --- | --- |
|
|
2444
2783
|
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.disableResolverDeduping">disableResolverDeduping</a></code> | <code>boolean</code> | Disable resolver deduping, this can sometimes cause problems because dedupe ordering isn't stable today, which can lead to circular dependencies across stacks if models are reordered. |
|
|
2445
2784
|
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableAutoIndexQueryNames">enableAutoIndexQueryNames</a></code> | <code>boolean</code> | Automate generation of query names, and as a result attaching all indexes as queries to the generated Api. |
|
|
2446
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> |
|
|
2785
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | *No description.* |
|
|
2447
2786
|
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableTransformerCfnOutputs">enableTransformerCfnOutputs</a></code> | <code>boolean</code> | When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted. |
|
|
2448
2787
|
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.populateOwnerFieldForStaticGroupAuth">populateOwnerFieldForStaticGroupAuth</a></code> | <code>boolean</code> | Ensure that the owner field is still populated even if a static iam or group authorization applies. |
|
|
2449
2788
|
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.respectPrimaryKeyAttributesOnConnectionField">respectPrimaryKeyAttributesOnConnectionField</a></code> | <code>boolean</code> | Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app. |
|
|
@@ -2490,14 +2829,6 @@ public readonly enableSearchNodeToNodeEncryption: boolean;
|
|
|
2490
2829
|
```
|
|
2491
2830
|
|
|
2492
2831
|
- *Type:* boolean
|
|
2493
|
-
- *Default:* false
|
|
2494
|
-
|
|
2495
|
-
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
|
2496
|
-
|
|
2497
|
-
Not recommended for use, prefer
|
|
2498
|
-
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
|
2499
|
-
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2500
|
-
});
|
|
2501
2832
|
|
|
2502
2833
|
---
|
|
2503
2834
|
|
|
@@ -2641,6 +2972,195 @@ The Cognito User Pool which is used to authenticated JWT tokens, and vends group
|
|
|
2641
2972
|
|
|
2642
2973
|
## Classes <a name="Classes" id="Classes"></a>
|
|
2643
2974
|
|
|
2975
|
+
### AmplifyDynamoDbTableWrapper <a name="AmplifyDynamoDbTableWrapper" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper"></a>
|
|
2976
|
+
|
|
2977
|
+
Wrapper class around Custom::AmplifyDynamoDBTable custom resource, to simplify the override experience a bit.
|
|
2978
|
+
|
|
2979
|
+
This is NOT a construct, just an easier way to access
|
|
2980
|
+
the generated construct.
|
|
2981
|
+
This is a wrapper intended to mimic the `aws_cdk_lib.aws_dynamodb.Table` functionality more-or-less.
|
|
2982
|
+
Notable differences is the addition of TKTK properties, to account for the fact that they're constructor props
|
|
2983
|
+
in the CDK construct, as well as the removal of all from*, grant*, and metric* methods implemented by Table.
|
|
2984
|
+
|
|
2985
|
+
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.Initializer"></a>
|
|
2986
|
+
|
|
2987
|
+
```typescript
|
|
2988
|
+
import { AmplifyDynamoDbTableWrapper } from '@aws-amplify/graphql-api-construct'
|
|
2989
|
+
|
|
2990
|
+
new AmplifyDynamoDbTableWrapper(resource: CfnResource)
|
|
2991
|
+
```
|
|
2992
|
+
|
|
2993
|
+
| **Name** | **Type** | **Description** |
|
|
2994
|
+
| --- | --- | --- |
|
|
2995
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.Initializer.parameter.resource">resource</a></code> | <code>aws-cdk-lib.CfnResource</code> | the Cfn resource. |
|
|
2996
|
+
|
|
2997
|
+
---
|
|
2998
|
+
|
|
2999
|
+
##### `resource`<sup>Required</sup> <a name="resource" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.Initializer.parameter.resource"></a>
|
|
3000
|
+
|
|
3001
|
+
- *Type:* aws-cdk-lib.CfnResource
|
|
3002
|
+
|
|
3003
|
+
the Cfn resource.
|
|
3004
|
+
|
|
3005
|
+
---
|
|
3006
|
+
|
|
3007
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
3008
|
+
|
|
3009
|
+
| **Name** | **Description** |
|
|
3010
|
+
| --- | --- |
|
|
3011
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.setGlobalSecondaryIndexProvisionedThroughput">setGlobalSecondaryIndexProvisionedThroughput</a></code> | Set the provisionedThroughtput for a specified GSI by name. |
|
|
3012
|
+
|
|
3013
|
+
---
|
|
3014
|
+
|
|
3015
|
+
##### `setGlobalSecondaryIndexProvisionedThroughput` <a name="setGlobalSecondaryIndexProvisionedThroughput" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.setGlobalSecondaryIndexProvisionedThroughput"></a>
|
|
3016
|
+
|
|
3017
|
+
```typescript
|
|
3018
|
+
public setGlobalSecondaryIndexProvisionedThroughput(indexName: string, provisionedThroughput: ProvisionedThroughput): void
|
|
3019
|
+
```
|
|
3020
|
+
|
|
3021
|
+
Set the provisionedThroughtput for a specified GSI by name.
|
|
3022
|
+
|
|
3023
|
+
###### `indexName`<sup>Required</sup> <a name="indexName" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.setGlobalSecondaryIndexProvisionedThroughput.parameter.indexName"></a>
|
|
3024
|
+
|
|
3025
|
+
- *Type:* string
|
|
3026
|
+
|
|
3027
|
+
the index to specify a provisionedThroughput config for.
|
|
3028
|
+
|
|
3029
|
+
---
|
|
3030
|
+
|
|
3031
|
+
###### `provisionedThroughput`<sup>Required</sup> <a name="provisionedThroughput" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.setGlobalSecondaryIndexProvisionedThroughput.parameter.provisionedThroughput"></a>
|
|
3032
|
+
|
|
3033
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ProvisionedThroughput">ProvisionedThroughput</a>
|
|
3034
|
+
|
|
3035
|
+
the config to set.
|
|
3036
|
+
|
|
3037
|
+
---
|
|
3038
|
+
|
|
3039
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
3040
|
+
|
|
3041
|
+
| **Name** | **Description** |
|
|
3042
|
+
| --- | --- |
|
|
3043
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.isAmplifyDynamoDbTableResource">isAmplifyDynamoDbTableResource</a></code> | Return true and perform type narrowing if a given input appears to be capable of. |
|
|
3044
|
+
|
|
3045
|
+
---
|
|
3046
|
+
|
|
3047
|
+
##### `isAmplifyDynamoDbTableResource` <a name="isAmplifyDynamoDbTableResource" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.isAmplifyDynamoDbTableResource"></a>
|
|
3048
|
+
|
|
3049
|
+
```typescript
|
|
3050
|
+
import { AmplifyDynamoDbTableWrapper } from '@aws-amplify/graphql-api-construct'
|
|
3051
|
+
|
|
3052
|
+
AmplifyDynamoDbTableWrapper.isAmplifyDynamoDbTableResource(x: any)
|
|
3053
|
+
```
|
|
3054
|
+
|
|
3055
|
+
Return true and perform type narrowing if a given input appears to be capable of.
|
|
3056
|
+
|
|
3057
|
+
###### `x`<sup>Required</sup> <a name="x" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.isAmplifyDynamoDbTableResource.parameter.x"></a>
|
|
3058
|
+
|
|
3059
|
+
- *Type:* any
|
|
3060
|
+
|
|
3061
|
+
the object to check.
|
|
3062
|
+
|
|
3063
|
+
---
|
|
3064
|
+
|
|
3065
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3066
|
+
|
|
3067
|
+
| **Name** | **Type** | **Description** |
|
|
3068
|
+
| --- | --- | --- |
|
|
3069
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.billingMode">billingMode</a></code> | <code>aws-cdk-lib.aws_dynamodb.BillingMode</code> | Specify how you are charged for read and write throughput and how you manage capacity. |
|
|
3070
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.deletionProtectionEnabled">deletionProtectionEnabled</a></code> | <code>boolean</code> | Set table deletion protection. |
|
|
3071
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.pointInTimeRecoveryEnabled">pointInTimeRecoveryEnabled</a></code> | <code>boolean</code> | Whether point-in-time recovery is enabled. |
|
|
3072
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.provisionedThroughput">provisionedThroughput</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.ProvisionedThroughput">ProvisionedThroughput</a></code> | Update the provisioned throughput for the base table. |
|
|
3073
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.sseSpecification">sseSpecification</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.SSESpecification">SSESpecification</a></code> | Set the ddb server-side encryption specification on the table. |
|
|
3074
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.streamSpecification">streamSpecification</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.StreamSpecification">StreamSpecification</a></code> | Set the ddb stream specification on the table. |
|
|
3075
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.timeToLiveAttribute">timeToLiveAttribute</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.TimeToLiveSpecification">TimeToLiveSpecification</a></code> | The name of TTL attribute. |
|
|
3076
|
+
|
|
3077
|
+
---
|
|
3078
|
+
|
|
3079
|
+
##### `billingMode`<sup>Required</sup> <a name="billingMode" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.billingMode"></a>
|
|
3080
|
+
|
|
3081
|
+
```typescript
|
|
3082
|
+
public readonly billingMode: BillingMode;
|
|
3083
|
+
```
|
|
3084
|
+
|
|
3085
|
+
- *Type:* aws-cdk-lib.aws_dynamodb.BillingMode
|
|
3086
|
+
|
|
3087
|
+
Specify how you are charged for read and write throughput and how you manage capacity.
|
|
3088
|
+
|
|
3089
|
+
---
|
|
3090
|
+
|
|
3091
|
+
##### `deletionProtectionEnabled`<sup>Required</sup> <a name="deletionProtectionEnabled" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.deletionProtectionEnabled"></a>
|
|
3092
|
+
|
|
3093
|
+
```typescript
|
|
3094
|
+
public readonly deletionProtectionEnabled: boolean;
|
|
3095
|
+
```
|
|
3096
|
+
|
|
3097
|
+
- *Type:* boolean
|
|
3098
|
+
|
|
3099
|
+
Set table deletion protection.
|
|
3100
|
+
|
|
3101
|
+
---
|
|
3102
|
+
|
|
3103
|
+
##### `pointInTimeRecoveryEnabled`<sup>Required</sup> <a name="pointInTimeRecoveryEnabled" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.pointInTimeRecoveryEnabled"></a>
|
|
3104
|
+
|
|
3105
|
+
```typescript
|
|
3106
|
+
public readonly pointInTimeRecoveryEnabled: boolean;
|
|
3107
|
+
```
|
|
3108
|
+
|
|
3109
|
+
- *Type:* boolean
|
|
3110
|
+
|
|
3111
|
+
Whether point-in-time recovery is enabled.
|
|
3112
|
+
|
|
3113
|
+
---
|
|
3114
|
+
|
|
3115
|
+
##### `provisionedThroughput`<sup>Required</sup> <a name="provisionedThroughput" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.provisionedThroughput"></a>
|
|
3116
|
+
|
|
3117
|
+
```typescript
|
|
3118
|
+
public readonly provisionedThroughput: ProvisionedThroughput;
|
|
3119
|
+
```
|
|
3120
|
+
|
|
3121
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ProvisionedThroughput">ProvisionedThroughput</a>
|
|
3122
|
+
|
|
3123
|
+
Update the provisioned throughput for the base table.
|
|
3124
|
+
|
|
3125
|
+
---
|
|
3126
|
+
|
|
3127
|
+
##### `sseSpecification`<sup>Required</sup> <a name="sseSpecification" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.sseSpecification"></a>
|
|
3128
|
+
|
|
3129
|
+
```typescript
|
|
3130
|
+
public readonly sseSpecification: SSESpecification;
|
|
3131
|
+
```
|
|
3132
|
+
|
|
3133
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.SSESpecification">SSESpecification</a>
|
|
3134
|
+
|
|
3135
|
+
Set the ddb server-side encryption specification on the table.
|
|
3136
|
+
|
|
3137
|
+
---
|
|
3138
|
+
|
|
3139
|
+
##### `streamSpecification`<sup>Required</sup> <a name="streamSpecification" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.streamSpecification"></a>
|
|
3140
|
+
|
|
3141
|
+
```typescript
|
|
3142
|
+
public readonly streamSpecification: StreamSpecification;
|
|
3143
|
+
```
|
|
3144
|
+
|
|
3145
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.StreamSpecification">StreamSpecification</a>
|
|
3146
|
+
|
|
3147
|
+
Set the ddb stream specification on the table.
|
|
3148
|
+
|
|
3149
|
+
---
|
|
3150
|
+
|
|
3151
|
+
##### `timeToLiveAttribute`<sup>Required</sup> <a name="timeToLiveAttribute" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper.property.timeToLiveAttribute"></a>
|
|
3152
|
+
|
|
3153
|
+
```typescript
|
|
3154
|
+
public readonly timeToLiveAttribute: TimeToLiveSpecification;
|
|
3155
|
+
```
|
|
3156
|
+
|
|
3157
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.TimeToLiveSpecification">TimeToLiveSpecification</a>
|
|
3158
|
+
|
|
3159
|
+
The name of TTL attribute.
|
|
3160
|
+
|
|
3161
|
+
---
|
|
3162
|
+
|
|
3163
|
+
|
|
2644
3164
|
### AmplifyGraphqlDefinition <a name="AmplifyGraphqlDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition"></a>
|
|
2645
3165
|
|
|
2646
3166
|
Class exposing utilities to produce IAmplifyGraphqlDefinition objects given various inputs.
|
|
@@ -2663,11 +3183,31 @@ new AmplifyGraphqlDefinition()
|
|
|
2663
3183
|
|
|
2664
3184
|
| **Name** | **Description** |
|
|
2665
3185
|
| --- | --- |
|
|
3186
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.combine">combine</a></code> | Combines multiple IAmplifyGraphqlDefinitions into a single definition. |
|
|
2666
3187
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles">fromFiles</a></code> | Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema. |
|
|
3188
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition">fromFilesAndDefinition</a></code> | Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema. |
|
|
2667
3189
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input. |
|
|
2668
3190
|
|
|
2669
3191
|
---
|
|
2670
3192
|
|
|
3193
|
+
##### `combine` <a name="combine" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.combine"></a>
|
|
3194
|
+
|
|
3195
|
+
```typescript
|
|
3196
|
+
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
3197
|
+
|
|
3198
|
+
AmplifyGraphqlDefinition.combine(definitions: IAmplifyGraphqlDefinition[])
|
|
3199
|
+
```
|
|
3200
|
+
|
|
3201
|
+
Combines multiple IAmplifyGraphqlDefinitions into a single definition.
|
|
3202
|
+
|
|
3203
|
+
###### `definitions`<sup>Required</sup> <a name="definitions" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.combine.parameter.definitions"></a>
|
|
3204
|
+
|
|
3205
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>[]
|
|
3206
|
+
|
|
3207
|
+
the definitions to combine.
|
|
3208
|
+
|
|
3209
|
+
---
|
|
3210
|
+
|
|
2671
3211
|
##### `fromFiles` <a name="fromFiles" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles"></a>
|
|
2672
3212
|
|
|
2673
3213
|
```typescript
|
|
@@ -2686,12 +3226,40 @@ one or more paths to the graphql files to process.
|
|
|
2686
3226
|
|
|
2687
3227
|
---
|
|
2688
3228
|
|
|
3229
|
+
##### `fromFilesAndDefinition` <a name="fromFilesAndDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition"></a>
|
|
3230
|
+
|
|
3231
|
+
```typescript
|
|
3232
|
+
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
3233
|
+
|
|
3234
|
+
AmplifyGraphqlDefinition.fromFilesAndDefinition(filePaths: string | string[], modelDataSourceDefinition?: ModelDataSourceDefinition)
|
|
3235
|
+
```
|
|
3236
|
+
|
|
3237
|
+
Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.
|
|
3238
|
+
|
|
3239
|
+
###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition.parameter.filePaths"></a>
|
|
3240
|
+
|
|
3241
|
+
- *Type:* string | string[]
|
|
3242
|
+
|
|
3243
|
+
one or more paths to the graphql files to process.
|
|
3244
|
+
|
|
3245
|
+
---
|
|
3246
|
+
|
|
3247
|
+
###### `modelDataSourceDefinition`<sup>Optional</sup> <a name="modelDataSourceDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition.parameter.modelDataSourceDefinition"></a>
|
|
3248
|
+
|
|
3249
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>
|
|
3250
|
+
|
|
3251
|
+
the provision definition for `@model` datasource.
|
|
3252
|
+
|
|
3253
|
+
The DynamoDB from CloudFormation will be used by default.
|
|
3254
|
+
|
|
3255
|
+
---
|
|
3256
|
+
|
|
2689
3257
|
##### `fromString` <a name="fromString" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString"></a>
|
|
2690
3258
|
|
|
2691
3259
|
```typescript
|
|
2692
3260
|
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
2693
3261
|
|
|
2694
|
-
AmplifyGraphqlDefinition.fromString(schema: string)
|
|
3262
|
+
AmplifyGraphqlDefinition.fromString(schema: string, modelDataSourceDefinition?: ModelDataSourceDefinition)
|
|
2695
3263
|
```
|
|
2696
3264
|
|
|
2697
3265
|
Produce a schema definition from a string input.
|
|
@@ -2704,6 +3272,16 @@ the graphql input as a string.
|
|
|
2704
3272
|
|
|
2705
3273
|
---
|
|
2706
3274
|
|
|
3275
|
+
###### `modelDataSourceDefinition`<sup>Optional</sup> <a name="modelDataSourceDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.modelDataSourceDefinition"></a>
|
|
3276
|
+
|
|
3277
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>
|
|
3278
|
+
|
|
3279
|
+
the provision definition for `@model` datasource.
|
|
3280
|
+
|
|
3281
|
+
The DynamoDB from CloudFormation will be used by default.
|
|
3282
|
+
|
|
3283
|
+
---
|
|
3284
|
+
|
|
2707
3285
|
|
|
2708
3286
|
|
|
2709
3287
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
@@ -2719,11 +3297,26 @@ Graphql Api definition, which can be implemented in multiple ways.
|
|
|
2719
3297
|
|
|
2720
3298
|
| **Name** | **Type** | **Description** |
|
|
2721
3299
|
| --- | --- | --- |
|
|
3300
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.dataSourceDefinition">dataSourceDefinition</a></code> | <code>{[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>}</code> | Retrieve the datasource definition mapping. |
|
|
2722
3301
|
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.functionSlots">functionSlots</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot">MutationFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot">QueryFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot">SubscriptionFunctionSlot</a>[]</code> | Retrieve any function slots defined explicitly in the Api definition. |
|
|
2723
3302
|
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.schema">schema</a></code> | <code>string</code> | Return the schema definition as a graphql string, with amplify directives allowed. |
|
|
2724
3303
|
|
|
2725
3304
|
---
|
|
2726
3305
|
|
|
3306
|
+
##### `dataSourceDefinition`<sup>Required</sup> <a name="dataSourceDefinition" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.dataSourceDefinition"></a>
|
|
3307
|
+
|
|
3308
|
+
```typescript
|
|
3309
|
+
public readonly dataSourceDefinition: {[ key: string ]: ModelDataSourceDefinition};
|
|
3310
|
+
```
|
|
3311
|
+
|
|
3312
|
+
- *Type:* {[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>}
|
|
3313
|
+
|
|
3314
|
+
Retrieve the datasource definition mapping.
|
|
3315
|
+
|
|
3316
|
+
The default strategy is to use DynamoDB from CloudFormation.
|
|
3317
|
+
|
|
3318
|
+
---
|
|
3319
|
+
|
|
2727
3320
|
##### `functionSlots`<sup>Required</sup> <a name="functionSlots" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.functionSlots"></a>
|
|
2728
3321
|
|
|
2729
3322
|
```typescript
|
|
@@ -2827,3 +3420,23 @@ the record to store in the backend output.
|
|
|
2827
3420
|
---
|
|
2828
3421
|
|
|
2829
3422
|
|
|
3423
|
+
## Enums <a name="Enums" id="Enums"></a>
|
|
3424
|
+
|
|
3425
|
+
### SSEType <a name="SSEType" id="@aws-amplify/graphql-api-construct.SSEType"></a>
|
|
3426
|
+
|
|
3427
|
+
Server Side Encryption Type Values - `KMS` - Server-side encryption that uses AWS KMS.
|
|
3428
|
+
|
|
3429
|
+
The key is stored in your account and is managed by KMS (AWS KMS charges apply).
|
|
3430
|
+
|
|
3431
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3432
|
+
|
|
3433
|
+
| **Name** | **Description** |
|
|
3434
|
+
| --- | --- |
|
|
3435
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SSEType.KMS">KMS</a></code> | *No description.* |
|
|
3436
|
+
|
|
3437
|
+
---
|
|
3438
|
+
|
|
3439
|
+
##### `KMS` <a name="KMS" id="@aws-amplify/graphql-api-construct.SSEType.KMS"></a>
|
|
3440
|
+
|
|
3441
|
+
---
|
|
3442
|
+
|