@aws-amplify/graphql-api-construct 1.3.0-rds-5.0 → 1.4.0-construct-publish-test.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.jsii +774 -465
- package/API.md +67 -28
- package/CHANGELOG.md +19 -3
- package/README.md +1039 -401
- 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 -6
- package/lib/amplify-graphql-api.js +12 -61
- package/lib/amplify-graphql-definition.d.ts +19 -13
- package/lib/amplify-graphql-definition.js +58 -21
- package/lib/index.d.ts +2 -1
- package/lib/index.js +5 -2
- package/lib/internal/authorization-modes.js +20 -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 +52 -102
- package/lib/types.js +1 -1
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/index.js +8 -9
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/v1.js +16 -18
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/index.js +11 -16
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/v1.js +23 -19
- 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 +38 -60
- 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 -9
- 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 +8 -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 +10 -11
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/index.js +8 -9
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/v1.js +10 -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/API.md +1 -5
- package/node_modules/@aws-amplify/graphql-auth-transformer/CHANGELOG.md +4 -12
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.d.ts +1 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.js +50 -64
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/field.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/field.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/field.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/field.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/helpers.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/helpers.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/helpers.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/helpers.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/index.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/index.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.create.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.create.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.create.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.create.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.delete.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.delete.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.delete.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.delete.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.update.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.update.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.update.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.update.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.d.ts +6 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/query.js +3 -28
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/search.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/search.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/search.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/search.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/rds/resolvers/subscription.d.ts → resolvers/subscriptions.d.ts} +2 -2
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/subscriptions.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/subscriptions.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/subscriptions.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.js +0 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/schema.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/schema.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.d.ts +2 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.js +1 -4
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/package.json +11 -11
- package/node_modules/@aws-amplify/graphql-default-value-transformer/CHANGELOG.md +5 -3
- package/node_modules/@aws-amplify/graphql-default-value-transformer/lib/graphql-default-value-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-default-value-transformer/lib/graphql-default-value-transformer.js +1 -13
- package/node_modules/@aws-amplify/graphql-default-value-transformer/lib/graphql-default-value-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-default-value-transformer/package.json +8 -8
- package/node_modules/@aws-amplify/graphql-function-transformer/CHANGELOG.md +5 -1
- package/node_modules/@aws-amplify/graphql-function-transformer/package.json +7 -7
- package/node_modules/@aws-amplify/graphql-http-transformer/CHANGELOG.md +5 -1
- package/node_modules/@aws-amplify/graphql-http-transformer/package.json +7 -7
- package/node_modules/@aws-amplify/graphql-index-transformer/API.md +3 -0
- package/node_modules/@aws-amplify/graphql-index-transformer/CHANGELOG.md +6 -4
- 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 +2 -2
- 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/generators/rds-vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/generators/rds-vtl-generator.js +1 -4
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/generators/rds-vtl-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.d.ts +5 -6
- 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 +43 -26
- 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 -8
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/API.md +0 -15
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/CHANGELOG.md +4 -8
- 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/lib/field-mapping-resolvers.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.js +1 -13
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.d.ts +1 -2
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.js +33 -16
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.js +1 -3
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/package.json +13 -13
- package/node_modules/@aws-amplify/graphql-model-transformer/API.md +15 -15
- package/node_modules/@aws-amplify/graphql-model-transformer/CHANGELOG.md +5 -13
- 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 +58 -66
- 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/graphql-types/mutation.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-types/mutation.js +2 -9
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-types/mutation.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/resolvers/generators/dynamodb-vtl-generator.d.ts +5 -6
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.js +5 -5
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.d.ts +5 -6
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.js +11 -11
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/vtl-generator.d.ts +5 -6
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.d.ts +3 -4
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.js +55 -74
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.d.ts +1 -2
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.js +2 -8
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.d.ts +3 -10
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.js +42 -127
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.js.map +1 -1
- 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/lib/resources/model-resource-generator.js +5 -5
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/model-resource-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.js +1 -28
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/package.json +11 -9
- package/node_modules/@aws-amplify/graphql-predictions-transformer/CHANGELOG.md +5 -1
- package/node_modules/@aws-amplify/graphql-predictions-transformer/lib/predictionsLambdaFunction.zip +0 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/package.json +7 -7
- package/node_modules/@aws-amplify/graphql-relational-transformer/CHANGELOG.md +6 -5
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-belongs-to-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-belongs-to-transformer.js +9 -41
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-belongs-to-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-many-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-many-transformer.js +8 -35
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-many-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-one-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-one-transformer.js +8 -30
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-one-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-many-to-many-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-many-to-many-transformer.js +2 -3
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-many-to-many-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.d.ts +4 -4
- 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 +164 -24
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/schema.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/schema.js +8 -14
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/schema.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/types.d.ts +0 -4
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/types.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.d.ts +0 -5
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.js +1 -85
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/package.json +10 -10
- package/node_modules/@aws-amplify/graphql-searchable-transformer/CHANGELOG.md +5 -3
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/graphql-searchable-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/graphql-searchable-transformer.js +0 -3
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/graphql-searchable-transformer.js.map +1 -1
- 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 -8
- package/node_modules/@aws-amplify/graphql-transformer/API.md +2 -3
- package/node_modules/@aws-amplify/graphql-transformer/CHANGELOG.md +5 -8
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.d.ts +3 -4
- 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 +1 -5
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer/package.json +14 -15
- package/node_modules/@aws-amplify/graphql-transformer/src/graphql-transformer.ts +5 -15
- package/node_modules/@aws-amplify/graphql-transformer-core/API.md +7 -39
- package/node_modules/@aws-amplify/graphql-transformer-core/CHANGELOG.md +7 -12
- 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/graphql-api.js +2 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/graphql-api.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.d.ts +4 -4
- 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 -10
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transform-host.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transform-host.js +1 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transform-host.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 +3 -2
- 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 +3 -2
- 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 -4
- 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 +4 -6
- 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/transformer-context/index.js +1 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformer-context/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.d.ts +1 -4
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.js +2 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.js +1 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/authType.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/authType.js +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/authType.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.d.ts +3 -3
- 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 +5 -14
- 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/lib/utils/rds-secret-utils.d.ts +2 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.js +25 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.d.ts +1 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.js +1 -7
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/wrappers/object-definition-wrapper.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/wrappers/object-definition-wrapper.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/package.json +4 -4
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/API.md +17 -12
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/CHANGELOG.md +8 -5
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.d.ts +2 -5
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/index.js.map +1 -1
- 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 -3
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-context-provider.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-datasource-provider.d.ts +8 -2
- 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 +2 -2
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/graphql-api-provider.ts +16 -17
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/index.ts +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/index.ts +3 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-context-provider.ts +2 -3
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-datasource-provider.ts +18 -10
- 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-mapping-template/CHANGELOG.md +0 -4
- package/node_modules/graphql-mapping-template/package.json +2 -3
- package/node_modules/graphql-transformer-common/API.md +3 -21
- package/node_modules/graphql-transformer-common/CHANGELOG.md +2 -7
- 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/lib/definition.d.ts +2 -9
- package/node_modules/graphql-transformer-common/lib/definition.d.ts.map +1 -1
- package/node_modules/graphql-transformer-common/lib/definition.js +1 -52
- package/node_modules/graphql-transformer-common/lib/definition.js.map +1 -1
- package/node_modules/graphql-transformer-common/lib/util.d.ts.map +1 -1
- package/node_modules/graphql-transformer-common/lib/util.js +1 -3
- package/node_modules/graphql-transformer-common/lib/util.js.map +1 -1
- package/node_modules/graphql-transformer-common/package.json +6 -6
- package/package.json +25 -27
- package/src/amplify-dynamodb-table-wrapper.ts +177 -0
- package/src/amplify-graphql-api.ts +14 -76
- package/src/amplify-graphql-definition.ts +60 -20
- package/src/index.ts +13 -6
- package/src/internal/authorization-modes.ts +22 -1
- 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 +59 -118
- package/babel.config.js +0 -13
- package/lib/internal/amplify-metadata.d.ts +0 -6
- package/lib/internal/amplify-metadata.js +0 -58
- package/lib/sql-model-datasource-binding.d.ts +0 -20
- package/lib/sql-model-datasource-binding.js +0 -42
- 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-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.d.ts +0 -20
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.js +0 -24
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/field.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/field.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/helpers.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/helpers.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.create.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.create.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.delete.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.delete.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.update.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.update.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.d.ts +0 -6
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/search.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/search.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.d.ts +0 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.d.ts +0 -20
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.js +0 -24
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.d.ts +0 -13
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.js +0 -157
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.d.ts +0 -5
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.js +0 -21
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.d.ts +0 -8
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.js +0 -56
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.d.ts +0 -8
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.js +0 -41
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.js +0 -18
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.d.ts +0 -19
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.js +0 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.d.ts +0 -10
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.js +0 -102
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.d.ts +0 -13
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.js +0 -81
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.d.ts +0 -13
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.js +0 -171
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.d.ts +0 -4
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.js +0 -18
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.d.ts +0 -8
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.js +0 -7
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.d.ts +0 -14
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.js +0 -115
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/API.md +0 -26
- package/node_modules/@aws-amplify/graphql-sql-transformer/CHANGELOG.md +0 -10
- package/node_modules/@aws-amplify/graphql-sql-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-sql-transformer/README.md +0 -13
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.d.ts +0 -12
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.js +0 -132
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.d.ts +0 -2
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.js +0 -6
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/package.json +0 -71
- 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/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.d.ts +0 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.js +0 -5
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.d.ts +0 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.js +0 -19
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.d.ts +0 -14
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.js +0 -82
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.js.map +0 -1
- package/node_modules/graphql-mapping-template/LICENSE +0 -201
- package/remove-module-type-from-package-json.ts +0 -19
- package/src/internal/amplify-metadata.ts +0 -58
- package/src/sql-model-datasource-binding.ts +0 -45
- /package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/index.d.ts +0 -0
- /package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/index.js +0 -0
package/README.md
CHANGED
|
@@ -165,7 +165,6 @@ The output of this construct is a mapping of L2 or L1 resources generated by the
|
|
|
165
165
|
table.pointInTimeRecoverySpecification = { pointInTimeRecoveryEnabled: false };
|
|
166
166
|
});
|
|
167
167
|
```
|
|
168
|
-
|
|
169
168
|
`resources.<ResourceType>.<ResourceName>` - you can then perform any CDK action on these resulting resoureces.
|
|
170
169
|
|
|
171
170
|
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer"></a>
|
|
@@ -176,17 +175,17 @@ import { AmplifyGraphqlApi } from '@aws-amplify/graphql-api-construct'
|
|
|
176
175
|
new AmplifyGraphqlApi(scope: Construct, id: string, props: AmplifyGraphqlApiProps)
|
|
177
176
|
```
|
|
178
177
|
|
|
179
|
-
| **Name**
|
|
180
|
-
|
|
|
181
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code>
|
|
182
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id">id</a></code>
|
|
178
|
+
| **Name** | **Type** | **Description** |
|
|
179
|
+
| --- | --- | --- |
|
|
180
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | the scope to create this construct within. |
|
|
181
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id">id</a></code> | <code>string</code> | the id to use for this api. |
|
|
183
182
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.props">props</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps">AmplifyGraphqlApiProps</a></code> | the properties used to configure the generated api. |
|
|
184
183
|
|
|
185
184
|
---
|
|
186
185
|
|
|
187
186
|
##### `scope`<sup>Required</sup> <a name="scope" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope"></a>
|
|
188
187
|
|
|
189
|
-
-
|
|
188
|
+
- *Type:* constructs.Construct
|
|
190
189
|
|
|
191
190
|
the scope to create this construct within.
|
|
192
191
|
|
|
@@ -194,7 +193,7 @@ the scope to create this construct within.
|
|
|
194
193
|
|
|
195
194
|
##### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id"></a>
|
|
196
195
|
|
|
197
|
-
-
|
|
196
|
+
- *Type:* string
|
|
198
197
|
|
|
199
198
|
the id to use for this api.
|
|
200
199
|
|
|
@@ -202,7 +201,7 @@ the id to use for this api.
|
|
|
202
201
|
|
|
203
202
|
##### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.props"></a>
|
|
204
203
|
|
|
205
|
-
-
|
|
204
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps">AmplifyGraphqlApiProps</a>
|
|
206
205
|
|
|
207
206
|
the properties used to configure the generated api.
|
|
208
207
|
|
|
@@ -210,19 +209,19 @@ the properties used to configure the generated api.
|
|
|
210
209
|
|
|
211
210
|
#### Methods <a name="Methods" id="Methods"></a>
|
|
212
211
|
|
|
213
|
-
| **Name**
|
|
214
|
-
|
|
|
215
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.toString">toString</a></code>
|
|
216
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource">addDynamoDbDataSource</a></code>
|
|
217
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource">addElasticsearchDataSource</a></code> | Add a new elasticsearch data source to this API.
|
|
218
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource">addEventBridgeDataSource</a></code>
|
|
219
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction">addFunction</a></code>
|
|
220
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource">addHttpDataSource</a></code>
|
|
221
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource">addLambdaDataSource</a></code>
|
|
222
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource">addNoneDataSource</a></code>
|
|
223
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource">addOpenSearchDataSource</a></code>
|
|
224
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource">addRdsDataSource</a></code>
|
|
225
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver">addResolver</a></code>
|
|
212
|
+
| **Name** | **Description** |
|
|
213
|
+
| --- | --- |
|
|
214
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
215
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource">addDynamoDbDataSource</a></code> | Add a new DynamoDB data source to this API. |
|
|
216
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource">addElasticsearchDataSource</a></code> | Add a new elasticsearch data source to this API. |
|
|
217
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource">addEventBridgeDataSource</a></code> | Add an EventBridge data source to this api. |
|
|
218
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction">addFunction</a></code> | Add an appsync function to the api. |
|
|
219
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource">addHttpDataSource</a></code> | Add a new http data source to this API. |
|
|
220
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource">addLambdaDataSource</a></code> | Add a new Lambda data source to this API. |
|
|
221
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource">addNoneDataSource</a></code> | Add a new dummy data source to this API. |
|
|
222
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource">addOpenSearchDataSource</a></code> | dd a new OpenSearch data source to this API. |
|
|
223
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource">addRdsDataSource</a></code> | Add a new Rds data source to this API. |
|
|
224
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver">addResolver</a></code> | Add a resolver to the api. |
|
|
226
225
|
|
|
227
226
|
---
|
|
228
227
|
|
|
@@ -246,7 +245,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
246
245
|
|
|
247
246
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.id"></a>
|
|
248
247
|
|
|
249
|
-
-
|
|
248
|
+
- *Type:* string
|
|
250
249
|
|
|
251
250
|
The data source's id.
|
|
252
251
|
|
|
@@ -254,7 +253,7 @@ The data source's id.
|
|
|
254
253
|
|
|
255
254
|
###### `table`<sup>Required</sup> <a name="table" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.table"></a>
|
|
256
255
|
|
|
257
|
-
-
|
|
256
|
+
- *Type:* aws-cdk-lib.aws_dynamodb.ITable
|
|
258
257
|
|
|
259
258
|
The DynamoDB table backing this data source.
|
|
260
259
|
|
|
@@ -262,7 +261,7 @@ The DynamoDB table backing this data source.
|
|
|
262
261
|
|
|
263
262
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.options"></a>
|
|
264
263
|
|
|
265
|
-
-
|
|
264
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
266
265
|
|
|
267
266
|
The optional configuration for this data source.
|
|
268
267
|
|
|
@@ -280,7 +279,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
280
279
|
|
|
281
280
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.id"></a>
|
|
282
281
|
|
|
283
|
-
-
|
|
282
|
+
- *Type:* string
|
|
284
283
|
|
|
285
284
|
The data source's id.
|
|
286
285
|
|
|
@@ -288,7 +287,7 @@ The data source's id.
|
|
|
288
287
|
|
|
289
288
|
###### `domain`<sup>Required</sup> <a name="domain" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.domain"></a>
|
|
290
289
|
|
|
291
|
-
-
|
|
290
|
+
- *Type:* aws-cdk-lib.aws_elasticsearch.IDomain
|
|
292
291
|
|
|
293
292
|
The elasticsearch domain for this data source.
|
|
294
293
|
|
|
@@ -296,7 +295,7 @@ The elasticsearch domain for this data source.
|
|
|
296
295
|
|
|
297
296
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.options"></a>
|
|
298
297
|
|
|
299
|
-
-
|
|
298
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
300
299
|
|
|
301
300
|
The optional configuration for this data source.
|
|
302
301
|
|
|
@@ -314,7 +313,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
314
313
|
|
|
315
314
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.id"></a>
|
|
316
315
|
|
|
317
|
-
-
|
|
316
|
+
- *Type:* string
|
|
318
317
|
|
|
319
318
|
The data source's id.
|
|
320
319
|
|
|
@@ -322,7 +321,7 @@ The data source's id.
|
|
|
322
321
|
|
|
323
322
|
###### `eventBus`<sup>Required</sup> <a name="eventBus" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.eventBus"></a>
|
|
324
323
|
|
|
325
|
-
-
|
|
324
|
+
- *Type:* aws-cdk-lib.aws_events.IEventBus
|
|
326
325
|
|
|
327
326
|
The EventBridge EventBus on which to put events.
|
|
328
327
|
|
|
@@ -330,7 +329,7 @@ The EventBridge EventBus on which to put events.
|
|
|
330
329
|
|
|
331
330
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.options"></a>
|
|
332
331
|
|
|
333
|
-
-
|
|
332
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
334
333
|
|
|
335
334
|
The optional configuration for this data source.
|
|
336
335
|
|
|
@@ -346,7 +345,7 @@ Add an appsync function to the api.
|
|
|
346
345
|
|
|
347
346
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction.parameter.id"></a>
|
|
348
347
|
|
|
349
|
-
-
|
|
348
|
+
- *Type:* string
|
|
350
349
|
|
|
351
350
|
the function's id.
|
|
352
351
|
|
|
@@ -354,7 +353,7 @@ the function's id.
|
|
|
354
353
|
|
|
355
354
|
###### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction.parameter.props"></a>
|
|
356
355
|
|
|
357
|
-
-
|
|
356
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AddFunctionProps">AddFunctionProps</a>
|
|
358
357
|
|
|
359
358
|
---
|
|
360
359
|
|
|
@@ -370,7 +369,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
370
369
|
|
|
371
370
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.id"></a>
|
|
372
371
|
|
|
373
|
-
-
|
|
372
|
+
- *Type:* string
|
|
374
373
|
|
|
375
374
|
The data source's id.
|
|
376
375
|
|
|
@@ -378,7 +377,7 @@ The data source's id.
|
|
|
378
377
|
|
|
379
378
|
###### `endpoint`<sup>Required</sup> <a name="endpoint" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.endpoint"></a>
|
|
380
379
|
|
|
381
|
-
-
|
|
380
|
+
- *Type:* string
|
|
382
381
|
|
|
383
382
|
The http endpoint.
|
|
384
383
|
|
|
@@ -386,7 +385,7 @@ The http endpoint.
|
|
|
386
385
|
|
|
387
386
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.options"></a>
|
|
388
387
|
|
|
389
|
-
-
|
|
388
|
+
- *Type:* aws-cdk-lib.aws_appsync.HttpDataSourceOptions
|
|
390
389
|
|
|
391
390
|
The optional configuration for this data source.
|
|
392
391
|
|
|
@@ -404,7 +403,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
404
403
|
|
|
405
404
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.id"></a>
|
|
406
405
|
|
|
407
|
-
-
|
|
406
|
+
- *Type:* string
|
|
408
407
|
|
|
409
408
|
The data source's id.
|
|
410
409
|
|
|
@@ -412,7 +411,7 @@ The data source's id.
|
|
|
412
411
|
|
|
413
412
|
###### `lambdaFunction`<sup>Required</sup> <a name="lambdaFunction" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.lambdaFunction"></a>
|
|
414
413
|
|
|
415
|
-
-
|
|
414
|
+
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
416
415
|
|
|
417
416
|
The Lambda function to call to interact with this data source.
|
|
418
417
|
|
|
@@ -420,7 +419,7 @@ The Lambda function to call to interact with this data source.
|
|
|
420
419
|
|
|
421
420
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.options"></a>
|
|
422
421
|
|
|
423
|
-
-
|
|
422
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
424
423
|
|
|
425
424
|
The optional configuration for this data source.
|
|
426
425
|
|
|
@@ -439,7 +438,7 @@ Useful for pipeline resolvers and for backend changes that don't require a data
|
|
|
439
438
|
|
|
440
439
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource.parameter.id"></a>
|
|
441
440
|
|
|
442
|
-
-
|
|
441
|
+
- *Type:* string
|
|
443
442
|
|
|
444
443
|
The data source's id.
|
|
445
444
|
|
|
@@ -447,7 +446,7 @@ The data source's id.
|
|
|
447
446
|
|
|
448
447
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource.parameter.options"></a>
|
|
449
448
|
|
|
450
|
-
-
|
|
449
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
451
450
|
|
|
452
451
|
The optional configuration for this data source.
|
|
453
452
|
|
|
@@ -465,7 +464,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
465
464
|
|
|
466
465
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.id"></a>
|
|
467
466
|
|
|
468
|
-
-
|
|
467
|
+
- *Type:* string
|
|
469
468
|
|
|
470
469
|
The data source's id.
|
|
471
470
|
|
|
@@ -473,7 +472,7 @@ The data source's id.
|
|
|
473
472
|
|
|
474
473
|
###### `domain`<sup>Required</sup> <a name="domain" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.domain"></a>
|
|
475
474
|
|
|
476
|
-
-
|
|
475
|
+
- *Type:* aws-cdk-lib.aws_opensearchservice.IDomain
|
|
477
476
|
|
|
478
477
|
The OpenSearch domain for this data source.
|
|
479
478
|
|
|
@@ -481,7 +480,7 @@ The OpenSearch domain for this data source.
|
|
|
481
480
|
|
|
482
481
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.options"></a>
|
|
483
482
|
|
|
484
|
-
-
|
|
483
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
485
484
|
|
|
486
485
|
The optional configuration for this data source.
|
|
487
486
|
|
|
@@ -499,7 +498,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
499
498
|
|
|
500
499
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.id"></a>
|
|
501
500
|
|
|
502
|
-
-
|
|
501
|
+
- *Type:* string
|
|
503
502
|
|
|
504
503
|
The data source's id.
|
|
505
504
|
|
|
@@ -507,7 +506,7 @@ The data source's id.
|
|
|
507
506
|
|
|
508
507
|
###### `serverlessCluster`<sup>Required</sup> <a name="serverlessCluster" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.serverlessCluster"></a>
|
|
509
508
|
|
|
510
|
-
-
|
|
509
|
+
- *Type:* aws-cdk-lib.aws_rds.IServerlessCluster
|
|
511
510
|
|
|
512
511
|
The serverless cluster to interact with this data source.
|
|
513
512
|
|
|
@@ -515,7 +514,7 @@ The serverless cluster to interact with this data source.
|
|
|
515
514
|
|
|
516
515
|
###### `secretStore`<sup>Required</sup> <a name="secretStore" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.secretStore"></a>
|
|
517
516
|
|
|
518
|
-
-
|
|
517
|
+
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
|
|
519
518
|
|
|
520
519
|
The secret store that contains the username and password for the serverless cluster.
|
|
521
520
|
|
|
@@ -523,7 +522,7 @@ The secret store that contains the username and password for the serverless clus
|
|
|
523
522
|
|
|
524
523
|
###### `databaseName`<sup>Optional</sup> <a name="databaseName" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.databaseName"></a>
|
|
525
524
|
|
|
526
|
-
-
|
|
525
|
+
- *Type:* string
|
|
527
526
|
|
|
528
527
|
The optional name of the database to use within the cluster.
|
|
529
528
|
|
|
@@ -531,7 +530,7 @@ The optional name of the database to use within the cluster.
|
|
|
531
530
|
|
|
532
531
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.options"></a>
|
|
533
532
|
|
|
534
|
-
-
|
|
533
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
535
534
|
|
|
536
535
|
The optional configuration for this data source.
|
|
537
536
|
|
|
@@ -549,7 +548,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
549
548
|
|
|
550
549
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver.parameter.id"></a>
|
|
551
550
|
|
|
552
|
-
-
|
|
551
|
+
- *Type:* string
|
|
553
552
|
|
|
554
553
|
The resolver's id.
|
|
555
554
|
|
|
@@ -557,7 +556,7 @@ The resolver's id.
|
|
|
557
556
|
|
|
558
557
|
###### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver.parameter.props"></a>
|
|
559
558
|
|
|
560
|
-
-
|
|
559
|
+
- *Type:* aws-cdk-lib.aws_appsync.ExtendedResolverProps
|
|
561
560
|
|
|
562
561
|
the resolver properties.
|
|
563
562
|
|
|
@@ -565,8 +564,8 @@ the resolver properties.
|
|
|
565
564
|
|
|
566
565
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
567
566
|
|
|
568
|
-
| **Name**
|
|
569
|
-
|
|
|
567
|
+
| **Name** | **Description** |
|
|
568
|
+
| --- | --- |
|
|
570
569
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
571
570
|
|
|
572
571
|
---
|
|
@@ -583,7 +582,7 @@ Checks if `x` is a construct.
|
|
|
583
582
|
|
|
584
583
|
###### `x`<sup>Required</sup> <a name="x" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.isConstruct.parameter.x"></a>
|
|
585
584
|
|
|
586
|
-
-
|
|
585
|
+
- *Type:* any
|
|
587
586
|
|
|
588
587
|
Any object.
|
|
589
588
|
|
|
@@ -596,10 +595,10 @@ Any object.
|
|
|
596
595
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
597
596
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiId">apiId</a></code> | <code>string</code> | Generated Api Id. |
|
|
598
597
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.generatedFunctionSlots">generatedFunctionSlots</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> | Resolvers generated by the transform process, persisted on the side in order to facilitate pulling a manifest for the purposes of inspecting and producing overrides. |
|
|
599
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.graphqlUrl">graphqlUrl</a></code>
|
|
600
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.realtimeUrl">realtimeUrl</a></code>
|
|
601
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.resources">resources</a></code>
|
|
602
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiKey">apiKey</a></code>
|
|
598
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.graphqlUrl">graphqlUrl</a></code> | <code>string</code> | Graphql URL For the generated API. |
|
|
599
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.realtimeUrl">realtimeUrl</a></code> | <code>string</code> | Realtime URL For the generated API. |
|
|
600
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.resources">resources</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources">AmplifyGraphqlApiResources</a></code> | Generated L1 and L2 CDK resources. |
|
|
601
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiKey">apiKey</a></code> | <code>string</code> | Generated Api Key if generated. |
|
|
603
602
|
|
|
604
603
|
---
|
|
605
604
|
|
|
@@ -609,7 +608,7 @@ Any object.
|
|
|
609
608
|
public readonly node: Node;
|
|
610
609
|
```
|
|
611
610
|
|
|
612
|
-
-
|
|
611
|
+
- *Type:* constructs.Node
|
|
613
612
|
|
|
614
613
|
The tree node.
|
|
615
614
|
|
|
@@ -635,7 +634,7 @@ May be a CDK Token.
|
|
|
635
634
|
public readonly generatedFunctionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
|
636
635
|
```
|
|
637
636
|
|
|
638
|
-
-
|
|
637
|
+
- *Type:* <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>[]
|
|
639
638
|
|
|
640
639
|
Resolvers generated by the transform process, persisted on the side in order to facilitate pulling a manifest for the purposes of inspecting and producing overrides.
|
|
641
640
|
|
|
@@ -647,7 +646,7 @@ Resolvers generated by the transform process, persisted on the side in order to
|
|
|
647
646
|
public readonly graphqlUrl: string;
|
|
648
647
|
```
|
|
649
648
|
|
|
650
|
-
-
|
|
649
|
+
- *Type:* string
|
|
651
650
|
|
|
652
651
|
Graphql URL For the generated API.
|
|
653
652
|
|
|
@@ -661,7 +660,7 @@ May be a CDK Token.
|
|
|
661
660
|
public readonly realtimeUrl: string;
|
|
662
661
|
```
|
|
663
662
|
|
|
664
|
-
-
|
|
663
|
+
- *Type:* string
|
|
665
664
|
|
|
666
665
|
Realtime URL For the generated API.
|
|
667
666
|
|
|
@@ -675,7 +674,7 @@ May be a CDK Token.
|
|
|
675
674
|
public readonly resources: AmplifyGraphqlApiResources;
|
|
676
675
|
```
|
|
677
676
|
|
|
678
|
-
-
|
|
677
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources">AmplifyGraphqlApiResources</a>
|
|
679
678
|
|
|
680
679
|
Generated L1 and L2 CDK resources.
|
|
681
680
|
|
|
@@ -687,7 +686,7 @@ Generated L1 and L2 CDK resources.
|
|
|
687
686
|
public readonly apiKey: string;
|
|
688
687
|
```
|
|
689
688
|
|
|
690
|
-
-
|
|
689
|
+
- *Type:* string
|
|
691
690
|
|
|
692
691
|
Generated Api Key if generated.
|
|
693
692
|
|
|
@@ -695,6 +694,7 @@ May be a CDK Token.
|
|
|
695
694
|
|
|
696
695
|
---
|
|
697
696
|
|
|
697
|
+
|
|
698
698
|
## Structs <a name="Structs" id="Structs"></a>
|
|
699
699
|
|
|
700
700
|
### AddFunctionProps <a name="AddFunctionProps" id="@aws-amplify/graphql-api-construct.AddFunctionProps"></a>
|
|
@@ -711,15 +711,15 @@ const addFunctionProps: AddFunctionProps = { ... }
|
|
|
711
711
|
|
|
712
712
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
713
713
|
|
|
714
|
-
| **Name**
|
|
715
|
-
|
|
|
716
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.dataSource">dataSource</a></code>
|
|
717
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.name">name</a></code>
|
|
718
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.code">code</a></code>
|
|
719
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.description">description</a></code>
|
|
720
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.requestMappingTemplate">requestMappingTemplate</a></code>
|
|
714
|
+
| **Name** | **Type** | **Description** |
|
|
715
|
+
| --- | --- | --- |
|
|
716
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.dataSource">dataSource</a></code> | <code>aws-cdk-lib.aws_appsync.BaseDataSource</code> | the data source linked to this AppSync Function. |
|
|
717
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.name">name</a></code> | <code>string</code> | the name of the AppSync Function. |
|
|
718
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.code">code</a></code> | <code>aws-cdk-lib.aws_appsync.Code</code> | The function code. |
|
|
719
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.description">description</a></code> | <code>string</code> | the description for this AppSync Function. |
|
|
720
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.requestMappingTemplate">requestMappingTemplate</a></code> | <code>aws-cdk-lib.aws_appsync.MappingTemplate</code> | the request mapping template for the AppSync Function. |
|
|
721
721
|
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.responseMappingTemplate">responseMappingTemplate</a></code> | <code>aws-cdk-lib.aws_appsync.MappingTemplate</code> | the response mapping template for the AppSync Function. |
|
|
722
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.runtime">runtime</a></code>
|
|
722
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.runtime">runtime</a></code> | <code>aws-cdk-lib.aws_appsync.FunctionRuntime</code> | The functions runtime. |
|
|
723
723
|
|
|
724
724
|
---
|
|
725
725
|
|
|
@@ -729,7 +729,7 @@ const addFunctionProps: AddFunctionProps = { ... }
|
|
|
729
729
|
public readonly dataSource: BaseDataSource;
|
|
730
730
|
```
|
|
731
731
|
|
|
732
|
-
-
|
|
732
|
+
- *Type:* aws-cdk-lib.aws_appsync.BaseDataSource
|
|
733
733
|
|
|
734
734
|
the data source linked to this AppSync Function.
|
|
735
735
|
|
|
@@ -741,7 +741,7 @@ the data source linked to this AppSync Function.
|
|
|
741
741
|
public readonly name: string;
|
|
742
742
|
```
|
|
743
743
|
|
|
744
|
-
-
|
|
744
|
+
- *Type:* string
|
|
745
745
|
|
|
746
746
|
the name of the AppSync Function.
|
|
747
747
|
|
|
@@ -753,8 +753,8 @@ the name of the AppSync Function.
|
|
|
753
753
|
public readonly code: Code;
|
|
754
754
|
```
|
|
755
755
|
|
|
756
|
-
-
|
|
757
|
-
-
|
|
756
|
+
- *Type:* aws-cdk-lib.aws_appsync.Code
|
|
757
|
+
- *Default:* no code is used
|
|
758
758
|
|
|
759
759
|
The function code.
|
|
760
760
|
|
|
@@ -766,8 +766,8 @@ The function code.
|
|
|
766
766
|
public readonly description: string;
|
|
767
767
|
```
|
|
768
768
|
|
|
769
|
-
-
|
|
770
|
-
-
|
|
769
|
+
- *Type:* string
|
|
770
|
+
- *Default:* no description
|
|
771
771
|
|
|
772
772
|
the description for this AppSync Function.
|
|
773
773
|
|
|
@@ -779,8 +779,8 @@ the description for this AppSync Function.
|
|
|
779
779
|
public readonly requestMappingTemplate: MappingTemplate;
|
|
780
780
|
```
|
|
781
781
|
|
|
782
|
-
-
|
|
783
|
-
-
|
|
782
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
783
|
+
- *Default:* no request mapping template
|
|
784
784
|
|
|
785
785
|
the request mapping template for the AppSync Function.
|
|
786
786
|
|
|
@@ -792,8 +792,8 @@ the request mapping template for the AppSync Function.
|
|
|
792
792
|
public readonly responseMappingTemplate: MappingTemplate;
|
|
793
793
|
```
|
|
794
794
|
|
|
795
|
-
-
|
|
796
|
-
-
|
|
795
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
796
|
+
- *Default:* no response mapping template
|
|
797
797
|
|
|
798
798
|
the response mapping template for the AppSync Function.
|
|
799
799
|
|
|
@@ -805,13 +805,54 @@ the response mapping template for the AppSync Function.
|
|
|
805
805
|
public readonly runtime: FunctionRuntime;
|
|
806
806
|
```
|
|
807
807
|
|
|
808
|
-
-
|
|
809
|
-
-
|
|
808
|
+
- *Type:* aws-cdk-lib.aws_appsync.FunctionRuntime
|
|
809
|
+
- *Default:* no function runtime, VTL mapping templates used
|
|
810
810
|
|
|
811
811
|
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.
|
|
@@ -828,18 +869,18 @@ const amplifyGraphqlApiCfnResources: AmplifyGraphqlApiCfnResources = { ... }
|
|
|
828
869
|
|
|
829
870
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
830
871
|
|
|
831
|
-
| **Name**
|
|
832
|
-
|
|
|
833
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.additionalCfnResources">additionalCfnResources</a></code>
|
|
834
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnDataSources">cfnDataSources</a></code>
|
|
835
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnFunctionConfigurations">cfnFunctionConfigurations</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_appsync.CfnFunctionConfiguration}</code> | The Generated AppSync Function L1 Resources, keyed by logicalId.
|
|
836
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnFunctions">cfnFunctions</a></code>
|
|
837
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnGraphqlApi">cfnGraphqlApi</a></code>
|
|
838
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnGraphqlSchema">cfnGraphqlSchema</a></code>
|
|
839
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnResolvers">cfnResolvers</a></code>
|
|
840
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnRoles">cfnRoles</a></code>
|
|
841
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnTables">cfnTables</a></code>
|
|
842
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnApiKey">cfnApiKey</a></code>
|
|
872
|
+
| **Name** | **Type** | **Description** |
|
|
873
|
+
| --- | --- | --- |
|
|
874
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.additionalCfnResources">additionalCfnResources</a></code> | <code>{[ key: string ]: aws-cdk-lib.CfnResource}</code> | Remaining L1 resources generated, keyed by logicalId. |
|
|
875
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnDataSources">cfnDataSources</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_appsync.CfnDataSource}</code> | The Generated AppSync DataSource L1 Resources, keyed by logicalId. |
|
|
876
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnFunctionConfigurations">cfnFunctionConfigurations</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_appsync.CfnFunctionConfiguration}</code> | The Generated AppSync Function L1 Resources, keyed by logicalId. |
|
|
877
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnFunctions">cfnFunctions</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_lambda.CfnFunction}</code> | The Generated Lambda Function L1 Resources, keyed by function name. |
|
|
878
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnGraphqlApi">cfnGraphqlApi</a></code> | <code>aws-cdk-lib.aws_appsync.CfnGraphQLApi</code> | The Generated AppSync Api L1 Resource. |
|
|
879
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnGraphqlSchema">cfnGraphqlSchema</a></code> | <code>aws-cdk-lib.aws_appsync.CfnGraphQLSchema</code> | The Generated AppSync Schema L1 Resource. |
|
|
880
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnResolvers">cfnResolvers</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_appsync.CfnResolver}</code> | The Generated AppSync Resolver L1 Resources, keyed by logicalId. |
|
|
881
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnRoles">cfnRoles</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_iam.CfnRole}</code> | The Generated IAM Role L1 Resources, keyed by logicalId. |
|
|
882
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnTables">cfnTables</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_dynamodb.CfnTable}</code> | The Generated DynamoDB Table L1 Resources, keyed by logicalId. |
|
|
883
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources.property.cfnApiKey">cfnApiKey</a></code> | <code>aws-cdk-lib.aws_appsync.CfnApiKey</code> | The Generated AppSync Api Key L1 Resource. |
|
|
843
884
|
|
|
844
885
|
---
|
|
845
886
|
|
|
@@ -849,7 +890,7 @@ const amplifyGraphqlApiCfnResources: AmplifyGraphqlApiCfnResources = { ... }
|
|
|
849
890
|
public readonly additionalCfnResources: {[ key: string ]: CfnResource};
|
|
850
891
|
```
|
|
851
892
|
|
|
852
|
-
-
|
|
893
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.CfnResource}
|
|
853
894
|
|
|
854
895
|
Remaining L1 resources generated, keyed by logicalId.
|
|
855
896
|
|
|
@@ -861,7 +902,7 @@ Remaining L1 resources generated, keyed by logicalId.
|
|
|
861
902
|
public readonly cfnDataSources: {[ key: string ]: CfnDataSource};
|
|
862
903
|
```
|
|
863
904
|
|
|
864
|
-
-
|
|
905
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_appsync.CfnDataSource}
|
|
865
906
|
|
|
866
907
|
The Generated AppSync DataSource L1 Resources, keyed by logicalId.
|
|
867
908
|
|
|
@@ -873,7 +914,7 @@ The Generated AppSync DataSource L1 Resources, keyed by logicalId.
|
|
|
873
914
|
public readonly cfnFunctionConfigurations: {[ key: string ]: CfnFunctionConfiguration};
|
|
874
915
|
```
|
|
875
916
|
|
|
876
|
-
-
|
|
917
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_appsync.CfnFunctionConfiguration}
|
|
877
918
|
|
|
878
919
|
The Generated AppSync Function L1 Resources, keyed by logicalId.
|
|
879
920
|
|
|
@@ -885,7 +926,7 @@ The Generated AppSync Function L1 Resources, keyed by logicalId.
|
|
|
885
926
|
public readonly cfnFunctions: {[ key: string ]: CfnFunction};
|
|
886
927
|
```
|
|
887
928
|
|
|
888
|
-
-
|
|
929
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_lambda.CfnFunction}
|
|
889
930
|
|
|
890
931
|
The Generated Lambda Function L1 Resources, keyed by function name.
|
|
891
932
|
|
|
@@ -897,7 +938,7 @@ The Generated Lambda Function L1 Resources, keyed by function name.
|
|
|
897
938
|
public readonly cfnGraphqlApi: CfnGraphQLApi;
|
|
898
939
|
```
|
|
899
940
|
|
|
900
|
-
-
|
|
941
|
+
- *Type:* aws-cdk-lib.aws_appsync.CfnGraphQLApi
|
|
901
942
|
|
|
902
943
|
The Generated AppSync Api L1 Resource.
|
|
903
944
|
|
|
@@ -909,7 +950,7 @@ The Generated AppSync Api L1 Resource.
|
|
|
909
950
|
public readonly cfnGraphqlSchema: CfnGraphQLSchema;
|
|
910
951
|
```
|
|
911
952
|
|
|
912
|
-
-
|
|
953
|
+
- *Type:* aws-cdk-lib.aws_appsync.CfnGraphQLSchema
|
|
913
954
|
|
|
914
955
|
The Generated AppSync Schema L1 Resource.
|
|
915
956
|
|
|
@@ -921,7 +962,7 @@ The Generated AppSync Schema L1 Resource.
|
|
|
921
962
|
public readonly cfnResolvers: {[ key: string ]: CfnResolver};
|
|
922
963
|
```
|
|
923
964
|
|
|
924
|
-
-
|
|
965
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_appsync.CfnResolver}
|
|
925
966
|
|
|
926
967
|
The Generated AppSync Resolver L1 Resources, keyed by logicalId.
|
|
927
968
|
|
|
@@ -933,7 +974,7 @@ The Generated AppSync Resolver L1 Resources, keyed by logicalId.
|
|
|
933
974
|
public readonly cfnRoles: {[ key: string ]: CfnRole};
|
|
934
975
|
```
|
|
935
976
|
|
|
936
|
-
-
|
|
977
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_iam.CfnRole}
|
|
937
978
|
|
|
938
979
|
The Generated IAM Role L1 Resources, keyed by logicalId.
|
|
939
980
|
|
|
@@ -945,7 +986,7 @@ The Generated IAM Role L1 Resources, keyed by logicalId.
|
|
|
945
986
|
public readonly cfnTables: {[ key: string ]: CfnTable};
|
|
946
987
|
```
|
|
947
988
|
|
|
948
|
-
-
|
|
989
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_dynamodb.CfnTable}
|
|
949
990
|
|
|
950
991
|
The Generated DynamoDB Table L1 Resources, keyed by logicalId.
|
|
951
992
|
|
|
@@ -957,7 +998,7 @@ The Generated DynamoDB Table L1 Resources, keyed by logicalId.
|
|
|
957
998
|
public readonly cfnApiKey: CfnApiKey;
|
|
958
999
|
```
|
|
959
1000
|
|
|
960
|
-
-
|
|
1001
|
+
- *Type:* aws-cdk-lib.aws_appsync.CfnApiKey
|
|
961
1002
|
|
|
962
1003
|
The Generated AppSync Api Key L1 Resource.
|
|
963
1004
|
|
|
@@ -980,19 +1021,19 @@ const amplifyGraphqlApiProps: AmplifyGraphqlApiProps = { ... }
|
|
|
980
1021
|
|
|
981
1022
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
982
1023
|
|
|
983
|
-
| **Name**
|
|
984
|
-
|
|
|
985
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.authorizationModes">authorizationModes</a></code>
|
|
986
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.definition">definition</a></code>
|
|
987
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.apiName">apiName</a></code>
|
|
988
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.conflictResolution">conflictResolution</a></code>
|
|
989
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.functionNameMap">functionNameMap</a></code>
|
|
990
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.functionSlots">functionSlots</a></code>
|
|
991
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.outputStorageStrategy">outputStorageStrategy</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a></code>
|
|
992
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.predictionsBucket">predictionsBucket</a></code>
|
|
993
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.stackMappings">stackMappings</a></code>
|
|
994
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.transformerPlugins">transformerPlugins</a></code>
|
|
995
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.translationBehavior">translationBehavior</a></code>
|
|
1024
|
+
| **Name** | **Type** | **Description** |
|
|
1025
|
+
| --- | --- | --- |
|
|
1026
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.authorizationModes">authorizationModes</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes">AuthorizationModes</a></code> | Required auth modes for the Api. |
|
|
1027
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.definition">definition</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a></code> | The definition to transform in a full Api. |
|
|
1028
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.apiName">apiName</a></code> | <code>string</code> | Name to be used for the AppSync Api. |
|
|
1029
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.conflictResolution">conflictResolution</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.ConflictResolution">ConflictResolution</a></code> | Configure conflict resolution on the Api, which is required to enable DataStore Api functionality. |
|
|
1030
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.functionNameMap">functionNameMap</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}</code> | Lambda functions referenced in the definitions's. |
|
|
1031
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.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> | Overrides for a given slot in the generated resolver pipelines. |
|
|
1032
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.outputStorageStrategy">outputStorageStrategy</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a></code> | Strategy to store construct outputs. |
|
|
1033
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.predictionsBucket">predictionsBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | If using predictions, a bucket must be provided which will be used to search for assets. |
|
|
1034
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.stackMappings">stackMappings</a></code> | <code>{[ key: string ]: string}</code> | StackMappings override the assigned nested stack on a per-resource basis. |
|
|
1035
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.transformerPlugins">transformerPlugins</a></code> | <code>any[]</code> | Provide a list of additional custom transformers which are injected into the transform process. |
|
|
1036
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps.property.translationBehavior">translationBehavior</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior">PartialTranslationBehavior</a></code> | This replaces feature flags from the Api construct, for general information on what these parameters do, refer to https://docs.amplify.aws/cli/reference/feature-flags/#graphQLTransformer. |
|
|
996
1037
|
|
|
997
1038
|
---
|
|
998
1039
|
|
|
@@ -1002,7 +1043,7 @@ const amplifyGraphqlApiProps: AmplifyGraphqlApiProps = { ... }
|
|
|
1002
1043
|
public readonly authorizationModes: AuthorizationModes;
|
|
1003
1044
|
```
|
|
1004
1045
|
|
|
1005
|
-
-
|
|
1046
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AuthorizationModes">AuthorizationModes</a>
|
|
1006
1047
|
|
|
1007
1048
|
Required auth modes for the Api.
|
|
1008
1049
|
|
|
@@ -1017,7 +1058,7 @@ For more information, refer to https://docs.amplify.aws/cli/graphql/authorizatio
|
|
|
1017
1058
|
public readonly definition: IAmplifyGraphqlDefinition;
|
|
1018
1059
|
```
|
|
1019
1060
|
|
|
1020
|
-
-
|
|
1061
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>
|
|
1021
1062
|
|
|
1022
1063
|
The definition to transform in a full Api.
|
|
1023
1064
|
|
|
@@ -1031,7 +1072,7 @@ Can be constructed via the AmplifyGraphqlDefinition class.
|
|
|
1031
1072
|
public readonly apiName: string;
|
|
1032
1073
|
```
|
|
1033
1074
|
|
|
1034
|
-
-
|
|
1075
|
+
- *Type:* string
|
|
1035
1076
|
|
|
1036
1077
|
Name to be used for the AppSync Api.
|
|
1037
1078
|
|
|
@@ -1045,7 +1086,7 @@ Default: construct id.
|
|
|
1045
1086
|
public readonly conflictResolution: ConflictResolution;
|
|
1046
1087
|
```
|
|
1047
1088
|
|
|
1048
|
-
-
|
|
1089
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ConflictResolution">ConflictResolution</a>
|
|
1049
1090
|
|
|
1050
1091
|
Configure conflict resolution on the Api, which is required to enable DataStore Api functionality.
|
|
1051
1092
|
|
|
@@ -1059,7 +1100,7 @@ For more information, refer to https://docs.amplify.aws/lib/datastore/getting-st
|
|
|
1059
1100
|
public readonly functionNameMap: {[ key: string ]: IFunction};
|
|
1060
1101
|
```
|
|
1061
1102
|
|
|
1062
|
-
-
|
|
1103
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}
|
|
1063
1104
|
|
|
1064
1105
|
Lambda functions referenced in the definitions's.
|
|
1065
1106
|
|
|
@@ -1071,7 +1112,7 @@ Lambda functions referenced in the definitions's.
|
|
|
1071
1112
|
public readonly functionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
|
1072
1113
|
```
|
|
1073
1114
|
|
|
1074
|
-
-
|
|
1115
|
+
- *Type:* <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>[]
|
|
1075
1116
|
|
|
1076
1117
|
Overrides for a given slot in the generated resolver pipelines.
|
|
1077
1118
|
|
|
@@ -1086,7 +1127,7 @@ refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#override-am
|
|
|
1086
1127
|
public readonly outputStorageStrategy: IBackendOutputStorageStrategy;
|
|
1087
1128
|
```
|
|
1088
1129
|
|
|
1089
|
-
-
|
|
1130
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a>
|
|
1090
1131
|
|
|
1091
1132
|
Strategy to store construct outputs.
|
|
1092
1133
|
|
|
@@ -1100,7 +1141,7 @@ If no outputStorageStrategey is provided a default strategy will be used.
|
|
|
1100
1141
|
public readonly predictionsBucket: IBucket;
|
|
1101
1142
|
```
|
|
1102
1143
|
|
|
1103
|
-
-
|
|
1144
|
+
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
1104
1145
|
|
|
1105
1146
|
If using predictions, a bucket must be provided which will be used to search for assets.
|
|
1106
1147
|
|
|
@@ -1112,7 +1153,7 @@ If using predictions, a bucket must be provided which will be used to search for
|
|
|
1112
1153
|
public readonly stackMappings: {[ key: string ]: string};
|
|
1113
1154
|
```
|
|
1114
1155
|
|
|
1115
|
-
-
|
|
1156
|
+
- *Type:* {[ key: string ]: string}
|
|
1116
1157
|
|
|
1117
1158
|
StackMappings override the assigned nested stack on a per-resource basis.
|
|
1118
1159
|
|
|
@@ -1130,7 +1171,7 @@ then re-added from a new stack.
|
|
|
1130
1171
|
public readonly transformerPlugins: any[];
|
|
1131
1172
|
```
|
|
1132
1173
|
|
|
1133
|
-
-
|
|
1174
|
+
- *Type:* any[]
|
|
1134
1175
|
|
|
1135
1176
|
Provide a list of additional custom transformers which are injected into the transform process.
|
|
1136
1177
|
|
|
@@ -1144,7 +1185,7 @@ These custom transformers must be implemented with aws-cdk-lib >=2.80.0, and
|
|
|
1144
1185
|
public readonly translationBehavior: PartialTranslationBehavior;
|
|
1145
1186
|
```
|
|
1146
1187
|
|
|
1147
|
-
-
|
|
1188
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior">PartialTranslationBehavior</a>
|
|
1148
1189
|
|
|
1149
1190
|
This replaces feature flags from the Api construct, for general information on what these parameters do, refer to https://docs.amplify.aws/cli/reference/feature-flags/#graphQLTransformer.
|
|
1150
1191
|
|
|
@@ -1166,14 +1207,27 @@ const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }
|
|
|
1166
1207
|
|
|
1167
1208
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1168
1209
|
|
|
1169
|
-
| **Name**
|
|
1170
|
-
|
|
|
1210
|
+
| **Name** | **Type** | **Description** |
|
|
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
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.functions">functions</a></code>
|
|
1173
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.graphqlApi">graphqlApi</a></code>
|
|
1174
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.nestedStacks">nestedStacks</a></code> | <code>{[ key: string ]: aws-cdk-lib.NestedStack}</code>
|
|
1175
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.roles">roles</a></code>
|
|
1176
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.tables">tables</a></code>
|
|
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. |
|
|
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. |
|
|
1216
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.nestedStacks">nestedStacks</a></code> | <code>{[ key: string ]: aws-cdk-lib.NestedStack}</code> | Nested Stacks generated by the Api Construct. |
|
|
1217
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.roles">roles</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_iam.IRole}</code> | The Generated IAM Role L2 Resources, keyed by logicalId. |
|
|
1218
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.tables">tables</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_dynamodb.ITable}</code> | The Generated DynamoDB Table L2 Resources, keyed by logicalId. |
|
|
1219
|
+
|
|
1220
|
+
---
|
|
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.
|
|
1177
1231
|
|
|
1178
1232
|
---
|
|
1179
1233
|
|
|
@@ -1183,7 +1237,7 @@ const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }
|
|
|
1183
1237
|
public readonly cfnResources: AmplifyGraphqlApiCfnResources;
|
|
1184
1238
|
```
|
|
1185
1239
|
|
|
1186
|
-
-
|
|
1240
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources">AmplifyGraphqlApiCfnResources</a>
|
|
1187
1241
|
|
|
1188
1242
|
L1 Cfn Resources, for when dipping down a level of abstraction is desirable.
|
|
1189
1243
|
|
|
@@ -1195,7 +1249,7 @@ L1 Cfn Resources, for when dipping down a level of abstraction is desirable.
|
|
|
1195
1249
|
public readonly functions: {[ key: string ]: IFunction};
|
|
1196
1250
|
```
|
|
1197
1251
|
|
|
1198
|
-
-
|
|
1252
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}
|
|
1199
1253
|
|
|
1200
1254
|
The Generated Lambda Function L1 Resources, keyed by function name.
|
|
1201
1255
|
|
|
@@ -1207,7 +1261,7 @@ The Generated Lambda Function L1 Resources, keyed by function name.
|
|
|
1207
1261
|
public readonly graphqlApi: IGraphqlApi;
|
|
1208
1262
|
```
|
|
1209
1263
|
|
|
1210
|
-
-
|
|
1264
|
+
- *Type:* aws-cdk-lib.aws_appsync.IGraphqlApi
|
|
1211
1265
|
|
|
1212
1266
|
The Generated AppSync Api L2 Resource, includes the Schema.
|
|
1213
1267
|
|
|
@@ -1219,7 +1273,7 @@ The Generated AppSync Api L2 Resource, includes the Schema.
|
|
|
1219
1273
|
public readonly nestedStacks: {[ key: string ]: NestedStack};
|
|
1220
1274
|
```
|
|
1221
1275
|
|
|
1222
|
-
-
|
|
1276
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.NestedStack}
|
|
1223
1277
|
|
|
1224
1278
|
Nested Stacks generated by the Api Construct.
|
|
1225
1279
|
|
|
@@ -1231,7 +1285,7 @@ Nested Stacks generated by the Api Construct.
|
|
|
1231
1285
|
public readonly roles: {[ key: string ]: IRole};
|
|
1232
1286
|
```
|
|
1233
1287
|
|
|
1234
|
-
-
|
|
1288
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_iam.IRole}
|
|
1235
1289
|
|
|
1236
1290
|
The Generated IAM Role L2 Resources, keyed by logicalId.
|
|
1237
1291
|
|
|
@@ -1243,7 +1297,7 @@ The Generated IAM Role L2 Resources, keyed by logicalId.
|
|
|
1243
1297
|
public readonly tables: {[ key: string ]: ITable};
|
|
1244
1298
|
```
|
|
1245
1299
|
|
|
1246
|
-
-
|
|
1300
|
+
- *Type:* {[ key: string ]: aws-cdk-lib.aws_dynamodb.ITable}
|
|
1247
1301
|
|
|
1248
1302
|
The Generated DynamoDB Table L2 Resources, keyed by logicalId.
|
|
1249
1303
|
|
|
@@ -1263,10 +1317,10 @@ const apiKeyAuthorizationConfig: ApiKeyAuthorizationConfig = { ... }
|
|
|
1263
1317
|
|
|
1264
1318
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1265
1319
|
|
|
1266
|
-
| **Name**
|
|
1267
|
-
|
|
|
1268
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig.property.expires">expires</a></code>
|
|
1269
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig.property.description">description</a></code> | <code>string</code>
|
|
1320
|
+
| **Name** | **Type** | **Description** |
|
|
1321
|
+
| --- | --- | --- |
|
|
1322
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig.property.expires">expires</a></code> | <code>aws-cdk-lib.Duration</code> | A duration representing the time from Cloudformation deploy until expiry. |
|
|
1323
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig.property.description">description</a></code> | <code>string</code> | Optional description for the Api Key to attach to the Api. |
|
|
1270
1324
|
|
|
1271
1325
|
---
|
|
1272
1326
|
|
|
@@ -1276,7 +1330,7 @@ const apiKeyAuthorizationConfig: ApiKeyAuthorizationConfig = { ... }
|
|
|
1276
1330
|
public readonly expires: Duration;
|
|
1277
1331
|
```
|
|
1278
1332
|
|
|
1279
|
-
-
|
|
1333
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1280
1334
|
|
|
1281
1335
|
A duration representing the time from Cloudformation deploy until expiry.
|
|
1282
1336
|
|
|
@@ -1288,7 +1342,7 @@ A duration representing the time from Cloudformation deploy until expiry.
|
|
|
1288
1342
|
public readonly description: string;
|
|
1289
1343
|
```
|
|
1290
1344
|
|
|
1291
|
-
-
|
|
1345
|
+
- *Type:* string
|
|
1292
1346
|
|
|
1293
1347
|
Optional description for the Api Key to attach to the Api.
|
|
1294
1348
|
|
|
@@ -1311,25 +1365,27 @@ const authorizationModes: AuthorizationModes = { ... }
|
|
|
1311
1365
|
|
|
1312
1366
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1313
1367
|
|
|
1314
|
-
| **Name**
|
|
1315
|
-
|
|
|
1316
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.adminRoles">adminRoles</a></code>
|
|
1317
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.apiKeyConfig">apiKeyConfig</a></code>
|
|
1318
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.defaultAuthorizationMode">defaultAuthorizationMode</a></code> | <code>string</code>
|
|
1319
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.iamConfig">iamConfig</a></code>
|
|
1320
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.lambdaConfig">lambdaConfig</a></code>
|
|
1321
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.oidcConfig">oidcConfig</a></code>
|
|
1322
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.userPoolConfig">userPoolConfig</a></code>
|
|
1368
|
+
| **Name** | **Type** | **Description** |
|
|
1369
|
+
| --- | --- | --- |
|
|
1370
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.adminRoles">adminRoles</a></code> | <code>aws-cdk-lib.aws_iam.IRole[]</code> | A list of roles granted full R/W access to the Api. |
|
|
1371
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.apiKeyConfig">apiKeyConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig">ApiKeyAuthorizationConfig</a></code> | AppSync Api Key config, required if a 'apiKey' auth provider is specified in the Api. |
|
|
1372
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.defaultAuthorizationMode">defaultAuthorizationMode</a></code> | <code>string</code> | Default auth mode to provide to the Api, required if more than one config type is specified. |
|
|
1373
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.iamConfig">iamConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig">IAMAuthorizationConfig</a></code> | IAM Auth config, required if an 'iam' auth provider is specified in the Api. |
|
|
1374
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.lambdaConfig">lambdaConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig">LambdaAuthorizationConfig</a></code> | Lambda config, required if a 'function' auth provider is specified in the Api. |
|
|
1375
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.oidcConfig">oidcConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig">OIDCAuthorizationConfig</a></code> | Cognito OIDC config, required if a 'oidc' auth provider is specified in the Api. |
|
|
1376
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AuthorizationModes.property.userPoolConfig">userPoolConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.UserPoolAuthorizationConfig">UserPoolAuthorizationConfig</a></code> | Cognito UserPool config, required if a 'userPools' auth provider is specified in the Api. |
|
|
1323
1377
|
|
|
1324
1378
|
---
|
|
1325
1379
|
|
|
1326
|
-
#####
|
|
1380
|
+
##### ~~`adminRoles`~~<sup>Optional</sup> <a name="adminRoles" id="@aws-amplify/graphql-api-construct.AuthorizationModes.property.adminRoles"></a>
|
|
1381
|
+
|
|
1382
|
+
- *Deprecated:* , use iamConfig.allowListedRoles instead.
|
|
1327
1383
|
|
|
1328
1384
|
```typescript
|
|
1329
1385
|
public readonly adminRoles: IRole[];
|
|
1330
1386
|
```
|
|
1331
1387
|
|
|
1332
|
-
-
|
|
1388
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole[]
|
|
1333
1389
|
|
|
1334
1390
|
A list of roles granted full R/W access to the Api.
|
|
1335
1391
|
|
|
@@ -1341,7 +1397,7 @@ A list of roles granted full R/W access to the Api.
|
|
|
1341
1397
|
public readonly apiKeyConfig: ApiKeyAuthorizationConfig;
|
|
1342
1398
|
```
|
|
1343
1399
|
|
|
1344
|
-
-
|
|
1400
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig">ApiKeyAuthorizationConfig</a>
|
|
1345
1401
|
|
|
1346
1402
|
AppSync Api Key config, required if a 'apiKey' auth provider is specified in the Api.
|
|
1347
1403
|
|
|
@@ -1355,7 +1411,7 @@ Applies to 'public' auth strategy.
|
|
|
1355
1411
|
public readonly defaultAuthorizationMode: string;
|
|
1356
1412
|
```
|
|
1357
1413
|
|
|
1358
|
-
-
|
|
1414
|
+
- *Type:* string
|
|
1359
1415
|
|
|
1360
1416
|
Default auth mode to provide to the Api, required if more than one config type is specified.
|
|
1361
1417
|
|
|
@@ -1367,7 +1423,7 @@ Default auth mode to provide to the Api, required if more than one config type i
|
|
|
1367
1423
|
public readonly iamConfig: IAMAuthorizationConfig;
|
|
1368
1424
|
```
|
|
1369
1425
|
|
|
1370
|
-
-
|
|
1426
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig">IAMAuthorizationConfig</a>
|
|
1371
1427
|
|
|
1372
1428
|
IAM Auth config, required if an 'iam' auth provider is specified in the Api.
|
|
1373
1429
|
|
|
@@ -1381,7 +1437,7 @@ Applies to 'public' and 'private' auth strategies.
|
|
|
1381
1437
|
public readonly lambdaConfig: LambdaAuthorizationConfig;
|
|
1382
1438
|
```
|
|
1383
1439
|
|
|
1384
|
-
-
|
|
1440
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig">LambdaAuthorizationConfig</a>
|
|
1385
1441
|
|
|
1386
1442
|
Lambda config, required if a 'function' auth provider is specified in the Api.
|
|
1387
1443
|
|
|
@@ -1395,7 +1451,7 @@ Applies to 'custom' auth strategy.
|
|
|
1395
1451
|
public readonly oidcConfig: OIDCAuthorizationConfig;
|
|
1396
1452
|
```
|
|
1397
1453
|
|
|
1398
|
-
-
|
|
1454
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig">OIDCAuthorizationConfig</a>
|
|
1399
1455
|
|
|
1400
1456
|
Cognito OIDC config, required if a 'oidc' auth provider is specified in the Api.
|
|
1401
1457
|
|
|
@@ -1409,7 +1465,7 @@ Applies to 'owner', 'private', and 'group' auth strategies.
|
|
|
1409
1465
|
public readonly userPoolConfig: UserPoolAuthorizationConfig;
|
|
1410
1466
|
```
|
|
1411
1467
|
|
|
1412
|
-
-
|
|
1468
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.UserPoolAuthorizationConfig">UserPoolAuthorizationConfig</a>
|
|
1413
1469
|
|
|
1414
1470
|
Cognito UserPool config, required if a 'userPools' auth provider is specified in the Api.
|
|
1415
1471
|
|
|
@@ -1431,10 +1487,10 @@ const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy =
|
|
|
1431
1487
|
|
|
1432
1488
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1433
1489
|
|
|
1434
|
-
| **Name**
|
|
1435
|
-
|
|
|
1436
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution.
|
|
1437
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy.property.handlerType">handlerType</a></code>
|
|
1490
|
+
| **Name** | **Type** | **Description** |
|
|
1491
|
+
| --- | --- | --- |
|
|
1492
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
1493
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy.property.handlerType">handlerType</a></code> | <code>string</code> | This conflict resolution strategy executes an auto-merge. |
|
|
1438
1494
|
|
|
1439
1495
|
---
|
|
1440
1496
|
|
|
@@ -1444,7 +1500,7 @@ const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy =
|
|
|
1444
1500
|
public readonly detectionType: string;
|
|
1445
1501
|
```
|
|
1446
1502
|
|
|
1447
|
-
-
|
|
1503
|
+
- *Type:* string
|
|
1448
1504
|
|
|
1449
1505
|
The conflict detection type used for resolution.
|
|
1450
1506
|
|
|
@@ -1456,7 +1512,7 @@ The conflict detection type used for resolution.
|
|
|
1456
1512
|
public readonly handlerType: string;
|
|
1457
1513
|
```
|
|
1458
1514
|
|
|
1459
|
-
-
|
|
1515
|
+
- *Type:* string
|
|
1460
1516
|
|
|
1461
1517
|
This conflict resolution strategy executes an auto-merge.
|
|
1462
1518
|
|
|
@@ -1478,10 +1534,10 @@ const conflictResolution: ConflictResolution = { ... }
|
|
|
1478
1534
|
|
|
1479
1535
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1480
1536
|
|
|
1481
|
-
| **Name**
|
|
1482
|
-
|
|
|
1483
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.ConflictResolution.property.models">models</a></code>
|
|
1484
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.ConflictResolution.property.project">project</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy">AutomergeConflictResolutionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy">OptimisticConflictResolutionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy">CustomConflictResolutionStrategy</a></code>
|
|
1537
|
+
| **Name** | **Type** | **Description** |
|
|
1538
|
+
| --- | --- | --- |
|
|
1539
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ConflictResolution.property.models">models</a></code> | <code>{[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy">AutomergeConflictResolutionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy">OptimisticConflictResolutionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy">CustomConflictResolutionStrategy</a>}</code> | Model-specific conflict resolution overrides. |
|
|
1540
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.ConflictResolution.property.project">project</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy">AutomergeConflictResolutionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy">OptimisticConflictResolutionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy">CustomConflictResolutionStrategy</a></code> | Project-wide config for conflict resolution. |
|
|
1485
1541
|
|
|
1486
1542
|
---
|
|
1487
1543
|
|
|
@@ -1491,7 +1547,7 @@ const conflictResolution: ConflictResolution = { ... }
|
|
|
1491
1547
|
public readonly models: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy};
|
|
1492
1548
|
```
|
|
1493
1549
|
|
|
1494
|
-
-
|
|
1550
|
+
- *Type:* {[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy">AutomergeConflictResolutionStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy">OptimisticConflictResolutionStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy">CustomConflictResolutionStrategy</a>}
|
|
1495
1551
|
|
|
1496
1552
|
Model-specific conflict resolution overrides.
|
|
1497
1553
|
|
|
@@ -1503,7 +1559,7 @@ Model-specific conflict resolution overrides.
|
|
|
1503
1559
|
public readonly project: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy;
|
|
1504
1560
|
```
|
|
1505
1561
|
|
|
1506
|
-
-
|
|
1562
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy">AutomergeConflictResolutionStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy">OptimisticConflictResolutionStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy">CustomConflictResolutionStrategy</a>
|
|
1507
1563
|
|
|
1508
1564
|
Project-wide config for conflict resolution.
|
|
1509
1565
|
|
|
@@ -1525,8 +1581,8 @@ const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }
|
|
|
1525
1581
|
|
|
1526
1582
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1527
1583
|
|
|
1528
|
-
| **Name**
|
|
1529
|
-
|
|
|
1584
|
+
| **Name** | **Type** | **Description** |
|
|
1585
|
+
| --- | --- | --- |
|
|
1530
1586
|
| <code><a href="#@aws-amplify/graphql-api-construct.ConflictResolutionStrategyBase.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
1531
1587
|
|
|
1532
1588
|
---
|
|
@@ -1537,7 +1593,7 @@ const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }
|
|
|
1537
1593
|
public readonly detectionType: string;
|
|
1538
1594
|
```
|
|
1539
1595
|
|
|
1540
|
-
-
|
|
1596
|
+
- *Type:* string
|
|
1541
1597
|
|
|
1542
1598
|
The conflict detection type used for resolution.
|
|
1543
1599
|
|
|
@@ -1557,11 +1613,11 @@ const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ...
|
|
|
1557
1613
|
|
|
1558
1614
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1559
1615
|
|
|
1560
|
-
| **Name**
|
|
1561
|
-
|
|
|
1562
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.detectionType">detectionType</a></code>
|
|
1563
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.conflictHandler">conflictHandler</a></code> | <code>aws-cdk-lib.aws_lambda.IFunction</code> | The function which will be invoked for conflict resolution.
|
|
1564
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.handlerType">handlerType</a></code>
|
|
1616
|
+
| **Name** | **Type** | **Description** |
|
|
1617
|
+
| --- | --- | --- |
|
|
1618
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
1619
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.conflictHandler">conflictHandler</a></code> | <code>aws-cdk-lib.aws_lambda.IFunction</code> | The function which will be invoked for conflict resolution. |
|
|
1620
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.handlerType">handlerType</a></code> | <code>string</code> | This conflict resolution strategy uses a lambda handler type. |
|
|
1565
1621
|
|
|
1566
1622
|
---
|
|
1567
1623
|
|
|
@@ -1571,7 +1627,7 @@ const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ...
|
|
|
1571
1627
|
public readonly detectionType: string;
|
|
1572
1628
|
```
|
|
1573
1629
|
|
|
1574
|
-
-
|
|
1630
|
+
- *Type:* string
|
|
1575
1631
|
|
|
1576
1632
|
The conflict detection type used for resolution.
|
|
1577
1633
|
|
|
@@ -1583,7 +1639,7 @@ The conflict detection type used for resolution.
|
|
|
1583
1639
|
public readonly conflictHandler: IFunction;
|
|
1584
1640
|
```
|
|
1585
1641
|
|
|
1586
|
-
-
|
|
1642
|
+
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
1587
1643
|
|
|
1588
1644
|
The function which will be invoked for conflict resolution.
|
|
1589
1645
|
|
|
@@ -1595,7 +1651,7 @@ The function which will be invoked for conflict resolution.
|
|
|
1595
1651
|
public readonly handlerType: string;
|
|
1596
1652
|
```
|
|
1597
1653
|
|
|
1598
|
-
-
|
|
1654
|
+
- *Type:* string
|
|
1599
1655
|
|
|
1600
1656
|
This conflict resolution strategy uses a lambda handler type.
|
|
1601
1657
|
|
|
@@ -1603,6 +1659,47 @@ For more information, refer to https://docs.aws.amazon.com/appsync/latest/devgui
|
|
|
1603
1659
|
|
|
1604
1660
|
---
|
|
1605
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
|
+
|
|
1606
1703
|
### FunctionSlotBase <a name="FunctionSlotBase" id="@aws-amplify/graphql-api-construct.FunctionSlotBase"></a>
|
|
1607
1704
|
|
|
1608
1705
|
Common slot parameters.
|
|
@@ -1617,11 +1714,11 @@ const functionSlotBase: FunctionSlotBase = { ... }
|
|
|
1617
1714
|
|
|
1618
1715
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1619
1716
|
|
|
1620
|
-
| **Name**
|
|
1621
|
-
|
|
|
1622
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotBase.property.fieldName">fieldName</a></code> | <code>string</code>
|
|
1623
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotBase.property.function">function</a></code>
|
|
1624
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotBase.property.slotIndex">slotIndex</a></code> | <code>number</code>
|
|
1717
|
+
| **Name** | **Type** | **Description** |
|
|
1718
|
+
| --- | --- | --- |
|
|
1719
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotBase.property.fieldName">fieldName</a></code> | <code>string</code> | The field to attach this function to on the Api definition. |
|
|
1720
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotBase.property.function">function</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a></code> | The overridden behavior for this slot. |
|
|
1721
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotBase.property.slotIndex">slotIndex</a></code> | <code>number</code> | The slot index to use to inject this into the execution pipeline. |
|
|
1625
1722
|
|
|
1626
1723
|
---
|
|
1627
1724
|
|
|
@@ -1631,7 +1728,7 @@ const functionSlotBase: FunctionSlotBase = { ... }
|
|
|
1631
1728
|
public readonly fieldName: string;
|
|
1632
1729
|
```
|
|
1633
1730
|
|
|
1634
|
-
-
|
|
1731
|
+
- *Type:* string
|
|
1635
1732
|
|
|
1636
1733
|
The field to attach this function to on the Api definition.
|
|
1637
1734
|
|
|
@@ -1643,7 +1740,7 @@ The field to attach this function to on the Api definition.
|
|
|
1643
1740
|
public readonly function: FunctionSlotOverride;
|
|
1644
1741
|
```
|
|
1645
1742
|
|
|
1646
|
-
-
|
|
1743
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
1647
1744
|
|
|
1648
1745
|
The overridden behavior for this slot.
|
|
1649
1746
|
|
|
@@ -1655,7 +1752,7 @@ The overridden behavior for this slot.
|
|
|
1655
1752
|
public readonly slotIndex: number;
|
|
1656
1753
|
```
|
|
1657
1754
|
|
|
1658
|
-
-
|
|
1755
|
+
- *Type:* number
|
|
1659
1756
|
|
|
1660
1757
|
The slot index to use to inject this into the execution pipeline.
|
|
1661
1758
|
|
|
@@ -1680,9 +1777,9 @@ const functionSlotOverride: FunctionSlotOverride = { ... }
|
|
|
1680
1777
|
|
|
1681
1778
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1682
1779
|
|
|
1683
|
-
| **Name**
|
|
1684
|
-
|
|
|
1685
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride.property.requestMappingTemplate">requestMappingTemplate</a></code>
|
|
1780
|
+
| **Name** | **Type** | **Description** |
|
|
1781
|
+
| --- | --- | --- |
|
|
1782
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride.property.requestMappingTemplate">requestMappingTemplate</a></code> | <code>aws-cdk-lib.aws_appsync.MappingTemplate</code> | Override request mapping template for the function slot. |
|
|
1686
1783
|
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride.property.responseMappingTemplate">responseMappingTemplate</a></code> | <code>aws-cdk-lib.aws_appsync.MappingTemplate</code> | Override response mapping template for the function slot. |
|
|
1687
1784
|
|
|
1688
1785
|
---
|
|
@@ -1693,7 +1790,7 @@ const functionSlotOverride: FunctionSlotOverride = { ... }
|
|
|
1693
1790
|
public readonly requestMappingTemplate: MappingTemplate;
|
|
1694
1791
|
```
|
|
1695
1792
|
|
|
1696
|
-
-
|
|
1793
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
1697
1794
|
|
|
1698
1795
|
Override request mapping template for the function slot.
|
|
1699
1796
|
|
|
@@ -1707,7 +1804,7 @@ Executed before the datasource is invoked.
|
|
|
1707
1804
|
public readonly responseMappingTemplate: MappingTemplate;
|
|
1708
1805
|
```
|
|
1709
1806
|
|
|
1710
|
-
-
|
|
1807
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
1711
1808
|
|
|
1712
1809
|
Override response mapping template for the function slot.
|
|
1713
1810
|
|
|
@@ -1729,11 +1826,12 @@ const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }
|
|
|
1729
1826
|
|
|
1730
1827
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1731
1828
|
|
|
1732
|
-
| **Name**
|
|
1733
|
-
|
|
|
1734
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.authenticatedUserRole">authenticatedUserRole</a></code>
|
|
1735
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.identityPoolId">identityPoolId</a></code>
|
|
1829
|
+
| **Name** | **Type** | **Description** |
|
|
1830
|
+
| --- | --- | --- |
|
|
1831
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.authenticatedUserRole">authenticatedUserRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | Authenticated user role, applies to { provider: iam, allow: private } access. |
|
|
1832
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.identityPoolId">identityPoolId</a></code> | <code>string</code> | ID for the Cognito Identity Pool vending auth and unauth roles. |
|
|
1736
1833
|
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.unauthenticatedUserRole">unauthenticatedUserRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | Unauthenticated user role, applies to { provider: iam, allow: public } access. |
|
|
1834
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.allowListedRoles">allowListedRoles</a></code> | <code>string \| aws-cdk-lib.aws_iam.IRole[]</code> | A list of IAM roles which will be granted full read/write access to the generated model if IAM auth is enabled. |
|
|
1737
1835
|
|
|
1738
1836
|
---
|
|
1739
1837
|
|
|
@@ -1743,7 +1841,7 @@ const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }
|
|
|
1743
1841
|
public readonly authenticatedUserRole: IRole;
|
|
1744
1842
|
```
|
|
1745
1843
|
|
|
1746
|
-
-
|
|
1844
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1747
1845
|
|
|
1748
1846
|
Authenticated user role, applies to { provider: iam, allow: private } access.
|
|
1749
1847
|
|
|
@@ -1755,7 +1853,7 @@ Authenticated user role, applies to { provider: iam, allow: private } access.
|
|
|
1755
1853
|
public readonly identityPoolId: string;
|
|
1756
1854
|
```
|
|
1757
1855
|
|
|
1758
|
-
-
|
|
1856
|
+
- *Type:* string
|
|
1759
1857
|
|
|
1760
1858
|
ID for the Cognito Identity Pool vending auth and unauth roles.
|
|
1761
1859
|
|
|
@@ -1769,12 +1867,27 @@ Format: `<region>:<id string>`
|
|
|
1769
1867
|
public readonly unauthenticatedUserRole: IRole;
|
|
1770
1868
|
```
|
|
1771
1869
|
|
|
1772
|
-
-
|
|
1870
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1773
1871
|
|
|
1774
1872
|
Unauthenticated user role, applies to { provider: iam, allow: public } access.
|
|
1775
1873
|
|
|
1776
1874
|
---
|
|
1777
1875
|
|
|
1876
|
+
##### `allowListedRoles`<sup>Optional</sup> <a name="allowListedRoles" id="@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.allowListedRoles"></a>
|
|
1877
|
+
|
|
1878
|
+
```typescript
|
|
1879
|
+
public readonly allowListedRoles: string | IRole[];
|
|
1880
|
+
```
|
|
1881
|
+
|
|
1882
|
+
- *Type:* string | aws-cdk-lib.aws_iam.IRole[]
|
|
1883
|
+
|
|
1884
|
+
A list of IAM roles which will be granted full read/write access to the generated model if IAM auth is enabled.
|
|
1885
|
+
|
|
1886
|
+
If an IRole is provided, the role `name` will be used for matching.
|
|
1887
|
+
If a string is provided, the raw value will be used for matching.
|
|
1888
|
+
|
|
1889
|
+
---
|
|
1890
|
+
|
|
1778
1891
|
### LambdaAuthorizationConfig <a name="LambdaAuthorizationConfig" id="@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig"></a>
|
|
1779
1892
|
|
|
1780
1893
|
Configuration for Custom Lambda authorization on the Graphql Api.
|
|
@@ -1789,10 +1902,10 @@ const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }
|
|
|
1789
1902
|
|
|
1790
1903
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1791
1904
|
|
|
1792
|
-
| **Name**
|
|
1793
|
-
|
|
|
1794
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig.property.function">function</a></code> | <code>aws-cdk-lib.aws_lambda.IFunction</code> | The authorizer lambda function.
|
|
1795
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig.property.ttl">ttl</a></code>
|
|
1905
|
+
| **Name** | **Type** | **Description** |
|
|
1906
|
+
| --- | --- | --- |
|
|
1907
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig.property.function">function</a></code> | <code>aws-cdk-lib.aws_lambda.IFunction</code> | The authorizer lambda function. |
|
|
1908
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig.property.ttl">ttl</a></code> | <code>aws-cdk-lib.Duration</code> | How long the results are cached. |
|
|
1796
1909
|
|
|
1797
1910
|
---
|
|
1798
1911
|
|
|
@@ -1802,7 +1915,7 @@ const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }
|
|
|
1802
1915
|
public readonly function: IFunction;
|
|
1803
1916
|
```
|
|
1804
1917
|
|
|
1805
|
-
-
|
|
1918
|
+
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
1806
1919
|
|
|
1807
1920
|
The authorizer lambda function.
|
|
1808
1921
|
|
|
@@ -1814,12 +1927,60 @@ The authorizer lambda function.
|
|
|
1814
1927
|
public readonly ttl: Duration;
|
|
1815
1928
|
```
|
|
1816
1929
|
|
|
1817
|
-
-
|
|
1930
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1818
1931
|
|
|
1819
1932
|
How long the results are cached.
|
|
1820
1933
|
|
|
1821
1934
|
---
|
|
1822
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
|
+
|
|
1823
1984
|
### MutationFunctionSlot <a name="MutationFunctionSlot" id="@aws-amplify/graphql-api-construct.MutationFunctionSlot"></a>
|
|
1824
1985
|
|
|
1825
1986
|
Slot types for Mutation Resolvers.
|
|
@@ -1834,13 +1995,13 @@ const mutationFunctionSlot: MutationFunctionSlot = { ... }
|
|
|
1834
1995
|
|
|
1835
1996
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1836
1997
|
|
|
1837
|
-
| **Name**
|
|
1838
|
-
|
|
|
1839
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.fieldName">fieldName</a></code> | <code>string</code>
|
|
1840
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.function">function</a></code>
|
|
1841
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.slotIndex">slotIndex</a></code> | <code>number</code>
|
|
1842
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.slotName">slotName</a></code>
|
|
1843
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.typeName">typeName</a></code>
|
|
1998
|
+
| **Name** | **Type** | **Description** |
|
|
1999
|
+
| --- | --- | --- |
|
|
2000
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.fieldName">fieldName</a></code> | <code>string</code> | The field to attach this function to on the Api definition. |
|
|
2001
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.function">function</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a></code> | The overridden behavior for this slot. |
|
|
2002
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.slotIndex">slotIndex</a></code> | <code>number</code> | The slot index to use to inject this into the execution pipeline. |
|
|
2003
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.slotName">slotName</a></code> | <code>string</code> | The slot name to inject this behavior into. |
|
|
2004
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot.property.typeName">typeName</a></code> | <code>string</code> | This slot type applies to the Mutation type on the Api definition. |
|
|
1844
2005
|
|
|
1845
2006
|
---
|
|
1846
2007
|
|
|
@@ -1850,7 +2011,7 @@ const mutationFunctionSlot: MutationFunctionSlot = { ... }
|
|
|
1850
2011
|
public readonly fieldName: string;
|
|
1851
2012
|
```
|
|
1852
2013
|
|
|
1853
|
-
-
|
|
2014
|
+
- *Type:* string
|
|
1854
2015
|
|
|
1855
2016
|
The field to attach this function to on the Api definition.
|
|
1856
2017
|
|
|
@@ -1862,7 +2023,7 @@ The field to attach this function to on the Api definition.
|
|
|
1862
2023
|
public readonly function: FunctionSlotOverride;
|
|
1863
2024
|
```
|
|
1864
2025
|
|
|
1865
|
-
-
|
|
2026
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
1866
2027
|
|
|
1867
2028
|
The overridden behavior for this slot.
|
|
1868
2029
|
|
|
@@ -1874,7 +2035,7 @@ The overridden behavior for this slot.
|
|
|
1874
2035
|
public readonly slotIndex: number;
|
|
1875
2036
|
```
|
|
1876
2037
|
|
|
1877
|
-
-
|
|
2038
|
+
- *Type:* number
|
|
1878
2039
|
|
|
1879
2040
|
The slot index to use to inject this into the execution pipeline.
|
|
1880
2041
|
|
|
@@ -1888,7 +2049,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
1888
2049
|
public readonly slotName: string;
|
|
1889
2050
|
```
|
|
1890
2051
|
|
|
1891
|
-
-
|
|
2052
|
+
- *Type:* string
|
|
1892
2053
|
|
|
1893
2054
|
The slot name to inject this behavior into.
|
|
1894
2055
|
|
|
@@ -1902,7 +2063,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
1902
2063
|
public readonly typeName: string;
|
|
1903
2064
|
```
|
|
1904
2065
|
|
|
1905
|
-
-
|
|
2066
|
+
- *Type:* string
|
|
1906
2067
|
|
|
1907
2068
|
This slot type applies to the Mutation type on the Api definition.
|
|
1908
2069
|
|
|
@@ -1922,13 +2083,13 @@ const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }
|
|
|
1922
2083
|
|
|
1923
2084
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1924
2085
|
|
|
1925
|
-
| **Name**
|
|
1926
|
-
|
|
|
1927
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcIssuerUrl">oidcIssuerUrl</a></code>
|
|
1928
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcProviderName">oidcProviderName</a></code>
|
|
1929
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.tokenExpiryFromAuth">tokenExpiryFromAuth</a></code>
|
|
1930
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.tokenExpiryFromIssue">tokenExpiryFromIssue</a></code> | <code>aws-cdk-lib.Duration</code> | The duration an OIDC token is valid after being issued to a user.
|
|
1931
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.clientId">clientId</a></code>
|
|
2086
|
+
| **Name** | **Type** | **Description** |
|
|
2087
|
+
| --- | --- | --- |
|
|
2088
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcIssuerUrl">oidcIssuerUrl</a></code> | <code>string</code> | Url for the OIDC token issuer. |
|
|
2089
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcProviderName">oidcProviderName</a></code> | <code>string</code> | The issuer for the OIDC configuration. |
|
|
2090
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.tokenExpiryFromAuth">tokenExpiryFromAuth</a></code> | <code>aws-cdk-lib.Duration</code> | The duration an OIDC token is valid after being authenticated by OIDC provider. |
|
|
2091
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.tokenExpiryFromIssue">tokenExpiryFromIssue</a></code> | <code>aws-cdk-lib.Duration</code> | The duration an OIDC token is valid after being issued to a user. |
|
|
2092
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.clientId">clientId</a></code> | <code>string</code> | The client identifier of the Relying party at the OpenID identity provider. |
|
|
1932
2093
|
|
|
1933
2094
|
---
|
|
1934
2095
|
|
|
@@ -1938,7 +2099,7 @@ const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }
|
|
|
1938
2099
|
public readonly oidcIssuerUrl: string;
|
|
1939
2100
|
```
|
|
1940
2101
|
|
|
1941
|
-
-
|
|
2102
|
+
- *Type:* string
|
|
1942
2103
|
|
|
1943
2104
|
Url for the OIDC token issuer.
|
|
1944
2105
|
|
|
@@ -1950,7 +2111,7 @@ Url for the OIDC token issuer.
|
|
|
1950
2111
|
public readonly oidcProviderName: string;
|
|
1951
2112
|
```
|
|
1952
2113
|
|
|
1953
|
-
-
|
|
2114
|
+
- *Type:* string
|
|
1954
2115
|
|
|
1955
2116
|
The issuer for the OIDC configuration.
|
|
1956
2117
|
|
|
@@ -1962,7 +2123,7 @@ The issuer for the OIDC configuration.
|
|
|
1962
2123
|
public readonly tokenExpiryFromAuth: Duration;
|
|
1963
2124
|
```
|
|
1964
2125
|
|
|
1965
|
-
-
|
|
2126
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1966
2127
|
|
|
1967
2128
|
The duration an OIDC token is valid after being authenticated by OIDC provider.
|
|
1968
2129
|
|
|
@@ -1976,7 +2137,7 @@ auth_time claim in OIDC token is required for this validation to work.
|
|
|
1976
2137
|
public readonly tokenExpiryFromIssue: Duration;
|
|
1977
2138
|
```
|
|
1978
2139
|
|
|
1979
|
-
-
|
|
2140
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1980
2141
|
|
|
1981
2142
|
The duration an OIDC token is valid after being issued to a user.
|
|
1982
2143
|
|
|
@@ -1990,7 +2151,7 @@ This validation uses iat claim of OIDC token.
|
|
|
1990
2151
|
public readonly clientId: string;
|
|
1991
2152
|
```
|
|
1992
2153
|
|
|
1993
|
-
-
|
|
2154
|
+
- *Type:* string
|
|
1994
2155
|
|
|
1995
2156
|
The client identifier of the Relying party at the OpenID identity provider.
|
|
1996
2157
|
|
|
@@ -2012,10 +2173,10 @@ const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy
|
|
|
2012
2173
|
|
|
2013
2174
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2014
2175
|
|
|
2015
|
-
| **Name**
|
|
2016
|
-
|
|
|
2017
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution.
|
|
2018
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy.property.handlerType">handlerType</a></code>
|
|
2176
|
+
| **Name** | **Type** | **Description** |
|
|
2177
|
+
| --- | --- | --- |
|
|
2178
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
2179
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy.property.handlerType">handlerType</a></code> | <code>string</code> | This conflict resolution strategy the _version to perform optimistic concurrency. |
|
|
2019
2180
|
|
|
2020
2181
|
---
|
|
2021
2182
|
|
|
@@ -2025,7 +2186,7 @@ const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy
|
|
|
2025
2186
|
public readonly detectionType: string;
|
|
2026
2187
|
```
|
|
2027
2188
|
|
|
2028
|
-
-
|
|
2189
|
+
- *Type:* string
|
|
2029
2190
|
|
|
2030
2191
|
The conflict detection type used for resolution.
|
|
2031
2192
|
|
|
@@ -2037,9 +2198,9 @@ The conflict detection type used for resolution.
|
|
|
2037
2198
|
public readonly handlerType: string;
|
|
2038
2199
|
```
|
|
2039
2200
|
|
|
2040
|
-
-
|
|
2201
|
+
- *Type:* string
|
|
2041
2202
|
|
|
2042
|
-
This conflict resolution strategy the
|
|
2203
|
+
This conflict resolution strategy the _version to perform optimistic concurrency.
|
|
2043
2204
|
|
|
2044
2205
|
For more information, refer to https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html#conflict-detection-and-resolution
|
|
2045
2206
|
|
|
@@ -2059,19 +2220,19 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
|
|
|
2059
2220
|
|
|
2060
2221
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2061
2222
|
|
|
2062
|
-
| **Name**
|
|
2063
|
-
|
|
|
2064
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.disableResolverDeduping">disableResolverDeduping</a></code>
|
|
2065
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableAutoIndexQueryNames">enableAutoIndexQueryNames</a></code>
|
|
2066
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code>
|
|
2067
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableTransformerCfnOutputs">enableTransformerCfnOutputs</a></code>
|
|
2068
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.populateOwnerFieldForStaticGroupAuth">populateOwnerFieldForStaticGroupAuth</a></code>
|
|
2069
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.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.
|
|
2070
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.sandboxModeEnabled">sandboxModeEnabled</a></code>
|
|
2071
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code>
|
|
2072
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code>
|
|
2073
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.suppressApiKeyGeneration">suppressApiKeyGeneration</a></code>
|
|
2074
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.useSubUsernameForDefaultIdentityClaim">useSubUsernameForDefaultIdentityClaim</a></code>
|
|
2223
|
+
| **Name** | **Type** | **Description** |
|
|
2224
|
+
| --- | --- | --- |
|
|
2225
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.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. |
|
|
2226
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.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. |
|
|
2227
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | If enabled, set nodeToNodeEncryption on the searchable domain (if one exists). |
|
|
2228
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableTransformerCfnOutputs">enableTransformerCfnOutputs</a></code> | <code>boolean</code> | When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted. |
|
|
2229
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.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. |
|
|
2230
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.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. |
|
|
2231
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.sandboxModeEnabled">sandboxModeEnabled</a></code> | <code>boolean</code> | Enabling sandbox mode will enable api key auth on all models in the transformed schema. |
|
|
2232
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code> | <code>boolean</code> | If disabled, generated. |
|
|
2233
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code> | <code>boolean</code> | Restore parity w/ GQLv1. |
|
|
2234
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.suppressApiKeyGeneration">suppressApiKeyGeneration</a></code> | <code>boolean</code> | If enabled, disable api key resource generation even if specified as an auth rule on the construct. |
|
|
2235
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.useSubUsernameForDefaultIdentityClaim">useSubUsernameForDefaultIdentityClaim</a></code> | <code>boolean</code> | Ensure that oidc and userPool auth use the `sub` field in the for the username field, which disallows new users with the same id to access data from a deleted user in the pool. |
|
|
2075
2236
|
|
|
2076
2237
|
---
|
|
2077
2238
|
|
|
@@ -2081,8 +2242,8 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
|
|
|
2081
2242
|
public readonly disableResolverDeduping: boolean;
|
|
2082
2243
|
```
|
|
2083
2244
|
|
|
2084
|
-
-
|
|
2085
|
-
-
|
|
2245
|
+
- *Type:* boolean
|
|
2246
|
+
- *Default:* true
|
|
2086
2247
|
|
|
2087
2248
|
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.
|
|
2088
2249
|
|
|
@@ -2094,8 +2255,8 @@ Disable resolver deduping, this can sometimes cause problems because dedupe orde
|
|
|
2094
2255
|
public readonly enableAutoIndexQueryNames: boolean;
|
|
2095
2256
|
```
|
|
2096
2257
|
|
|
2097
|
-
-
|
|
2098
|
-
-
|
|
2258
|
+
- *Type:* boolean
|
|
2259
|
+
- *Default:* true
|
|
2099
2260
|
|
|
2100
2261
|
Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.
|
|
2101
2262
|
|
|
@@ -2109,14 +2270,14 @@ If enabled,
|
|
|
2109
2270
|
public readonly enableSearchNodeToNodeEncryption: boolean;
|
|
2110
2271
|
```
|
|
2111
2272
|
|
|
2112
|
-
-
|
|
2113
|
-
-
|
|
2273
|
+
- *Type:* boolean
|
|
2274
|
+
- *Default:* false
|
|
2114
2275
|
|
|
2115
2276
|
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
|
2116
2277
|
|
|
2117
2278
|
Not recommended for use, prefer
|
|
2118
2279
|
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
|
2119
|
-
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2280
|
+
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2120
2281
|
});
|
|
2121
2282
|
|
|
2122
2283
|
---
|
|
@@ -2127,8 +2288,8 @@ domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
|
2127
2288
|
public readonly enableTransformerCfnOutputs: boolean;
|
|
2128
2289
|
```
|
|
2129
2290
|
|
|
2130
|
-
-
|
|
2131
|
-
-
|
|
2291
|
+
- *Type:* boolean
|
|
2292
|
+
- *Default:* false
|
|
2132
2293
|
|
|
2133
2294
|
When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.
|
|
2134
2295
|
|
|
@@ -2140,8 +2301,8 @@ When enabled, internal cfn outputs which existed in Amplify-generated apps will
|
|
|
2140
2301
|
public readonly populateOwnerFieldForStaticGroupAuth: boolean;
|
|
2141
2302
|
```
|
|
2142
2303
|
|
|
2143
|
-
-
|
|
2144
|
-
-
|
|
2304
|
+
- *Type:* boolean
|
|
2305
|
+
- *Default:* true
|
|
2145
2306
|
|
|
2146
2307
|
Ensure that the owner field is still populated even if a static iam or group authorization applies.
|
|
2147
2308
|
|
|
@@ -2153,8 +2314,8 @@ Ensure that the owner field is still populated even if a static iam or group aut
|
|
|
2153
2314
|
public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;
|
|
2154
2315
|
```
|
|
2155
2316
|
|
|
2156
|
-
-
|
|
2157
|
-
-
|
|
2317
|
+
- *Type:* boolean
|
|
2318
|
+
- *Default:* true
|
|
2158
2319
|
|
|
2159
2320
|
Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.
|
|
2160
2321
|
|
|
@@ -2166,8 +2327,8 @@ Enable custom primary key support, there's no good reason to disable this unless
|
|
|
2166
2327
|
public readonly sandboxModeEnabled: boolean;
|
|
2167
2328
|
```
|
|
2168
2329
|
|
|
2169
|
-
-
|
|
2170
|
-
-
|
|
2330
|
+
- *Type:* boolean
|
|
2331
|
+
- *Default:* false
|
|
2171
2332
|
|
|
2172
2333
|
Enabling sandbox mode will enable api key auth on all models in the transformed schema.
|
|
2173
2334
|
|
|
@@ -2179,8 +2340,8 @@ Enabling sandbox mode will enable api key auth on all models in the transformed
|
|
|
2179
2340
|
public readonly secondaryKeyAsGSI: boolean;
|
|
2180
2341
|
```
|
|
2181
2342
|
|
|
2182
|
-
-
|
|
2183
|
-
-
|
|
2343
|
+
- *Type:* boolean
|
|
2344
|
+
- *Default:* true
|
|
2184
2345
|
|
|
2185
2346
|
If disabled, generated.
|
|
2186
2347
|
|
|
@@ -2192,8 +2353,8 @@ If disabled, generated.
|
|
|
2192
2353
|
public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
|
|
2193
2354
|
```
|
|
2194
2355
|
|
|
2195
|
-
-
|
|
2196
|
-
-
|
|
2356
|
+
- *Type:* boolean
|
|
2357
|
+
- *Default:* true
|
|
2197
2358
|
|
|
2198
2359
|
Restore parity w/ GQLv1.
|
|
2199
2360
|
|
|
@@ -2205,8 +2366,8 @@ Restore parity w/ GQLv1.
|
|
|
2205
2366
|
public readonly suppressApiKeyGeneration: boolean;
|
|
2206
2367
|
```
|
|
2207
2368
|
|
|
2208
|
-
-
|
|
2209
|
-
-
|
|
2369
|
+
- *Type:* boolean
|
|
2370
|
+
- *Default:* false
|
|
2210
2371
|
|
|
2211
2372
|
If enabled, disable api key resource generation even if specified as an auth rule on the construct.
|
|
2212
2373
|
|
|
@@ -2220,13 +2381,58 @@ This is a legacy parameter from the Graphql Transformer existing in Amplify CLI,
|
|
|
2220
2381
|
public readonly useSubUsernameForDefaultIdentityClaim: boolean;
|
|
2221
2382
|
```
|
|
2222
2383
|
|
|
2223
|
-
-
|
|
2224
|
-
-
|
|
2384
|
+
- *Type:* boolean
|
|
2385
|
+
- *Default:* true
|
|
2225
2386
|
|
|
2226
2387
|
Ensure that oidc and userPool auth use the `sub` field in the for the username field, which disallows new users with the same id to access data from a deleted user in the pool.
|
|
2227
2388
|
|
|
2228
2389
|
---
|
|
2229
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
|
+
|
|
2230
2436
|
### QueryFunctionSlot <a name="QueryFunctionSlot" id="@aws-amplify/graphql-api-construct.QueryFunctionSlot"></a>
|
|
2231
2437
|
|
|
2232
2438
|
Slot types for Query Resolvers.
|
|
@@ -2241,13 +2447,13 @@ const queryFunctionSlot: QueryFunctionSlot = { ... }
|
|
|
2241
2447
|
|
|
2242
2448
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2243
2449
|
|
|
2244
|
-
| **Name**
|
|
2245
|
-
|
|
|
2246
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.fieldName">fieldName</a></code> | <code>string</code>
|
|
2247
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.function">function</a></code>
|
|
2248
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.slotIndex">slotIndex</a></code> | <code>number</code>
|
|
2249
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.slotName">slotName</a></code>
|
|
2250
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.typeName">typeName</a></code>
|
|
2450
|
+
| **Name** | **Type** | **Description** |
|
|
2451
|
+
| --- | --- | --- |
|
|
2452
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.fieldName">fieldName</a></code> | <code>string</code> | The field to attach this function to on the Api definition. |
|
|
2453
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.function">function</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a></code> | The overridden behavior for this slot. |
|
|
2454
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.slotIndex">slotIndex</a></code> | <code>number</code> | The slot index to use to inject this into the execution pipeline. |
|
|
2455
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.slotName">slotName</a></code> | <code>string</code> | The slot name to inject this behavior into. |
|
|
2456
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot.property.typeName">typeName</a></code> | <code>string</code> | This slot type applies to the Query type on the Api definition. |
|
|
2251
2457
|
|
|
2252
2458
|
---
|
|
2253
2459
|
|
|
@@ -2257,7 +2463,7 @@ const queryFunctionSlot: QueryFunctionSlot = { ... }
|
|
|
2257
2463
|
public readonly fieldName: string;
|
|
2258
2464
|
```
|
|
2259
2465
|
|
|
2260
|
-
-
|
|
2466
|
+
- *Type:* string
|
|
2261
2467
|
|
|
2262
2468
|
The field to attach this function to on the Api definition.
|
|
2263
2469
|
|
|
@@ -2269,7 +2475,7 @@ The field to attach this function to on the Api definition.
|
|
|
2269
2475
|
public readonly function: FunctionSlotOverride;
|
|
2270
2476
|
```
|
|
2271
2477
|
|
|
2272
|
-
-
|
|
2478
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
2273
2479
|
|
|
2274
2480
|
The overridden behavior for this slot.
|
|
2275
2481
|
|
|
@@ -2281,7 +2487,7 @@ The overridden behavior for this slot.
|
|
|
2281
2487
|
public readonly slotIndex: number;
|
|
2282
2488
|
```
|
|
2283
2489
|
|
|
2284
|
-
-
|
|
2490
|
+
- *Type:* number
|
|
2285
2491
|
|
|
2286
2492
|
The slot index to use to inject this into the execution pipeline.
|
|
2287
2493
|
|
|
@@ -2295,7 +2501,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
2295
2501
|
public readonly slotName: string;
|
|
2296
2502
|
```
|
|
2297
2503
|
|
|
2298
|
-
-
|
|
2504
|
+
- *Type:* string
|
|
2299
2505
|
|
|
2300
2506
|
The slot name to inject this behavior into.
|
|
2301
2507
|
|
|
@@ -2309,97 +2515,248 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
2309
2515
|
public readonly typeName: string;
|
|
2310
2516
|
```
|
|
2311
2517
|
|
|
2312
|
-
-
|
|
2518
|
+
- *Type:* string
|
|
2313
2519
|
|
|
2314
2520
|
This slot type applies to the Query type on the Api definition.
|
|
2315
2521
|
|
|
2316
2522
|
---
|
|
2317
2523
|
|
|
2318
|
-
###
|
|
2524
|
+
### SSESpecification <a name="SSESpecification" id="@aws-amplify/graphql-api-construct.SSESpecification"></a>
|
|
2319
2525
|
|
|
2320
|
-
|
|
2526
|
+
Represents the settings used to enable server-side encryption.
|
|
2321
2527
|
|
|
2322
|
-
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.
|
|
2528
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.SSESpecification.Initializer"></a>
|
|
2323
2529
|
|
|
2324
2530
|
```typescript
|
|
2325
|
-
import {
|
|
2531
|
+
import { SSESpecification } from '@aws-amplify/graphql-api-construct'
|
|
2326
2532
|
|
|
2327
|
-
const
|
|
2533
|
+
const sSESpecification: SSESpecification = { ... }
|
|
2328
2534
|
```
|
|
2329
2535
|
|
|
2330
2536
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2331
2537
|
|
|
2332
|
-
| **Name**
|
|
2333
|
-
|
|
|
2334
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.
|
|
2335
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.
|
|
2336
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.
|
|
2337
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotName">slotName</a></code> | <code>string</code> | The slot name to inject this behavior into. |
|
|
2338
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.typeName">typeName</a></code> | <code>string</code> | This slot type applies to the Subscription type on the Api definition. |
|
|
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. |
|
|
2339
2543
|
|
|
2340
2544
|
---
|
|
2341
2545
|
|
|
2342
|
-
##### `
|
|
2546
|
+
##### `sseEnabled`<sup>Required</sup> <a name="sseEnabled" id="@aws-amplify/graphql-api-construct.SSESpecification.property.sseEnabled"></a>
|
|
2343
2547
|
|
|
2344
2548
|
```typescript
|
|
2345
|
-
public readonly
|
|
2549
|
+
public readonly sseEnabled: boolean;
|
|
2346
2550
|
```
|
|
2347
2551
|
|
|
2348
|
-
-
|
|
2552
|
+
- *Type:* boolean
|
|
2349
2553
|
|
|
2350
|
-
|
|
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.
|
|
2351
2558
|
|
|
2352
2559
|
---
|
|
2353
2560
|
|
|
2354
|
-
##### `
|
|
2561
|
+
##### `kmsMasterKeyId`<sup>Optional</sup> <a name="kmsMasterKeyId" id="@aws-amplify/graphql-api-construct.SSESpecification.property.kmsMasterKeyId"></a>
|
|
2355
2562
|
|
|
2356
2563
|
```typescript
|
|
2357
|
-
public readonly
|
|
2564
|
+
public readonly kmsMasterKeyId: string;
|
|
2358
2565
|
```
|
|
2359
2566
|
|
|
2360
|
-
-
|
|
2567
|
+
- *Type:* string
|
|
2568
|
+
|
|
2569
|
+
The AWS KMS key that should be used for the AWS KMS encryption.
|
|
2361
2570
|
|
|
2362
|
-
|
|
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` .
|
|
2363
2573
|
|
|
2364
2574
|
---
|
|
2365
2575
|
|
|
2366
|
-
##### `
|
|
2576
|
+
##### `sseType`<sup>Optional</sup> <a name="sseType" id="@aws-amplify/graphql-api-construct.SSESpecification.property.sseType"></a>
|
|
2367
2577
|
|
|
2368
2578
|
```typescript
|
|
2369
|
-
public readonly
|
|
2579
|
+
public readonly sseType: SSEType;
|
|
2370
2580
|
```
|
|
2371
2581
|
|
|
2372
|
-
-
|
|
2582
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.SSEType">SSEType</a>
|
|
2373
2583
|
|
|
2374
|
-
|
|
2584
|
+
Server-side encryption type.
|
|
2375
2585
|
|
|
2376
|
-
|
|
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).
|
|
2377
2589
|
|
|
2378
2590
|
---
|
|
2379
2591
|
|
|
2380
|
-
|
|
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>
|
|
2381
2597
|
|
|
2382
2598
|
```typescript
|
|
2383
|
-
|
|
2384
|
-
```
|
|
2599
|
+
import { StreamSpecification } from '@aws-amplify/graphql-api-construct'
|
|
2385
2600
|
|
|
2386
|
-
|
|
2601
|
+
const streamSpecification: StreamSpecification = { ... }
|
|
2602
|
+
```
|
|
2387
2603
|
|
|
2388
|
-
|
|
2604
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2389
2605
|
|
|
2390
|
-
|
|
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. |
|
|
2391
2609
|
|
|
2392
2610
|
---
|
|
2393
2611
|
|
|
2394
|
-
##### `
|
|
2612
|
+
##### `streamViewType`<sup>Required</sup> <a name="streamViewType" id="@aws-amplify/graphql-api-construct.StreamSpecification.property.streamViewType"></a>
|
|
2395
2613
|
|
|
2396
2614
|
```typescript
|
|
2397
|
-
public readonly
|
|
2615
|
+
public readonly streamViewType: StreamViewType;
|
|
2398
2616
|
```
|
|
2399
2617
|
|
|
2400
|
-
-
|
|
2618
|
+
- *Type:* aws-cdk-lib.aws_dynamodb.StreamViewType
|
|
2401
2619
|
|
|
2402
|
-
|
|
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
|
+
|
|
2630
|
+
### SubscriptionFunctionSlot <a name="SubscriptionFunctionSlot" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot"></a>
|
|
2631
|
+
|
|
2632
|
+
Slot types for Subscription Resolvers.
|
|
2633
|
+
|
|
2634
|
+
#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.Initializer"></a>
|
|
2635
|
+
|
|
2636
|
+
```typescript
|
|
2637
|
+
import { SubscriptionFunctionSlot } from '@aws-amplify/graphql-api-construct'
|
|
2638
|
+
|
|
2639
|
+
const subscriptionFunctionSlot: SubscriptionFunctionSlot = { ... }
|
|
2640
|
+
```
|
|
2641
|
+
|
|
2642
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2643
|
+
|
|
2644
|
+
| **Name** | **Type** | **Description** |
|
|
2645
|
+
| --- | --- | --- |
|
|
2646
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.fieldName">fieldName</a></code> | <code>string</code> | The field to attach this function to on the Api definition. |
|
|
2647
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.function">function</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a></code> | The overridden behavior for this slot. |
|
|
2648
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotIndex">slotIndex</a></code> | <code>number</code> | The slot index to use to inject this into the execution pipeline. |
|
|
2649
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotName">slotName</a></code> | <code>string</code> | The slot name to inject this behavior into. |
|
|
2650
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.typeName">typeName</a></code> | <code>string</code> | This slot type applies to the Subscription type on the Api definition. |
|
|
2651
|
+
|
|
2652
|
+
---
|
|
2653
|
+
|
|
2654
|
+
##### `fieldName`<sup>Required</sup> <a name="fieldName" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.fieldName"></a>
|
|
2655
|
+
|
|
2656
|
+
```typescript
|
|
2657
|
+
public readonly fieldName: string;
|
|
2658
|
+
```
|
|
2659
|
+
|
|
2660
|
+
- *Type:* string
|
|
2661
|
+
|
|
2662
|
+
The field to attach this function to on the Api definition.
|
|
2663
|
+
|
|
2664
|
+
---
|
|
2665
|
+
|
|
2666
|
+
##### `function`<sup>Required</sup> <a name="function" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.function"></a>
|
|
2667
|
+
|
|
2668
|
+
```typescript
|
|
2669
|
+
public readonly function: FunctionSlotOverride;
|
|
2670
|
+
```
|
|
2671
|
+
|
|
2672
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
2673
|
+
|
|
2674
|
+
The overridden behavior for this slot.
|
|
2675
|
+
|
|
2676
|
+
---
|
|
2677
|
+
|
|
2678
|
+
##### `slotIndex`<sup>Required</sup> <a name="slotIndex" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotIndex"></a>
|
|
2679
|
+
|
|
2680
|
+
```typescript
|
|
2681
|
+
public readonly slotIndex: number;
|
|
2682
|
+
```
|
|
2683
|
+
|
|
2684
|
+
- *Type:* number
|
|
2685
|
+
|
|
2686
|
+
The slot index to use to inject this into the execution pipeline.
|
|
2687
|
+
|
|
2688
|
+
For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers
|
|
2689
|
+
|
|
2690
|
+
---
|
|
2691
|
+
|
|
2692
|
+
##### `slotName`<sup>Required</sup> <a name="slotName" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotName"></a>
|
|
2693
|
+
|
|
2694
|
+
```typescript
|
|
2695
|
+
public readonly slotName: string;
|
|
2696
|
+
```
|
|
2697
|
+
|
|
2698
|
+
- *Type:* string
|
|
2699
|
+
|
|
2700
|
+
The slot name to inject this behavior into.
|
|
2701
|
+
|
|
2702
|
+
For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers
|
|
2703
|
+
|
|
2704
|
+
---
|
|
2705
|
+
|
|
2706
|
+
##### `typeName`<sup>Required</sup> <a name="typeName" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.typeName"></a>
|
|
2707
|
+
|
|
2708
|
+
```typescript
|
|
2709
|
+
public readonly typeName: string;
|
|
2710
|
+
```
|
|
2711
|
+
|
|
2712
|
+
- *Type:* string
|
|
2713
|
+
|
|
2714
|
+
This slot type applies to the Subscription type on the Api definition.
|
|
2715
|
+
|
|
2716
|
+
---
|
|
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.
|
|
2403
2760
|
|
|
2404
2761
|
---
|
|
2405
2762
|
|
|
@@ -2421,19 +2778,19 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
|
2421
2778
|
|
|
2422
2779
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2423
2780
|
|
|
2424
|
-
| **Name**
|
|
2425
|
-
|
|
|
2426
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.disableResolverDeduping">disableResolverDeduping</a></code>
|
|
2427
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableAutoIndexQueryNames">enableAutoIndexQueryNames</a></code>
|
|
2428
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code>
|
|
2429
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableTransformerCfnOutputs">enableTransformerCfnOutputs</a></code>
|
|
2430
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.populateOwnerFieldForStaticGroupAuth">populateOwnerFieldForStaticGroupAuth</a></code>
|
|
2431
|
-
| <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.
|
|
2432
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.sandboxModeEnabled">sandboxModeEnabled</a></code>
|
|
2433
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code>
|
|
2434
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code>
|
|
2435
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.suppressApiKeyGeneration">suppressApiKeyGeneration</a></code>
|
|
2436
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.useSubUsernameForDefaultIdentityClaim">useSubUsernameForDefaultIdentityClaim</a></code>
|
|
2781
|
+
| **Name** | **Type** | **Description** |
|
|
2782
|
+
| --- | --- | --- |
|
|
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. |
|
|
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. |
|
|
2785
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | *No description.* |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
2789
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.sandboxModeEnabled">sandboxModeEnabled</a></code> | <code>boolean</code> | Enabling sandbox mode will enable api key auth on all models in the transformed schema. |
|
|
2790
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code> | <code>boolean</code> | If disabled, generated. |
|
|
2791
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code> | <code>boolean</code> | Restore parity w/ GQLv1. |
|
|
2792
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.suppressApiKeyGeneration">suppressApiKeyGeneration</a></code> | <code>boolean</code> | If enabled, disable api key resource generation even if specified as an auth rule on the construct. |
|
|
2793
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.useSubUsernameForDefaultIdentityClaim">useSubUsernameForDefaultIdentityClaim</a></code> | <code>boolean</code> | Ensure that oidc and userPool auth use the `sub` field in the for the username field, which disallows new users with the same id to access data from a deleted user in the pool. |
|
|
2437
2794
|
|
|
2438
2795
|
---
|
|
2439
2796
|
|
|
@@ -2443,8 +2800,8 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
|
2443
2800
|
public readonly disableResolverDeduping: boolean;
|
|
2444
2801
|
```
|
|
2445
2802
|
|
|
2446
|
-
-
|
|
2447
|
-
-
|
|
2803
|
+
- *Type:* boolean
|
|
2804
|
+
- *Default:* true
|
|
2448
2805
|
|
|
2449
2806
|
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.
|
|
2450
2807
|
|
|
@@ -2456,8 +2813,8 @@ Disable resolver deduping, this can sometimes cause problems because dedupe orde
|
|
|
2456
2813
|
public readonly enableAutoIndexQueryNames: boolean;
|
|
2457
2814
|
```
|
|
2458
2815
|
|
|
2459
|
-
-
|
|
2460
|
-
-
|
|
2816
|
+
- *Type:* boolean
|
|
2817
|
+
- *Default:* true
|
|
2461
2818
|
|
|
2462
2819
|
Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.
|
|
2463
2820
|
|
|
@@ -2471,15 +2828,7 @@ If enabled,
|
|
|
2471
2828
|
public readonly enableSearchNodeToNodeEncryption: boolean;
|
|
2472
2829
|
```
|
|
2473
2830
|
|
|
2474
|
-
-
|
|
2475
|
-
- _Default:_ false
|
|
2476
|
-
|
|
2477
|
-
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
|
2478
|
-
|
|
2479
|
-
Not recommended for use, prefer
|
|
2480
|
-
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
|
2481
|
-
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2482
|
-
});
|
|
2831
|
+
- *Type:* boolean
|
|
2483
2832
|
|
|
2484
2833
|
---
|
|
2485
2834
|
|
|
@@ -2489,8 +2838,8 @@ domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
|
2489
2838
|
public readonly enableTransformerCfnOutputs: boolean;
|
|
2490
2839
|
```
|
|
2491
2840
|
|
|
2492
|
-
-
|
|
2493
|
-
-
|
|
2841
|
+
- *Type:* boolean
|
|
2842
|
+
- *Default:* false
|
|
2494
2843
|
|
|
2495
2844
|
When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.
|
|
2496
2845
|
|
|
@@ -2502,8 +2851,8 @@ When enabled, internal cfn outputs which existed in Amplify-generated apps will
|
|
|
2502
2851
|
public readonly populateOwnerFieldForStaticGroupAuth: boolean;
|
|
2503
2852
|
```
|
|
2504
2853
|
|
|
2505
|
-
-
|
|
2506
|
-
-
|
|
2854
|
+
- *Type:* boolean
|
|
2855
|
+
- *Default:* true
|
|
2507
2856
|
|
|
2508
2857
|
Ensure that the owner field is still populated even if a static iam or group authorization applies.
|
|
2509
2858
|
|
|
@@ -2515,8 +2864,8 @@ Ensure that the owner field is still populated even if a static iam or group aut
|
|
|
2515
2864
|
public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;
|
|
2516
2865
|
```
|
|
2517
2866
|
|
|
2518
|
-
-
|
|
2519
|
-
-
|
|
2867
|
+
- *Type:* boolean
|
|
2868
|
+
- *Default:* true
|
|
2520
2869
|
|
|
2521
2870
|
Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.
|
|
2522
2871
|
|
|
@@ -2528,8 +2877,8 @@ Enable custom primary key support, there's no good reason to disable this unless
|
|
|
2528
2877
|
public readonly sandboxModeEnabled: boolean;
|
|
2529
2878
|
```
|
|
2530
2879
|
|
|
2531
|
-
-
|
|
2532
|
-
-
|
|
2880
|
+
- *Type:* boolean
|
|
2881
|
+
- *Default:* false
|
|
2533
2882
|
|
|
2534
2883
|
Enabling sandbox mode will enable api key auth on all models in the transformed schema.
|
|
2535
2884
|
|
|
@@ -2541,8 +2890,8 @@ Enabling sandbox mode will enable api key auth on all models in the transformed
|
|
|
2541
2890
|
public readonly secondaryKeyAsGSI: boolean;
|
|
2542
2891
|
```
|
|
2543
2892
|
|
|
2544
|
-
-
|
|
2545
|
-
-
|
|
2893
|
+
- *Type:* boolean
|
|
2894
|
+
- *Default:* true
|
|
2546
2895
|
|
|
2547
2896
|
If disabled, generated.
|
|
2548
2897
|
|
|
@@ -2554,8 +2903,8 @@ If disabled, generated.
|
|
|
2554
2903
|
public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
|
|
2555
2904
|
```
|
|
2556
2905
|
|
|
2557
|
-
-
|
|
2558
|
-
-
|
|
2906
|
+
- *Type:* boolean
|
|
2907
|
+
- *Default:* true
|
|
2559
2908
|
|
|
2560
2909
|
Restore parity w/ GQLv1.
|
|
2561
2910
|
|
|
@@ -2567,8 +2916,8 @@ Restore parity w/ GQLv1.
|
|
|
2567
2916
|
public readonly suppressApiKeyGeneration: boolean;
|
|
2568
2917
|
```
|
|
2569
2918
|
|
|
2570
|
-
-
|
|
2571
|
-
-
|
|
2919
|
+
- *Type:* boolean
|
|
2920
|
+
- *Default:* false
|
|
2572
2921
|
|
|
2573
2922
|
If enabled, disable api key resource generation even if specified as an auth rule on the construct.
|
|
2574
2923
|
|
|
@@ -2582,8 +2931,8 @@ This is a legacy parameter from the Graphql Transformer existing in Amplify CLI,
|
|
|
2582
2931
|
public readonly useSubUsernameForDefaultIdentityClaim: boolean;
|
|
2583
2932
|
```
|
|
2584
2933
|
|
|
2585
|
-
-
|
|
2586
|
-
-
|
|
2934
|
+
- *Type:* boolean
|
|
2935
|
+
- *Default:* true
|
|
2587
2936
|
|
|
2588
2937
|
Ensure that oidc and userPool auth use the `sub` field in the for the username field, which disallows new users with the same id to access data from a deleted user in the pool.
|
|
2589
2938
|
|
|
@@ -2603,8 +2952,8 @@ const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }
|
|
|
2603
2952
|
|
|
2604
2953
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2605
2954
|
|
|
2606
|
-
| **Name**
|
|
2607
|
-
|
|
|
2955
|
+
| **Name** | **Type** | **Description** |
|
|
2956
|
+
| --- | --- | --- |
|
|
2608
2957
|
| <code><a href="#@aws-amplify/graphql-api-construct.UserPoolAuthorizationConfig.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | The Cognito User Pool which is used to authenticated JWT tokens, and vends group and user information. |
|
|
2609
2958
|
|
|
2610
2959
|
---
|
|
@@ -2615,7 +2964,7 @@ const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }
|
|
|
2615
2964
|
public readonly userPool: IUserPool;
|
|
2616
2965
|
```
|
|
2617
2966
|
|
|
2618
|
-
-
|
|
2967
|
+
- *Type:* aws-cdk-lib.aws_cognito.IUserPool
|
|
2619
2968
|
|
|
2620
2969
|
The Cognito User Pool which is used to authenticated JWT tokens, and vends group and user information.
|
|
2621
2970
|
|
|
@@ -2623,6 +2972,195 @@ The Cognito User Pool which is used to authenticated JWT tokens, and vends group
|
|
|
2623
2972
|
|
|
2624
2973
|
## Classes <a name="Classes" id="Classes"></a>
|
|
2625
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
|
+
|
|
2626
3164
|
### AmplifyGraphqlDefinition <a name="AmplifyGraphqlDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition"></a>
|
|
2627
3165
|
|
|
2628
3166
|
Class exposing utilities to produce IAmplifyGraphqlDefinition objects given various inputs.
|
|
@@ -2630,22 +3168,43 @@ Class exposing utilities to produce IAmplifyGraphqlDefinition objects given vari
|
|
|
2630
3168
|
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.Initializer"></a>
|
|
2631
3169
|
|
|
2632
3170
|
```typescript
|
|
2633
|
-
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
3171
|
+
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
2634
3172
|
|
|
2635
|
-
new AmplifyGraphqlDefinition()
|
|
3173
|
+
new AmplifyGraphqlDefinition()
|
|
2636
3174
|
```
|
|
2637
3175
|
|
|
2638
3176
|
| **Name** | **Type** | **Description** |
|
|
2639
|
-
|
|
|
3177
|
+
| --- | --- | --- |
|
|
2640
3178
|
|
|
2641
3179
|
---
|
|
2642
3180
|
|
|
3181
|
+
|
|
2643
3182
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
2644
3183
|
|
|
2645
|
-
| **Name**
|
|
2646
|
-
|
|
|
2647
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.
|
|
2648
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.
|
|
3184
|
+
| **Name** | **Description** |
|
|
3185
|
+
| --- | --- |
|
|
3186
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.combine">combine</a></code> | Combines multiple IAmplifyGraphqlDefinitions into a single definition. |
|
|
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. |
|
|
3189
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input. |
|
|
3190
|
+
|
|
3191
|
+
---
|
|
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.
|
|
2649
3208
|
|
|
2650
3209
|
---
|
|
2651
3210
|
|
|
@@ -2661,44 +3220,100 @@ Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.
|
|
|
2661
3220
|
|
|
2662
3221
|
###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles.parameter.filePaths"></a>
|
|
2663
3222
|
|
|
2664
|
-
-
|
|
3223
|
+
- *Type:* string
|
|
3224
|
+
|
|
3225
|
+
one or more paths to the graphql files to process.
|
|
3226
|
+
|
|
3227
|
+
---
|
|
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[]
|
|
2665
3242
|
|
|
2666
3243
|
one or more paths to the graphql files to process.
|
|
2667
3244
|
|
|
2668
3245
|
---
|
|
2669
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
|
+
|
|
2670
3257
|
##### `fromString` <a name="fromString" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString"></a>
|
|
2671
3258
|
|
|
2672
3259
|
```typescript
|
|
2673
3260
|
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
2674
3261
|
|
|
2675
|
-
AmplifyGraphqlDefinition.fromString(schema: string)
|
|
3262
|
+
AmplifyGraphqlDefinition.fromString(schema: string, modelDataSourceDefinition?: ModelDataSourceDefinition)
|
|
2676
3263
|
```
|
|
2677
3264
|
|
|
2678
3265
|
Produce a schema definition from a string input.
|
|
2679
3266
|
|
|
2680
3267
|
###### `schema`<sup>Required</sup> <a name="schema" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.schema"></a>
|
|
2681
3268
|
|
|
2682
|
-
-
|
|
3269
|
+
- *Type:* string
|
|
2683
3270
|
|
|
2684
3271
|
the graphql input as a string.
|
|
2685
3272
|
|
|
2686
3273
|
---
|
|
2687
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
|
+
|
|
3285
|
+
|
|
3286
|
+
|
|
2688
3287
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
2689
3288
|
|
|
2690
3289
|
### IAmplifyGraphqlDefinition <a name="IAmplifyGraphqlDefinition" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition"></a>
|
|
2691
3290
|
|
|
2692
|
-
-
|
|
3291
|
+
- *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>
|
|
2693
3292
|
|
|
2694
3293
|
Graphql Api definition, which can be implemented in multiple ways.
|
|
2695
3294
|
|
|
3295
|
+
|
|
2696
3296
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2697
3297
|
|
|
2698
|
-
| **Name**
|
|
2699
|
-
|
|
|
2700
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.
|
|
2701
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.
|
|
3298
|
+
| **Name** | **Type** | **Description** |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
3303
|
+
|
|
3304
|
+
---
|
|
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.
|
|
2702
3317
|
|
|
2703
3318
|
---
|
|
2704
3319
|
|
|
@@ -2708,7 +3323,7 @@ Graphql Api definition, which can be implemented in multiple ways.
|
|
|
2708
3323
|
public readonly functionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
|
2709
3324
|
```
|
|
2710
3325
|
|
|
2711
|
-
-
|
|
3326
|
+
- *Type:* <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>[]
|
|
2712
3327
|
|
|
2713
3328
|
Retrieve any function slots defined explicitly in the Api definition.
|
|
2714
3329
|
|
|
@@ -2720,7 +3335,7 @@ Retrieve any function slots defined explicitly in the Api definition.
|
|
|
2720
3335
|
public readonly schema: string;
|
|
2721
3336
|
```
|
|
2722
3337
|
|
|
2723
|
-
-
|
|
3338
|
+
- *Type:* string
|
|
2724
3339
|
|
|
2725
3340
|
Return the schema definition as a graphql string, with amplify directives allowed.
|
|
2726
3341
|
|
|
@@ -2728,16 +3343,17 @@ Return the schema definition as a graphql string, with amplify directives allowe
|
|
|
2728
3343
|
|
|
2729
3344
|
### IBackendOutputEntry <a name="IBackendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputEntry"></a>
|
|
2730
3345
|
|
|
2731
|
-
-
|
|
3346
|
+
- *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>
|
|
2732
3347
|
|
|
2733
3348
|
Entry representing the required output from the backend for codegen generate commands to work.
|
|
2734
3349
|
|
|
3350
|
+
|
|
2735
3351
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2736
3352
|
|
|
2737
|
-
| **Name**
|
|
2738
|
-
|
|
|
3353
|
+
| **Name** | **Type** | **Description** |
|
|
3354
|
+
| --- | --- | --- |
|
|
2739
3355
|
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.payload">payload</a></code> | <code>{[ key: string ]: string}</code> | The string-map payload of generated config values. |
|
|
2740
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.version">version</a></code> | <code>string</code>
|
|
3356
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.version">version</a></code> | <code>string</code> | The protocol version for this backend output. |
|
|
2741
3357
|
|
|
2742
3358
|
---
|
|
2743
3359
|
|
|
@@ -2747,7 +3363,7 @@ Entry representing the required output from the backend for codegen generate com
|
|
|
2747
3363
|
public readonly payload: {[ key: string ]: string};
|
|
2748
3364
|
```
|
|
2749
3365
|
|
|
2750
|
-
-
|
|
3366
|
+
- *Type:* {[ key: string ]: string}
|
|
2751
3367
|
|
|
2752
3368
|
The string-map payload of generated config values.
|
|
2753
3369
|
|
|
@@ -2759,7 +3375,7 @@ The string-map payload of generated config values.
|
|
|
2759
3375
|
public readonly version: string;
|
|
2760
3376
|
```
|
|
2761
3377
|
|
|
2762
|
-
-
|
|
3378
|
+
- *Type:* string
|
|
2763
3379
|
|
|
2764
3380
|
The protocol version for this backend output.
|
|
2765
3381
|
|
|
@@ -2767,14 +3383,14 @@ The protocol version for this backend output.
|
|
|
2767
3383
|
|
|
2768
3384
|
### IBackendOutputStorageStrategy <a name="IBackendOutputStorageStrategy" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy"></a>
|
|
2769
3385
|
|
|
2770
|
-
-
|
|
3386
|
+
- *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a>
|
|
2771
3387
|
|
|
2772
3388
|
Backend output strategy used to write config required for codegen tasks.
|
|
2773
3389
|
|
|
2774
3390
|
#### Methods <a name="Methods" id="Methods"></a>
|
|
2775
3391
|
|
|
2776
|
-
| **Name**
|
|
2777
|
-
|
|
|
3392
|
+
| **Name** | **Description** |
|
|
3393
|
+
| --- | --- |
|
|
2778
3394
|
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry">addBackendOutputEntry</a></code> | Add an entry to backend output. |
|
|
2779
3395
|
|
|
2780
3396
|
---
|
|
@@ -2789,7 +3405,7 @@ Add an entry to backend output.
|
|
|
2789
3405
|
|
|
2790
3406
|
###### `keyName`<sup>Required</sup> <a name="keyName" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry.parameter.keyName"></a>
|
|
2791
3407
|
|
|
2792
|
-
-
|
|
3408
|
+
- *Type:* string
|
|
2793
3409
|
|
|
2794
3410
|
the key.
|
|
2795
3411
|
|
|
@@ -2797,8 +3413,30 @@ the key.
|
|
|
2797
3413
|
|
|
2798
3414
|
###### `backendOutputEntry`<sup>Required</sup> <a name="backendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry.parameter.backendOutputEntry"></a>
|
|
2799
3415
|
|
|
2800
|
-
-
|
|
3416
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>
|
|
2801
3417
|
|
|
2802
3418
|
the record to store in the backend output.
|
|
2803
3419
|
|
|
2804
3420
|
---
|
|
3421
|
+
|
|
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
|
+
|