@aws-amplify/graphql-api-construct 1.2.0 → 1.3.0-rds-5.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.jsii +619 -168
- package/API.md +42 -1
- package/CHANGELOG.md +7 -0
- package/README.md +370 -377
- package/lib/amplify-graphql-api.d.ts +6 -0
- package/lib/amplify-graphql-api.js +60 -4
- package/lib/amplify-graphql-definition.d.ts +17 -6
- package/lib/amplify-graphql-definition.js +26 -11
- package/lib/index.d.ts +1 -1
- package/lib/index.js +1 -1
- package/lib/sql-model-datasource-binding.d.ts +20 -0
- package/lib/sql-model-datasource-binding.js +42 -0
- package/lib/types.d.ts +97 -0
- package/lib/types.js +1 -1
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/index.js +2 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/v1.js +2 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/index.js +2 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/v1.js +3 -5
- package/node_modules/@aws-amplify/backend-output-schemas/lib/index.js +7 -11
- package/node_modules/@aws-amplify/backend-output-schemas/lib/platform/stack_metadata_schemas.js +2 -4
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/index.js +2 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/v1.js +2 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/index.js +2 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/v1.js +2 -3
- package/node_modules/@aws-amplify/backend-output-storage/package.json +2 -2
- package/node_modules/@aws-amplify/graphql-auth-transformer/API.md +5 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/CHANGELOG.md +16 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.d.ts +3 -1
- 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 +64 -50
- 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/utils/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.js +3 -0
- 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 +3 -2
- 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 +4 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.d.ts +20 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.js +24 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/field.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/field.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/field.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/field.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/helpers.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/helpers.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/helpers.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/helpers.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/index.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/index.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/mutation.create.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.create.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/mutation.create.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.create.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/mutation.delete.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.delete.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/mutation.delete.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.delete.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/mutation.update.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.update.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/mutation.update.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.update.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.d.ts +6 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/query.js +28 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/search.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/search.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/search.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/search.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.d.ts +3 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/subscriptions.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.d.ts +20 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.js +24 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.d.ts +13 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.js +157 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.d.ts +5 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.js +21 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.d.ts +8 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.js +56 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.d.ts +8 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.js +41 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers/subscriptions.d.ts → vtl-generator/rds/resolvers/subscription.d.ts} +2 -2
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.js +18 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.d.ts +19 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.js +3 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/package.json +12 -11
- package/node_modules/@aws-amplify/graphql-default-value-transformer/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-default-value-transformer/LICENSE +201 -0
- 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 +13 -1
- 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 +9 -8
- package/node_modules/@aws-amplify/graphql-function-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-function-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-function-transformer/package.json +8 -7
- package/node_modules/@aws-amplify/graphql-http-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-http-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-http-transformer/package.json +8 -7
- package/node_modules/@aws-amplify/graphql-index-transformer/CHANGELOG.md +8 -0
- package/node_modules/@aws-amplify/graphql-index-transformer/LICENSE +201 -0
- 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/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 +4 -1
- 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 +4 -3
- 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 +20 -11
- 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 +9 -8
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/API.md +15 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/CHANGELOG.md +12 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/assets/mapping-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.d.ts +1 -0
- 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 +13 -1
- 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 +2 -1
- 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 +16 -33
- 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/graphql-name-mapping.d.ts +10 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.js +102 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.d.ts +13 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.js +81 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.d.ts +1 -0
- 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 +3 -1
- 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 +14 -13
- package/node_modules/@aws-amplify/graphql-model-transformer/API.md +15 -15
- package/node_modules/@aws-amplify/graphql-model-transformer/CHANGELOG.md +18 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.js +25 -12
- 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 +9 -2
- 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 +6 -5
- 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 +6 -5
- 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 +6 -5
- 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 +4 -3
- 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 +74 -55
- 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 +2 -1
- 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 +8 -2
- 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 +10 -3
- 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 +127 -42
- 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/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 +1 -0
- 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 +28 -1
- 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 +10 -9
- package/node_modules/@aws-amplify/graphql-predictions-transformer/CHANGELOG.md +4 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/lib/predictionsLambdaFunction.zip +0 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/package.json +8 -7
- package/node_modules/@aws-amplify/graphql-relational-transformer/CHANGELOG.md +9 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/LICENSE +201 -0
- 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 +41 -9
- 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 +35 -8
- 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 +30 -8
- 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 +3 -2
- 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/resolver/ddb-generator.d.ts +13 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.js +171 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.d.ts +4 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.js +18 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.d.ts +8 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.js +7 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.d.ts +14 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.js +115 -0
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.js.map +1 -0
- 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 +14 -161
- 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 +14 -8
- 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 +4 -0
- 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 +5 -0
- 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 +85 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/package.json +11 -10
- package/node_modules/@aws-amplify/graphql-searchable-transformer/CHANGELOG.md +6 -0
- package/node_modules/@aws-amplify/graphql-searchable-transformer/LICENSE +201 -0
- 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 +3 -0
- 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 +9 -8
- package/node_modules/@aws-amplify/graphql-sql-transformer/API.md +26 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/CHANGELOG.md +10 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/README.md +13 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.d.ts +12 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.js +132 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.d.ts +2 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.js +6 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-sql-transformer/package.json +71 -0
- package/node_modules/@aws-amplify/graphql-transformer/API.md +1 -0
- package/node_modules/@aws-amplify/graphql-transformer/CHANGELOG.md +13 -0
- package/node_modules/@aws-amplify/graphql-transformer/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.d.ts +1 -0
- 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 +5 -1
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer/package.json +16 -14
- package/node_modules/@aws-amplify/graphql-transformer/src/graphql-transformer.ts +7 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/API.md +33 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/CHANGELOG.md +17 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/project-config.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/config/project-config.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.d.ts +2 -2
- 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 +10 -1
- 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 +2 -1
- 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/transform.d.ts +2 -3
- 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 +2 -3
- 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 +1 -0
- 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/transformer-context/index.d.ts +4 -3
- 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 +2 -1
- 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 +4 -1
- 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 +3 -2
- 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 +2 -1
- 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/api-category.d.ts +2 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.js +5 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.d.ts +3 -2
- 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 +14 -3
- 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/model-util.d.ts +3 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.js +19 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.d.ts +14 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.js +82 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.d.ts +3 -1
- 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 +7 -1
- 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 +5 -4
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/API.md +20 -3
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/CHANGELOG.md +9 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/LICENSE +201 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.d.ts +5 -1
- 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.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-context-provider.d.ts +1 -0
- 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 +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-datasource-provider.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/package.json +3 -2
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/graphql-api-provider.ts +17 -3
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/index.ts +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/index.ts +2 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-context-provider.ts +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-datasource-provider.ts +8 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/tsconfig.tsbuildinfo +1 -1
- package/node_modules/graphql-mapping-template/CHANGELOG.md +4 -0
- package/node_modules/graphql-mapping-template/LICENSE +201 -0
- package/node_modules/graphql-mapping-template/package.json +3 -2
- package/node_modules/graphql-transformer-common/API.md +21 -0
- package/node_modules/graphql-transformer-common/CHANGELOG.md +11 -0
- package/node_modules/graphql-transformer-common/LICENSE +201 -0
- package/node_modules/graphql-transformer-common/lib/definition.d.ts +9 -2
- package/node_modules/graphql-transformer-common/lib/definition.d.ts.map +1 -1
- package/node_modules/graphql-transformer-common/lib/definition.js +52 -1
- 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 +3 -1
- package/node_modules/graphql-transformer-common/lib/util.js.map +1 -1
- package/node_modules/graphql-transformer-common/package.json +7 -6
- package/package.json +19 -17
- package/src/amplify-graphql-api.ts +73 -4
- package/src/amplify-graphql-definition.ts +30 -10
- package/src/index.ts +6 -0
- package/src/sql-model-datasource-binding.ts +45 -0
- package/src/types.ts +114 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/field.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/field.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/helpers.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/helpers.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.create.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.create.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.delete.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.delete.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.update.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.update.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.d.ts +0 -6
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/search.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/search.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/subscriptions.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/subscriptions.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.d.ts +0 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.js +0 -25
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.js.map +0 -1
- /package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/index.d.ts +0 -0
- /package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{resolvers → vtl-generator/ddb/resolvers}/index.js +0 -0
package/README.md
CHANGED
@@ -165,6 +165,7 @@ 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
|
+
|
168
169
|
`resources.<ResourceType>.<ResourceName>` - you can then perform any CDK action on these resulting resoureces.
|
169
170
|
|
170
171
|
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer"></a>
|
@@ -175,17 +176,17 @@ import { AmplifyGraphqlApi } from '@aws-amplify/graphql-api-construct'
|
|
175
176
|
new AmplifyGraphqlApi(scope: Construct, id: string, props: AmplifyGraphqlApiProps)
|
176
177
|
```
|
177
178
|
|
178
|
-
| **Name**
|
179
|
-
|
|
180
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code>
|
181
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id">id</a></code>
|
179
|
+
| **Name** | **Type** | **Description** |
|
180
|
+
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- |
|
181
|
+
| <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. |
|
182
|
+
| <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. |
|
182
183
|
| <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. |
|
183
184
|
|
184
185
|
---
|
185
186
|
|
186
187
|
##### `scope`<sup>Required</sup> <a name="scope" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope"></a>
|
187
188
|
|
188
|
-
-
|
189
|
+
- _Type:_ constructs.Construct
|
189
190
|
|
190
191
|
the scope to create this construct within.
|
191
192
|
|
@@ -193,7 +194,7 @@ the scope to create this construct within.
|
|
193
194
|
|
194
195
|
##### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id"></a>
|
195
196
|
|
196
|
-
-
|
197
|
+
- _Type:_ string
|
197
198
|
|
198
199
|
the id to use for this api.
|
199
200
|
|
@@ -201,7 +202,7 @@ the id to use for this api.
|
|
201
202
|
|
202
203
|
##### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.props"></a>
|
203
204
|
|
204
|
-
-
|
205
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps">AmplifyGraphqlApiProps</a>
|
205
206
|
|
206
207
|
the properties used to configure the generated api.
|
207
208
|
|
@@ -209,19 +210,19 @@ the properties used to configure the generated api.
|
|
209
210
|
|
210
211
|
#### Methods <a name="Methods" id="Methods"></a>
|
211
212
|
|
212
|
-
| **Name**
|
213
|
-
|
|
214
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.toString">toString</a></code>
|
215
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource">addDynamoDbDataSource</a></code>
|
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>
|
218
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction">addFunction</a></code>
|
219
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource">addHttpDataSource</a></code>
|
220
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource">addLambdaDataSource</a></code>
|
221
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource">addNoneDataSource</a></code>
|
222
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource">addOpenSearchDataSource</a></code>
|
223
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource">addRdsDataSource</a></code>
|
224
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver">addResolver</a></code>
|
213
|
+
| **Name** | **Description** |
|
214
|
+
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
|
215
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.toString">toString</a></code> | Returns a string representation of this construct. |
|
216
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource">addDynamoDbDataSource</a></code> | Add a new DynamoDB data source to this API. |
|
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> | Add an EventBridge data source to this api. |
|
219
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction">addFunction</a></code> | Add an appsync function to the api. |
|
220
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource">addHttpDataSource</a></code> | Add a new http data source to this API. |
|
221
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource">addLambdaDataSource</a></code> | Add a new Lambda data source to this API. |
|
222
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource">addNoneDataSource</a></code> | Add a new dummy data source to this API. |
|
223
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource">addOpenSearchDataSource</a></code> | dd a new OpenSearch data source to this API. |
|
224
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource">addRdsDataSource</a></code> | Add a new Rds data source to this API. |
|
225
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver">addResolver</a></code> | Add a resolver to the api. |
|
225
226
|
|
226
227
|
---
|
227
228
|
|
@@ -245,7 +246,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
245
246
|
|
246
247
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.id"></a>
|
247
248
|
|
248
|
-
-
|
249
|
+
- _Type:_ string
|
249
250
|
|
250
251
|
The data source's id.
|
251
252
|
|
@@ -253,7 +254,7 @@ The data source's id.
|
|
253
254
|
|
254
255
|
###### `table`<sup>Required</sup> <a name="table" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.table"></a>
|
255
256
|
|
256
|
-
-
|
257
|
+
- _Type:_ aws-cdk-lib.aws_dynamodb.ITable
|
257
258
|
|
258
259
|
The DynamoDB table backing this data source.
|
259
260
|
|
@@ -261,7 +262,7 @@ The DynamoDB table backing this data source.
|
|
261
262
|
|
262
263
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.options"></a>
|
263
264
|
|
264
|
-
-
|
265
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
265
266
|
|
266
267
|
The optional configuration for this data source.
|
267
268
|
|
@@ -279,7 +280,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
279
280
|
|
280
281
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.id"></a>
|
281
282
|
|
282
|
-
-
|
283
|
+
- _Type:_ string
|
283
284
|
|
284
285
|
The data source's id.
|
285
286
|
|
@@ -287,7 +288,7 @@ The data source's id.
|
|
287
288
|
|
288
289
|
###### `domain`<sup>Required</sup> <a name="domain" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.domain"></a>
|
289
290
|
|
290
|
-
-
|
291
|
+
- _Type:_ aws-cdk-lib.aws_elasticsearch.IDomain
|
291
292
|
|
292
293
|
The elasticsearch domain for this data source.
|
293
294
|
|
@@ -295,7 +296,7 @@ The elasticsearch domain for this data source.
|
|
295
296
|
|
296
297
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.options"></a>
|
297
298
|
|
298
|
-
-
|
299
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
299
300
|
|
300
301
|
The optional configuration for this data source.
|
301
302
|
|
@@ -313,7 +314,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
313
314
|
|
314
315
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.id"></a>
|
315
316
|
|
316
|
-
-
|
317
|
+
- _Type:_ string
|
317
318
|
|
318
319
|
The data source's id.
|
319
320
|
|
@@ -321,7 +322,7 @@ The data source's id.
|
|
321
322
|
|
322
323
|
###### `eventBus`<sup>Required</sup> <a name="eventBus" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.eventBus"></a>
|
323
324
|
|
324
|
-
-
|
325
|
+
- _Type:_ aws-cdk-lib.aws_events.IEventBus
|
325
326
|
|
326
327
|
The EventBridge EventBus on which to put events.
|
327
328
|
|
@@ -329,7 +330,7 @@ The EventBridge EventBus on which to put events.
|
|
329
330
|
|
330
331
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.options"></a>
|
331
332
|
|
332
|
-
-
|
333
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
333
334
|
|
334
335
|
The optional configuration for this data source.
|
335
336
|
|
@@ -345,7 +346,7 @@ Add an appsync function to the api.
|
|
345
346
|
|
346
347
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction.parameter.id"></a>
|
347
348
|
|
348
|
-
-
|
349
|
+
- _Type:_ string
|
349
350
|
|
350
351
|
the function's id.
|
351
352
|
|
@@ -353,7 +354,7 @@ the function's id.
|
|
353
354
|
|
354
355
|
###### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction.parameter.props"></a>
|
355
356
|
|
356
|
-
-
|
357
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.AddFunctionProps">AddFunctionProps</a>
|
357
358
|
|
358
359
|
---
|
359
360
|
|
@@ -369,7 +370,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
369
370
|
|
370
371
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.id"></a>
|
371
372
|
|
372
|
-
-
|
373
|
+
- _Type:_ string
|
373
374
|
|
374
375
|
The data source's id.
|
375
376
|
|
@@ -377,7 +378,7 @@ The data source's id.
|
|
377
378
|
|
378
379
|
###### `endpoint`<sup>Required</sup> <a name="endpoint" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.endpoint"></a>
|
379
380
|
|
380
|
-
-
|
381
|
+
- _Type:_ string
|
381
382
|
|
382
383
|
The http endpoint.
|
383
384
|
|
@@ -385,7 +386,7 @@ The http endpoint.
|
|
385
386
|
|
386
387
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.options"></a>
|
387
388
|
|
388
|
-
-
|
389
|
+
- _Type:_ aws-cdk-lib.aws_appsync.HttpDataSourceOptions
|
389
390
|
|
390
391
|
The optional configuration for this data source.
|
391
392
|
|
@@ -403,7 +404,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
403
404
|
|
404
405
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.id"></a>
|
405
406
|
|
406
|
-
-
|
407
|
+
- _Type:_ string
|
407
408
|
|
408
409
|
The data source's id.
|
409
410
|
|
@@ -411,7 +412,7 @@ The data source's id.
|
|
411
412
|
|
412
413
|
###### `lambdaFunction`<sup>Required</sup> <a name="lambdaFunction" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.lambdaFunction"></a>
|
413
414
|
|
414
|
-
-
|
415
|
+
- _Type:_ aws-cdk-lib.aws_lambda.IFunction
|
415
416
|
|
416
417
|
The Lambda function to call to interact with this data source.
|
417
418
|
|
@@ -419,7 +420,7 @@ The Lambda function to call to interact with this data source.
|
|
419
420
|
|
420
421
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.options"></a>
|
421
422
|
|
422
|
-
-
|
423
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
423
424
|
|
424
425
|
The optional configuration for this data source.
|
425
426
|
|
@@ -438,7 +439,7 @@ Useful for pipeline resolvers and for backend changes that don't require a data
|
|
438
439
|
|
439
440
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource.parameter.id"></a>
|
440
441
|
|
441
|
-
-
|
442
|
+
- _Type:_ string
|
442
443
|
|
443
444
|
The data source's id.
|
444
445
|
|
@@ -446,7 +447,7 @@ The data source's id.
|
|
446
447
|
|
447
448
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource.parameter.options"></a>
|
448
449
|
|
449
|
-
-
|
450
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
450
451
|
|
451
452
|
The optional configuration for this data source.
|
452
453
|
|
@@ -464,7 +465,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
464
465
|
|
465
466
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.id"></a>
|
466
467
|
|
467
|
-
-
|
468
|
+
- _Type:_ string
|
468
469
|
|
469
470
|
The data source's id.
|
470
471
|
|
@@ -472,7 +473,7 @@ The data source's id.
|
|
472
473
|
|
473
474
|
###### `domain`<sup>Required</sup> <a name="domain" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.domain"></a>
|
474
475
|
|
475
|
-
-
|
476
|
+
- _Type:_ aws-cdk-lib.aws_opensearchservice.IDomain
|
476
477
|
|
477
478
|
The OpenSearch domain for this data source.
|
478
479
|
|
@@ -480,7 +481,7 @@ The OpenSearch domain for this data source.
|
|
480
481
|
|
481
482
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.options"></a>
|
482
483
|
|
483
|
-
-
|
484
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
484
485
|
|
485
486
|
The optional configuration for this data source.
|
486
487
|
|
@@ -498,7 +499,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
498
499
|
|
499
500
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.id"></a>
|
500
501
|
|
501
|
-
-
|
502
|
+
- _Type:_ string
|
502
503
|
|
503
504
|
The data source's id.
|
504
505
|
|
@@ -506,7 +507,7 @@ The data source's id.
|
|
506
507
|
|
507
508
|
###### `serverlessCluster`<sup>Required</sup> <a name="serverlessCluster" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.serverlessCluster"></a>
|
508
509
|
|
509
|
-
-
|
510
|
+
- _Type:_ aws-cdk-lib.aws_rds.IServerlessCluster
|
510
511
|
|
511
512
|
The serverless cluster to interact with this data source.
|
512
513
|
|
@@ -514,7 +515,7 @@ The serverless cluster to interact with this data source.
|
|
514
515
|
|
515
516
|
###### `secretStore`<sup>Required</sup> <a name="secretStore" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.secretStore"></a>
|
516
517
|
|
517
|
-
-
|
518
|
+
- _Type:_ aws-cdk-lib.aws_secretsmanager.ISecret
|
518
519
|
|
519
520
|
The secret store that contains the username and password for the serverless cluster.
|
520
521
|
|
@@ -522,7 +523,7 @@ The secret store that contains the username and password for the serverless clus
|
|
522
523
|
|
523
524
|
###### `databaseName`<sup>Optional</sup> <a name="databaseName" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.databaseName"></a>
|
524
525
|
|
525
|
-
-
|
526
|
+
- _Type:_ string
|
526
527
|
|
527
528
|
The optional name of the database to use within the cluster.
|
528
529
|
|
@@ -530,7 +531,7 @@ The optional name of the database to use within the cluster.
|
|
530
531
|
|
531
532
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.options"></a>
|
532
533
|
|
533
|
-
-
|
534
|
+
- _Type:_ aws-cdk-lib.aws_appsync.DataSourceOptions
|
534
535
|
|
535
536
|
The optional configuration for this data source.
|
536
537
|
|
@@ -548,7 +549,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
548
549
|
|
549
550
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver.parameter.id"></a>
|
550
551
|
|
551
|
-
-
|
552
|
+
- _Type:_ string
|
552
553
|
|
553
554
|
The resolver's id.
|
554
555
|
|
@@ -556,7 +557,7 @@ The resolver's id.
|
|
556
557
|
|
557
558
|
###### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver.parameter.props"></a>
|
558
559
|
|
559
|
-
-
|
560
|
+
- _Type:_ aws-cdk-lib.aws_appsync.ExtendedResolverProps
|
560
561
|
|
561
562
|
the resolver properties.
|
562
563
|
|
@@ -564,8 +565,8 @@ the resolver properties.
|
|
564
565
|
|
565
566
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
566
567
|
|
567
|
-
| **Name**
|
568
|
-
|
|
568
|
+
| **Name** | **Description** |
|
569
|
+
| -------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
569
570
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
570
571
|
|
571
572
|
---
|
@@ -582,7 +583,7 @@ Checks if `x` is a construct.
|
|
582
583
|
|
583
584
|
###### `x`<sup>Required</sup> <a name="x" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.isConstruct.parameter.x"></a>
|
584
585
|
|
585
|
-
-
|
586
|
+
- _Type:_ any
|
586
587
|
|
587
588
|
Any object.
|
588
589
|
|
@@ -595,10 +596,10 @@ Any object.
|
|
595
596
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
596
597
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiId">apiId</a></code> | <code>string</code> | Generated Api Id. |
|
597
598
|
| <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. |
|
598
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.graphqlUrl">graphqlUrl</a></code>
|
599
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.realtimeUrl">realtimeUrl</a></code>
|
600
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.resources">resources</a></code>
|
601
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiKey">apiKey</a></code>
|
599
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.graphqlUrl">graphqlUrl</a></code> | <code>string</code> | Graphql URL For the generated API. |
|
600
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.realtimeUrl">realtimeUrl</a></code> | <code>string</code> | Realtime URL For the generated API. |
|
601
|
+
| <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. |
|
602
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiKey">apiKey</a></code> | <code>string</code> | Generated Api Key if generated. |
|
602
603
|
|
603
604
|
---
|
604
605
|
|
@@ -608,7 +609,7 @@ Any object.
|
|
608
609
|
public readonly node: Node;
|
609
610
|
```
|
610
611
|
|
611
|
-
-
|
612
|
+
- _Type:_ constructs.Node
|
612
613
|
|
613
614
|
The tree node.
|
614
615
|
|
@@ -634,7 +635,7 @@ May be a CDK Token.
|
|
634
635
|
public readonly generatedFunctionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
635
636
|
```
|
636
637
|
|
637
|
-
-
|
638
|
+
- _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>[]
|
638
639
|
|
639
640
|
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.
|
640
641
|
|
@@ -646,7 +647,7 @@ Resolvers generated by the transform process, persisted on the side in order to
|
|
646
647
|
public readonly graphqlUrl: string;
|
647
648
|
```
|
648
649
|
|
649
|
-
-
|
650
|
+
- _Type:_ string
|
650
651
|
|
651
652
|
Graphql URL For the generated API.
|
652
653
|
|
@@ -660,7 +661,7 @@ May be a CDK Token.
|
|
660
661
|
public readonly realtimeUrl: string;
|
661
662
|
```
|
662
663
|
|
663
|
-
-
|
664
|
+
- _Type:_ string
|
664
665
|
|
665
666
|
Realtime URL For the generated API.
|
666
667
|
|
@@ -674,7 +675,7 @@ May be a CDK Token.
|
|
674
675
|
public readonly resources: AmplifyGraphqlApiResources;
|
675
676
|
```
|
676
677
|
|
677
|
-
-
|
678
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources">AmplifyGraphqlApiResources</a>
|
678
679
|
|
679
680
|
Generated L1 and L2 CDK resources.
|
680
681
|
|
@@ -686,7 +687,7 @@ Generated L1 and L2 CDK resources.
|
|
686
687
|
public readonly apiKey: string;
|
687
688
|
```
|
688
689
|
|
689
|
-
-
|
690
|
+
- _Type:_ string
|
690
691
|
|
691
692
|
Generated Api Key if generated.
|
692
693
|
|
@@ -694,7 +695,6 @@ May be a CDK Token.
|
|
694
695
|
|
695
696
|
---
|
696
697
|
|
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,8 +805,8 @@ 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
|
|
@@ -828,18 +828,18 @@ const amplifyGraphqlApiCfnResources: AmplifyGraphqlApiCfnResources = { ... }
|
|
828
828
|
|
829
829
|
#### Properties <a name="Properties" id="Properties"></a>
|
830
830
|
|
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>
|
831
|
+
| **Name** | **Type** | **Description** |
|
832
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
833
|
+
| <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. |
|
834
|
+
| <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. |
|
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> | <code>{[ key: string ]: aws-cdk-lib.aws_lambda.CfnFunction}</code> | The Generated Lambda Function L1 Resources, keyed by function name. |
|
837
|
+
| <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. |
|
838
|
+
| <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. |
|
839
|
+
| <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. |
|
840
|
+
| <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. |
|
841
|
+
| <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. |
|
842
|
+
| <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
843
|
|
844
844
|
---
|
845
845
|
|
@@ -849,7 +849,7 @@ const amplifyGraphqlApiCfnResources: AmplifyGraphqlApiCfnResources = { ... }
|
|
849
849
|
public readonly additionalCfnResources: {[ key: string ]: CfnResource};
|
850
850
|
```
|
851
851
|
|
852
|
-
-
|
852
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.CfnResource}
|
853
853
|
|
854
854
|
Remaining L1 resources generated, keyed by logicalId.
|
855
855
|
|
@@ -861,7 +861,7 @@ Remaining L1 resources generated, keyed by logicalId.
|
|
861
861
|
public readonly cfnDataSources: {[ key: string ]: CfnDataSource};
|
862
862
|
```
|
863
863
|
|
864
|
-
-
|
864
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_appsync.CfnDataSource}
|
865
865
|
|
866
866
|
The Generated AppSync DataSource L1 Resources, keyed by logicalId.
|
867
867
|
|
@@ -873,7 +873,7 @@ The Generated AppSync DataSource L1 Resources, keyed by logicalId.
|
|
873
873
|
public readonly cfnFunctionConfigurations: {[ key: string ]: CfnFunctionConfiguration};
|
874
874
|
```
|
875
875
|
|
876
|
-
-
|
876
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_appsync.CfnFunctionConfiguration}
|
877
877
|
|
878
878
|
The Generated AppSync Function L1 Resources, keyed by logicalId.
|
879
879
|
|
@@ -885,7 +885,7 @@ The Generated AppSync Function L1 Resources, keyed by logicalId.
|
|
885
885
|
public readonly cfnFunctions: {[ key: string ]: CfnFunction};
|
886
886
|
```
|
887
887
|
|
888
|
-
-
|
888
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_lambda.CfnFunction}
|
889
889
|
|
890
890
|
The Generated Lambda Function L1 Resources, keyed by function name.
|
891
891
|
|
@@ -897,7 +897,7 @@ The Generated Lambda Function L1 Resources, keyed by function name.
|
|
897
897
|
public readonly cfnGraphqlApi: CfnGraphQLApi;
|
898
898
|
```
|
899
899
|
|
900
|
-
-
|
900
|
+
- _Type:_ aws-cdk-lib.aws_appsync.CfnGraphQLApi
|
901
901
|
|
902
902
|
The Generated AppSync Api L1 Resource.
|
903
903
|
|
@@ -909,7 +909,7 @@ The Generated AppSync Api L1 Resource.
|
|
909
909
|
public readonly cfnGraphqlSchema: CfnGraphQLSchema;
|
910
910
|
```
|
911
911
|
|
912
|
-
-
|
912
|
+
- _Type:_ aws-cdk-lib.aws_appsync.CfnGraphQLSchema
|
913
913
|
|
914
914
|
The Generated AppSync Schema L1 Resource.
|
915
915
|
|
@@ -921,7 +921,7 @@ The Generated AppSync Schema L1 Resource.
|
|
921
921
|
public readonly cfnResolvers: {[ key: string ]: CfnResolver};
|
922
922
|
```
|
923
923
|
|
924
|
-
-
|
924
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_appsync.CfnResolver}
|
925
925
|
|
926
926
|
The Generated AppSync Resolver L1 Resources, keyed by logicalId.
|
927
927
|
|
@@ -933,7 +933,7 @@ The Generated AppSync Resolver L1 Resources, keyed by logicalId.
|
|
933
933
|
public readonly cfnRoles: {[ key: string ]: CfnRole};
|
934
934
|
```
|
935
935
|
|
936
|
-
-
|
936
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_iam.CfnRole}
|
937
937
|
|
938
938
|
The Generated IAM Role L1 Resources, keyed by logicalId.
|
939
939
|
|
@@ -945,7 +945,7 @@ The Generated IAM Role L1 Resources, keyed by logicalId.
|
|
945
945
|
public readonly cfnTables: {[ key: string ]: CfnTable};
|
946
946
|
```
|
947
947
|
|
948
|
-
-
|
948
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_dynamodb.CfnTable}
|
949
949
|
|
950
950
|
The Generated DynamoDB Table L1 Resources, keyed by logicalId.
|
951
951
|
|
@@ -957,7 +957,7 @@ The Generated DynamoDB Table L1 Resources, keyed by logicalId.
|
|
957
957
|
public readonly cfnApiKey: CfnApiKey;
|
958
958
|
```
|
959
959
|
|
960
|
-
-
|
960
|
+
- _Type:_ aws-cdk-lib.aws_appsync.CfnApiKey
|
961
961
|
|
962
962
|
The Generated AppSync Api Key L1 Resource.
|
963
963
|
|
@@ -980,19 +980,19 @@ const amplifyGraphqlApiProps: AmplifyGraphqlApiProps = { ... }
|
|
980
980
|
|
981
981
|
#### Properties <a name="Properties" id="Properties"></a>
|
982
982
|
|
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>
|
983
|
+
| **Name** | **Type** | **Description** |
|
984
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
985
|
+
| <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. |
|
986
|
+
| <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. |
|
987
|
+
| <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. |
|
988
|
+
| <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. |
|
989
|
+
| <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. |
|
990
|
+
| <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. |
|
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> | Strategy to store construct outputs. |
|
992
|
+
| <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. |
|
993
|
+
| <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. |
|
994
|
+
| <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. |
|
995
|
+
| <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
996
|
|
997
997
|
---
|
998
998
|
|
@@ -1002,7 +1002,7 @@ const amplifyGraphqlApiProps: AmplifyGraphqlApiProps = { ... }
|
|
1002
1002
|
public readonly authorizationModes: AuthorizationModes;
|
1003
1003
|
```
|
1004
1004
|
|
1005
|
-
-
|
1005
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.AuthorizationModes">AuthorizationModes</a>
|
1006
1006
|
|
1007
1007
|
Required auth modes for the Api.
|
1008
1008
|
|
@@ -1017,7 +1017,7 @@ For more information, refer to https://docs.amplify.aws/cli/graphql/authorizatio
|
|
1017
1017
|
public readonly definition: IAmplifyGraphqlDefinition;
|
1018
1018
|
```
|
1019
1019
|
|
1020
|
-
-
|
1020
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>
|
1021
1021
|
|
1022
1022
|
The definition to transform in a full Api.
|
1023
1023
|
|
@@ -1031,7 +1031,7 @@ Can be constructed via the AmplifyGraphqlDefinition class.
|
|
1031
1031
|
public readonly apiName: string;
|
1032
1032
|
```
|
1033
1033
|
|
1034
|
-
-
|
1034
|
+
- _Type:_ string
|
1035
1035
|
|
1036
1036
|
Name to be used for the AppSync Api.
|
1037
1037
|
|
@@ -1045,7 +1045,7 @@ Default: construct id.
|
|
1045
1045
|
public readonly conflictResolution: ConflictResolution;
|
1046
1046
|
```
|
1047
1047
|
|
1048
|
-
-
|
1048
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.ConflictResolution">ConflictResolution</a>
|
1049
1049
|
|
1050
1050
|
Configure conflict resolution on the Api, which is required to enable DataStore Api functionality.
|
1051
1051
|
|
@@ -1059,7 +1059,7 @@ For more information, refer to https://docs.amplify.aws/lib/datastore/getting-st
|
|
1059
1059
|
public readonly functionNameMap: {[ key: string ]: IFunction};
|
1060
1060
|
```
|
1061
1061
|
|
1062
|
-
-
|
1062
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}
|
1063
1063
|
|
1064
1064
|
Lambda functions referenced in the definitions's.
|
1065
1065
|
|
@@ -1071,7 +1071,7 @@ Lambda functions referenced in the definitions's.
|
|
1071
1071
|
public readonly functionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
1072
1072
|
```
|
1073
1073
|
|
1074
|
-
-
|
1074
|
+
- _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
1075
|
|
1076
1076
|
Overrides for a given slot in the generated resolver pipelines.
|
1077
1077
|
|
@@ -1086,7 +1086,7 @@ refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#override-am
|
|
1086
1086
|
public readonly outputStorageStrategy: IBackendOutputStorageStrategy;
|
1087
1087
|
```
|
1088
1088
|
|
1089
|
-
-
|
1089
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a>
|
1090
1090
|
|
1091
1091
|
Strategy to store construct outputs.
|
1092
1092
|
|
@@ -1100,7 +1100,7 @@ If no outputStorageStrategey is provided a default strategy will be used.
|
|
1100
1100
|
public readonly predictionsBucket: IBucket;
|
1101
1101
|
```
|
1102
1102
|
|
1103
|
-
-
|
1103
|
+
- _Type:_ aws-cdk-lib.aws_s3.IBucket
|
1104
1104
|
|
1105
1105
|
If using predictions, a bucket must be provided which will be used to search for assets.
|
1106
1106
|
|
@@ -1112,7 +1112,7 @@ If using predictions, a bucket must be provided which will be used to search for
|
|
1112
1112
|
public readonly stackMappings: {[ key: string ]: string};
|
1113
1113
|
```
|
1114
1114
|
|
1115
|
-
-
|
1115
|
+
- _Type:_ {[ key: string ]: string}
|
1116
1116
|
|
1117
1117
|
StackMappings override the assigned nested stack on a per-resource basis.
|
1118
1118
|
|
@@ -1130,7 +1130,7 @@ then re-added from a new stack.
|
|
1130
1130
|
public readonly transformerPlugins: any[];
|
1131
1131
|
```
|
1132
1132
|
|
1133
|
-
-
|
1133
|
+
- _Type:_ any[]
|
1134
1134
|
|
1135
1135
|
Provide a list of additional custom transformers which are injected into the transform process.
|
1136
1136
|
|
@@ -1144,7 +1144,7 @@ These custom transformers must be implemented with aws-cdk-lib >=2.80.0, and
|
|
1144
1144
|
public readonly translationBehavior: PartialTranslationBehavior;
|
1145
1145
|
```
|
1146
1146
|
|
1147
|
-
-
|
1147
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior">PartialTranslationBehavior</a>
|
1148
1148
|
|
1149
1149
|
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
1150
|
|
@@ -1166,14 +1166,14 @@ const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }
|
|
1166
1166
|
|
1167
1167
|
#### Properties <a name="Properties" id="Properties"></a>
|
1168
1168
|
|
1169
|
-
| **Name**
|
1170
|
-
|
|
1169
|
+
| **Name** | **Type** | **Description** |
|
1170
|
+
| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
1171
1171
|
| <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>
|
1172
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources.property.functions">functions</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}</code> | The Generated Lambda Function L1 Resources, keyed by function name. |
|
1173
|
+
| <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. |
|
1174
|
+
| <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. |
|
1175
|
+
| <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. |
|
1176
|
+
| <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. |
|
1177
1177
|
|
1178
1178
|
---
|
1179
1179
|
|
@@ -1183,7 +1183,7 @@ const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }
|
|
1183
1183
|
public readonly cfnResources: AmplifyGraphqlApiCfnResources;
|
1184
1184
|
```
|
1185
1185
|
|
1186
|
-
-
|
1186
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiCfnResources">AmplifyGraphqlApiCfnResources</a>
|
1187
1187
|
|
1188
1188
|
L1 Cfn Resources, for when dipping down a level of abstraction is desirable.
|
1189
1189
|
|
@@ -1195,7 +1195,7 @@ L1 Cfn Resources, for when dipping down a level of abstraction is desirable.
|
|
1195
1195
|
public readonly functions: {[ key: string ]: IFunction};
|
1196
1196
|
```
|
1197
1197
|
|
1198
|
-
-
|
1198
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}
|
1199
1199
|
|
1200
1200
|
The Generated Lambda Function L1 Resources, keyed by function name.
|
1201
1201
|
|
@@ -1207,7 +1207,7 @@ The Generated Lambda Function L1 Resources, keyed by function name.
|
|
1207
1207
|
public readonly graphqlApi: IGraphqlApi;
|
1208
1208
|
```
|
1209
1209
|
|
1210
|
-
-
|
1210
|
+
- _Type:_ aws-cdk-lib.aws_appsync.IGraphqlApi
|
1211
1211
|
|
1212
1212
|
The Generated AppSync Api L2 Resource, includes the Schema.
|
1213
1213
|
|
@@ -1219,7 +1219,7 @@ The Generated AppSync Api L2 Resource, includes the Schema.
|
|
1219
1219
|
public readonly nestedStacks: {[ key: string ]: NestedStack};
|
1220
1220
|
```
|
1221
1221
|
|
1222
|
-
-
|
1222
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.NestedStack}
|
1223
1223
|
|
1224
1224
|
Nested Stacks generated by the Api Construct.
|
1225
1225
|
|
@@ -1231,7 +1231,7 @@ Nested Stacks generated by the Api Construct.
|
|
1231
1231
|
public readonly roles: {[ key: string ]: IRole};
|
1232
1232
|
```
|
1233
1233
|
|
1234
|
-
-
|
1234
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_iam.IRole}
|
1235
1235
|
|
1236
1236
|
The Generated IAM Role L2 Resources, keyed by logicalId.
|
1237
1237
|
|
@@ -1243,7 +1243,7 @@ The Generated IAM Role L2 Resources, keyed by logicalId.
|
|
1243
1243
|
public readonly tables: {[ key: string ]: ITable};
|
1244
1244
|
```
|
1245
1245
|
|
1246
|
-
-
|
1246
|
+
- _Type:_ {[ key: string ]: aws-cdk-lib.aws_dynamodb.ITable}
|
1247
1247
|
|
1248
1248
|
The Generated DynamoDB Table L2 Resources, keyed by logicalId.
|
1249
1249
|
|
@@ -1263,10 +1263,10 @@ const apiKeyAuthorizationConfig: ApiKeyAuthorizationConfig = { ... }
|
|
1263
1263
|
|
1264
1264
|
#### Properties <a name="Properties" id="Properties"></a>
|
1265
1265
|
|
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>
|
1266
|
+
| **Name** | **Type** | **Description** |
|
1267
|
+
| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------------------- |
|
1268
|
+
| <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. |
|
1269
|
+
| <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
1270
|
|
1271
1271
|
---
|
1272
1272
|
|
@@ -1276,7 +1276,7 @@ const apiKeyAuthorizationConfig: ApiKeyAuthorizationConfig = { ... }
|
|
1276
1276
|
public readonly expires: Duration;
|
1277
1277
|
```
|
1278
1278
|
|
1279
|
-
-
|
1279
|
+
- _Type:_ aws-cdk-lib.Duration
|
1280
1280
|
|
1281
1281
|
A duration representing the time from Cloudformation deploy until expiry.
|
1282
1282
|
|
@@ -1288,7 +1288,7 @@ A duration representing the time from Cloudformation deploy until expiry.
|
|
1288
1288
|
public readonly description: string;
|
1289
1289
|
```
|
1290
1290
|
|
1291
|
-
-
|
1291
|
+
- _Type:_ string
|
1292
1292
|
|
1293
1293
|
Optional description for the Api Key to attach to the Api.
|
1294
1294
|
|
@@ -1311,15 +1311,15 @@ const authorizationModes: AuthorizationModes = { ... }
|
|
1311
1311
|
|
1312
1312
|
#### Properties <a name="Properties" id="Properties"></a>
|
1313
1313
|
|
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>
|
1314
|
+
| **Name** | **Type** | **Description** |
|
1315
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
1316
|
+
| <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. |
|
1317
|
+
| <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. |
|
1318
|
+
| <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. |
|
1319
|
+
| <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. |
|
1320
|
+
| <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. |
|
1321
|
+
| <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. |
|
1322
|
+
| <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
1323
|
|
1324
1324
|
---
|
1325
1325
|
|
@@ -1329,7 +1329,7 @@ const authorizationModes: AuthorizationModes = { ... }
|
|
1329
1329
|
public readonly adminRoles: IRole[];
|
1330
1330
|
```
|
1331
1331
|
|
1332
|
-
-
|
1332
|
+
- _Type:_ aws-cdk-lib.aws_iam.IRole[]
|
1333
1333
|
|
1334
1334
|
A list of roles granted full R/W access to the Api.
|
1335
1335
|
|
@@ -1341,7 +1341,7 @@ A list of roles granted full R/W access to the Api.
|
|
1341
1341
|
public readonly apiKeyConfig: ApiKeyAuthorizationConfig;
|
1342
1342
|
```
|
1343
1343
|
|
1344
|
-
-
|
1344
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig">ApiKeyAuthorizationConfig</a>
|
1345
1345
|
|
1346
1346
|
AppSync Api Key config, required if a 'apiKey' auth provider is specified in the Api.
|
1347
1347
|
|
@@ -1355,7 +1355,7 @@ Applies to 'public' auth strategy.
|
|
1355
1355
|
public readonly defaultAuthorizationMode: string;
|
1356
1356
|
```
|
1357
1357
|
|
1358
|
-
-
|
1358
|
+
- _Type:_ string
|
1359
1359
|
|
1360
1360
|
Default auth mode to provide to the Api, required if more than one config type is specified.
|
1361
1361
|
|
@@ -1367,7 +1367,7 @@ Default auth mode to provide to the Api, required if more than one config type i
|
|
1367
1367
|
public readonly iamConfig: IAMAuthorizationConfig;
|
1368
1368
|
```
|
1369
1369
|
|
1370
|
-
-
|
1370
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig">IAMAuthorizationConfig</a>
|
1371
1371
|
|
1372
1372
|
IAM Auth config, required if an 'iam' auth provider is specified in the Api.
|
1373
1373
|
|
@@ -1381,7 +1381,7 @@ Applies to 'public' and 'private' auth strategies.
|
|
1381
1381
|
public readonly lambdaConfig: LambdaAuthorizationConfig;
|
1382
1382
|
```
|
1383
1383
|
|
1384
|
-
-
|
1384
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig">LambdaAuthorizationConfig</a>
|
1385
1385
|
|
1386
1386
|
Lambda config, required if a 'function' auth provider is specified in the Api.
|
1387
1387
|
|
@@ -1395,7 +1395,7 @@ Applies to 'custom' auth strategy.
|
|
1395
1395
|
public readonly oidcConfig: OIDCAuthorizationConfig;
|
1396
1396
|
```
|
1397
1397
|
|
1398
|
-
-
|
1398
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig">OIDCAuthorizationConfig</a>
|
1399
1399
|
|
1400
1400
|
Cognito OIDC config, required if a 'oidc' auth provider is specified in the Api.
|
1401
1401
|
|
@@ -1409,7 +1409,7 @@ Applies to 'owner', 'private', and 'group' auth strategies.
|
|
1409
1409
|
public readonly userPoolConfig: UserPoolAuthorizationConfig;
|
1410
1410
|
```
|
1411
1411
|
|
1412
|
-
-
|
1412
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.UserPoolAuthorizationConfig">UserPoolAuthorizationConfig</a>
|
1413
1413
|
|
1414
1414
|
Cognito UserPool config, required if a 'userPools' auth provider is specified in the Api.
|
1415
1415
|
|
@@ -1431,10 +1431,10 @@ const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy =
|
|
1431
1431
|
|
1432
1432
|
#### Properties <a name="Properties" id="Properties"></a>
|
1433
1433
|
|
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>
|
1434
|
+
| **Name** | **Type** | **Description** |
|
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> | <code>string</code> | This conflict resolution strategy executes an auto-merge. |
|
1438
1438
|
|
1439
1439
|
---
|
1440
1440
|
|
@@ -1444,7 +1444,7 @@ const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy =
|
|
1444
1444
|
public readonly detectionType: string;
|
1445
1445
|
```
|
1446
1446
|
|
1447
|
-
-
|
1447
|
+
- _Type:_ string
|
1448
1448
|
|
1449
1449
|
The conflict detection type used for resolution.
|
1450
1450
|
|
@@ -1456,7 +1456,7 @@ The conflict detection type used for resolution.
|
|
1456
1456
|
public readonly handlerType: string;
|
1457
1457
|
```
|
1458
1458
|
|
1459
|
-
-
|
1459
|
+
- _Type:_ string
|
1460
1460
|
|
1461
1461
|
This conflict resolution strategy executes an auto-merge.
|
1462
1462
|
|
@@ -1478,10 +1478,10 @@ const conflictResolution: ConflictResolution = { ... }
|
|
1478
1478
|
|
1479
1479
|
#### Properties <a name="Properties" id="Properties"></a>
|
1480
1480
|
|
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>
|
1481
|
+
| **Name** | **Type** | **Description** |
|
1482
|
+
| ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
|
1483
|
+
| <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. |
|
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> | Project-wide config for conflict resolution. |
|
1485
1485
|
|
1486
1486
|
---
|
1487
1487
|
|
@@ -1491,7 +1491,7 @@ const conflictResolution: ConflictResolution = { ... }
|
|
1491
1491
|
public readonly models: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy};
|
1492
1492
|
```
|
1493
1493
|
|
1494
|
-
-
|
1494
|
+
- _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
1495
|
|
1496
1496
|
Model-specific conflict resolution overrides.
|
1497
1497
|
|
@@ -1503,7 +1503,7 @@ Model-specific conflict resolution overrides.
|
|
1503
1503
|
public readonly project: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy;
|
1504
1504
|
```
|
1505
1505
|
|
1506
|
-
-
|
1506
|
+
- _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
1507
|
|
1508
1508
|
Project-wide config for conflict resolution.
|
1509
1509
|
|
@@ -1525,8 +1525,8 @@ const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }
|
|
1525
1525
|
|
1526
1526
|
#### Properties <a name="Properties" id="Properties"></a>
|
1527
1527
|
|
1528
|
-
| **Name**
|
1529
|
-
|
|
1528
|
+
| **Name** | **Type** | **Description** |
|
1529
|
+
| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------ |
|
1530
1530
|
| <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
1531
|
|
1532
1532
|
---
|
@@ -1537,7 +1537,7 @@ const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }
|
|
1537
1537
|
public readonly detectionType: string;
|
1538
1538
|
```
|
1539
1539
|
|
1540
|
-
-
|
1540
|
+
- _Type:_ string
|
1541
1541
|
|
1542
1542
|
The conflict detection type used for resolution.
|
1543
1543
|
|
@@ -1557,11 +1557,11 @@ const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ...
|
|
1557
1557
|
|
1558
1558
|
#### Properties <a name="Properties" id="Properties"></a>
|
1559
1559
|
|
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>
|
1560
|
+
| **Name** | **Type** | **Description** |
|
1561
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------- |
|
1562
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
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> | <code>string</code> | This conflict resolution strategy uses a lambda handler type. |
|
1565
1565
|
|
1566
1566
|
---
|
1567
1567
|
|
@@ -1571,7 +1571,7 @@ const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ...
|
|
1571
1571
|
public readonly detectionType: string;
|
1572
1572
|
```
|
1573
1573
|
|
1574
|
-
-
|
1574
|
+
- _Type:_ string
|
1575
1575
|
|
1576
1576
|
The conflict detection type used for resolution.
|
1577
1577
|
|
@@ -1583,7 +1583,7 @@ The conflict detection type used for resolution.
|
|
1583
1583
|
public readonly conflictHandler: IFunction;
|
1584
1584
|
```
|
1585
1585
|
|
1586
|
-
-
|
1586
|
+
- _Type:_ aws-cdk-lib.aws_lambda.IFunction
|
1587
1587
|
|
1588
1588
|
The function which will be invoked for conflict resolution.
|
1589
1589
|
|
@@ -1595,7 +1595,7 @@ The function which will be invoked for conflict resolution.
|
|
1595
1595
|
public readonly handlerType: string;
|
1596
1596
|
```
|
1597
1597
|
|
1598
|
-
-
|
1598
|
+
- _Type:_ string
|
1599
1599
|
|
1600
1600
|
This conflict resolution strategy uses a lambda handler type.
|
1601
1601
|
|
@@ -1617,11 +1617,11 @@ const functionSlotBase: FunctionSlotBase = { ... }
|
|
1617
1617
|
|
1618
1618
|
#### Properties <a name="Properties" id="Properties"></a>
|
1619
1619
|
|
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>
|
1620
|
+
| **Name** | **Type** | **Description** |
|
1621
|
+
| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
1622
|
+
| <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. |
|
1623
|
+
| <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. |
|
1624
|
+
| <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
1625
|
|
1626
1626
|
---
|
1627
1627
|
|
@@ -1631,7 +1631,7 @@ const functionSlotBase: FunctionSlotBase = { ... }
|
|
1631
1631
|
public readonly fieldName: string;
|
1632
1632
|
```
|
1633
1633
|
|
1634
|
-
-
|
1634
|
+
- _Type:_ string
|
1635
1635
|
|
1636
1636
|
The field to attach this function to on the Api definition.
|
1637
1637
|
|
@@ -1643,7 +1643,7 @@ The field to attach this function to on the Api definition.
|
|
1643
1643
|
public readonly function: FunctionSlotOverride;
|
1644
1644
|
```
|
1645
1645
|
|
1646
|
-
-
|
1646
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
1647
1647
|
|
1648
1648
|
The overridden behavior for this slot.
|
1649
1649
|
|
@@ -1655,7 +1655,7 @@ The overridden behavior for this slot.
|
|
1655
1655
|
public readonly slotIndex: number;
|
1656
1656
|
```
|
1657
1657
|
|
1658
|
-
-
|
1658
|
+
- _Type:_ number
|
1659
1659
|
|
1660
1660
|
The slot index to use to inject this into the execution pipeline.
|
1661
1661
|
|
@@ -1680,9 +1680,9 @@ const functionSlotOverride: FunctionSlotOverride = { ... }
|
|
1680
1680
|
|
1681
1681
|
#### Properties <a name="Properties" id="Properties"></a>
|
1682
1682
|
|
1683
|
-
| **Name**
|
1684
|
-
|
|
1685
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride.property.requestMappingTemplate">requestMappingTemplate</a></code>
|
1683
|
+
| **Name** | **Type** | **Description** |
|
1684
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------- |
|
1685
|
+
| <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
1686
|
| <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
1687
|
|
1688
1688
|
---
|
@@ -1693,7 +1693,7 @@ const functionSlotOverride: FunctionSlotOverride = { ... }
|
|
1693
1693
|
public readonly requestMappingTemplate: MappingTemplate;
|
1694
1694
|
```
|
1695
1695
|
|
1696
|
-
-
|
1696
|
+
- _Type:_ aws-cdk-lib.aws_appsync.MappingTemplate
|
1697
1697
|
|
1698
1698
|
Override request mapping template for the function slot.
|
1699
1699
|
|
@@ -1707,7 +1707,7 @@ Executed before the datasource is invoked.
|
|
1707
1707
|
public readonly responseMappingTemplate: MappingTemplate;
|
1708
1708
|
```
|
1709
1709
|
|
1710
|
-
-
|
1710
|
+
- _Type:_ aws-cdk-lib.aws_appsync.MappingTemplate
|
1711
1711
|
|
1712
1712
|
Override response mapping template for the function slot.
|
1713
1713
|
|
@@ -1729,10 +1729,10 @@ const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }
|
|
1729
1729
|
|
1730
1730
|
#### Properties <a name="Properties" id="Properties"></a>
|
1731
1731
|
|
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>
|
1732
|
+
| **Name** | **Type** | **Description** |
|
1733
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------ |
|
1734
|
+
| <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. |
|
1735
|
+
| <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
1736
|
| <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. |
|
1737
1737
|
|
1738
1738
|
---
|
@@ -1743,7 +1743,7 @@ const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }
|
|
1743
1743
|
public readonly authenticatedUserRole: IRole;
|
1744
1744
|
```
|
1745
1745
|
|
1746
|
-
-
|
1746
|
+
- _Type:_ aws-cdk-lib.aws_iam.IRole
|
1747
1747
|
|
1748
1748
|
Authenticated user role, applies to { provider: iam, allow: private } access.
|
1749
1749
|
|
@@ -1755,7 +1755,7 @@ Authenticated user role, applies to { provider: iam, allow: private } access.
|
|
1755
1755
|
public readonly identityPoolId: string;
|
1756
1756
|
```
|
1757
1757
|
|
1758
|
-
-
|
1758
|
+
- _Type:_ string
|
1759
1759
|
|
1760
1760
|
ID for the Cognito Identity Pool vending auth and unauth roles.
|
1761
1761
|
|
@@ -1769,7 +1769,7 @@ Format: `<region>:<id string>`
|
|
1769
1769
|
public readonly unauthenticatedUserRole: IRole;
|
1770
1770
|
```
|
1771
1771
|
|
1772
|
-
-
|
1772
|
+
- _Type:_ aws-cdk-lib.aws_iam.IRole
|
1773
1773
|
|
1774
1774
|
Unauthenticated user role, applies to { provider: iam, allow: public } access.
|
1775
1775
|
|
@@ -1789,10 +1789,10 @@ const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }
|
|
1789
1789
|
|
1790
1790
|
#### Properties <a name="Properties" id="Properties"></a>
|
1791
1791
|
|
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>
|
1792
|
+
| **Name** | **Type** | **Description** |
|
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> | <code>aws-cdk-lib.Duration</code> | How long the results are cached. |
|
1796
1796
|
|
1797
1797
|
---
|
1798
1798
|
|
@@ -1802,7 +1802,7 @@ const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }
|
|
1802
1802
|
public readonly function: IFunction;
|
1803
1803
|
```
|
1804
1804
|
|
1805
|
-
-
|
1805
|
+
- _Type:_ aws-cdk-lib.aws_lambda.IFunction
|
1806
1806
|
|
1807
1807
|
The authorizer lambda function.
|
1808
1808
|
|
@@ -1814,7 +1814,7 @@ The authorizer lambda function.
|
|
1814
1814
|
public readonly ttl: Duration;
|
1815
1815
|
```
|
1816
1816
|
|
1817
|
-
-
|
1817
|
+
- _Type:_ aws-cdk-lib.Duration
|
1818
1818
|
|
1819
1819
|
How long the results are cached.
|
1820
1820
|
|
@@ -1834,13 +1834,13 @@ const mutationFunctionSlot: MutationFunctionSlot = { ... }
|
|
1834
1834
|
|
1835
1835
|
#### Properties <a name="Properties" id="Properties"></a>
|
1836
1836
|
|
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>
|
1837
|
+
| **Name** | **Type** | **Description** |
|
1838
|
+
| ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
1839
|
+
| <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. |
|
1840
|
+
| <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. |
|
1841
|
+
| <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. |
|
1842
|
+
| <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. |
|
1843
|
+
| <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
1844
|
|
1845
1845
|
---
|
1846
1846
|
|
@@ -1850,7 +1850,7 @@ const mutationFunctionSlot: MutationFunctionSlot = { ... }
|
|
1850
1850
|
public readonly fieldName: string;
|
1851
1851
|
```
|
1852
1852
|
|
1853
|
-
-
|
1853
|
+
- _Type:_ string
|
1854
1854
|
|
1855
1855
|
The field to attach this function to on the Api definition.
|
1856
1856
|
|
@@ -1862,7 +1862,7 @@ The field to attach this function to on the Api definition.
|
|
1862
1862
|
public readonly function: FunctionSlotOverride;
|
1863
1863
|
```
|
1864
1864
|
|
1865
|
-
-
|
1865
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
1866
1866
|
|
1867
1867
|
The overridden behavior for this slot.
|
1868
1868
|
|
@@ -1874,7 +1874,7 @@ The overridden behavior for this slot.
|
|
1874
1874
|
public readonly slotIndex: number;
|
1875
1875
|
```
|
1876
1876
|
|
1877
|
-
-
|
1877
|
+
- _Type:_ number
|
1878
1878
|
|
1879
1879
|
The slot index to use to inject this into the execution pipeline.
|
1880
1880
|
|
@@ -1888,7 +1888,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
1888
1888
|
public readonly slotName: string;
|
1889
1889
|
```
|
1890
1890
|
|
1891
|
-
-
|
1891
|
+
- _Type:_ string
|
1892
1892
|
|
1893
1893
|
The slot name to inject this behavior into.
|
1894
1894
|
|
@@ -1902,7 +1902,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
1902
1902
|
public readonly typeName: string;
|
1903
1903
|
```
|
1904
1904
|
|
1905
|
-
-
|
1905
|
+
- _Type:_ string
|
1906
1906
|
|
1907
1907
|
This slot type applies to the Mutation type on the Api definition.
|
1908
1908
|
|
@@ -1922,13 +1922,13 @@ const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }
|
|
1922
1922
|
|
1923
1923
|
#### Properties <a name="Properties" id="Properties"></a>
|
1924
1924
|
|
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>
|
1925
|
+
| **Name** | **Type** | **Description** |
|
1926
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------- |
|
1927
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcIssuerUrl">oidcIssuerUrl</a></code> | <code>string</code> | Url for the OIDC token issuer. |
|
1928
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcProviderName">oidcProviderName</a></code> | <code>string</code> | The issuer for the OIDC configuration. |
|
1929
|
+
| <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. |
|
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> | <code>string</code> | The client identifier of the Relying party at the OpenID identity provider. |
|
1932
1932
|
|
1933
1933
|
---
|
1934
1934
|
|
@@ -1938,7 +1938,7 @@ const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }
|
|
1938
1938
|
public readonly oidcIssuerUrl: string;
|
1939
1939
|
```
|
1940
1940
|
|
1941
|
-
-
|
1941
|
+
- _Type:_ string
|
1942
1942
|
|
1943
1943
|
Url for the OIDC token issuer.
|
1944
1944
|
|
@@ -1950,7 +1950,7 @@ Url for the OIDC token issuer.
|
|
1950
1950
|
public readonly oidcProviderName: string;
|
1951
1951
|
```
|
1952
1952
|
|
1953
|
-
-
|
1953
|
+
- _Type:_ string
|
1954
1954
|
|
1955
1955
|
The issuer for the OIDC configuration.
|
1956
1956
|
|
@@ -1962,7 +1962,7 @@ The issuer for the OIDC configuration.
|
|
1962
1962
|
public readonly tokenExpiryFromAuth: Duration;
|
1963
1963
|
```
|
1964
1964
|
|
1965
|
-
-
|
1965
|
+
- _Type:_ aws-cdk-lib.Duration
|
1966
1966
|
|
1967
1967
|
The duration an OIDC token is valid after being authenticated by OIDC provider.
|
1968
1968
|
|
@@ -1976,7 +1976,7 @@ auth_time claim in OIDC token is required for this validation to work.
|
|
1976
1976
|
public readonly tokenExpiryFromIssue: Duration;
|
1977
1977
|
```
|
1978
1978
|
|
1979
|
-
-
|
1979
|
+
- _Type:_ aws-cdk-lib.Duration
|
1980
1980
|
|
1981
1981
|
The duration an OIDC token is valid after being issued to a user.
|
1982
1982
|
|
@@ -1990,7 +1990,7 @@ This validation uses iat claim of OIDC token.
|
|
1990
1990
|
public readonly clientId: string;
|
1991
1991
|
```
|
1992
1992
|
|
1993
|
-
-
|
1993
|
+
- _Type:_ string
|
1994
1994
|
|
1995
1995
|
The client identifier of the Relying party at the OpenID identity provider.
|
1996
1996
|
|
@@ -2012,10 +2012,10 @@ const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy
|
|
2012
2012
|
|
2013
2013
|
#### Properties <a name="Properties" id="Properties"></a>
|
2014
2014
|
|
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>
|
2015
|
+
| **Name** | **Type** | **Description** |
|
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> | <code>string</code> | This conflict resolution strategy the \_version to perform optimistic concurrency. |
|
2019
2019
|
|
2020
2020
|
---
|
2021
2021
|
|
@@ -2025,7 +2025,7 @@ const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy
|
|
2025
2025
|
public readonly detectionType: string;
|
2026
2026
|
```
|
2027
2027
|
|
2028
|
-
-
|
2028
|
+
- _Type:_ string
|
2029
2029
|
|
2030
2030
|
The conflict detection type used for resolution.
|
2031
2031
|
|
@@ -2037,9 +2037,9 @@ The conflict detection type used for resolution.
|
|
2037
2037
|
public readonly handlerType: string;
|
2038
2038
|
```
|
2039
2039
|
|
2040
|
-
-
|
2040
|
+
- _Type:_ string
|
2041
2041
|
|
2042
|
-
This conflict resolution strategy the _version to perform optimistic concurrency.
|
2042
|
+
This conflict resolution strategy the \_version to perform optimistic concurrency.
|
2043
2043
|
|
2044
2044
|
For more information, refer to https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html#conflict-detection-and-resolution
|
2045
2045
|
|
@@ -2059,19 +2059,19 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
|
|
2059
2059
|
|
2060
2060
|
#### Properties <a name="Properties" id="Properties"></a>
|
2061
2061
|
|
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>
|
2062
|
+
| **Name** | **Type** | **Description** |
|
2063
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
2064
|
+
| <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. |
|
2065
|
+
| <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. |
|
2066
|
+
| <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). |
|
2067
|
+
| <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. |
|
2068
|
+
| <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. |
|
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> | <code>boolean</code> | Enabling sandbox mode will enable api key auth on all models in the transformed schema. |
|
2071
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code> | <code>boolean</code> | If disabled, generated. |
|
2072
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code> | <code>boolean</code> | Restore parity w/ GQLv1. |
|
2073
|
+
| <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. |
|
2074
|
+
| <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
2075
|
|
2076
2076
|
---
|
2077
2077
|
|
@@ -2081,8 +2081,8 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
|
|
2081
2081
|
public readonly disableResolverDeduping: boolean;
|
2082
2082
|
```
|
2083
2083
|
|
2084
|
-
-
|
2085
|
-
-
|
2084
|
+
- _Type:_ boolean
|
2085
|
+
- _Default:_ true
|
2086
2086
|
|
2087
2087
|
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
2088
|
|
@@ -2094,8 +2094,8 @@ Disable resolver deduping, this can sometimes cause problems because dedupe orde
|
|
2094
2094
|
public readonly enableAutoIndexQueryNames: boolean;
|
2095
2095
|
```
|
2096
2096
|
|
2097
|
-
-
|
2098
|
-
-
|
2097
|
+
- _Type:_ boolean
|
2098
|
+
- _Default:_ true
|
2099
2099
|
|
2100
2100
|
Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.
|
2101
2101
|
|
@@ -2109,14 +2109,14 @@ If enabled,
|
|
2109
2109
|
public readonly enableSearchNodeToNodeEncryption: boolean;
|
2110
2110
|
```
|
2111
2111
|
|
2112
|
-
-
|
2113
|
-
-
|
2112
|
+
- _Type:_ boolean
|
2113
|
+
- _Default:_ false
|
2114
2114
|
|
2115
2115
|
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
2116
2116
|
|
2117
2117
|
Not recommended for use, prefer
|
2118
2118
|
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
2119
|
-
|
2119
|
+
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
2120
2120
|
});
|
2121
2121
|
|
2122
2122
|
---
|
@@ -2127,8 +2127,8 @@ to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain'
|
|
2127
2127
|
public readonly enableTransformerCfnOutputs: boolean;
|
2128
2128
|
```
|
2129
2129
|
|
2130
|
-
-
|
2131
|
-
-
|
2130
|
+
- _Type:_ boolean
|
2131
|
+
- _Default:_ false
|
2132
2132
|
|
2133
2133
|
When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.
|
2134
2134
|
|
@@ -2140,8 +2140,8 @@ When enabled, internal cfn outputs which existed in Amplify-generated apps will
|
|
2140
2140
|
public readonly populateOwnerFieldForStaticGroupAuth: boolean;
|
2141
2141
|
```
|
2142
2142
|
|
2143
|
-
-
|
2144
|
-
-
|
2143
|
+
- _Type:_ boolean
|
2144
|
+
- _Default:_ true
|
2145
2145
|
|
2146
2146
|
Ensure that the owner field is still populated even if a static iam or group authorization applies.
|
2147
2147
|
|
@@ -2153,8 +2153,8 @@ Ensure that the owner field is still populated even if a static iam or group aut
|
|
2153
2153
|
public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;
|
2154
2154
|
```
|
2155
2155
|
|
2156
|
-
-
|
2157
|
-
-
|
2156
|
+
- _Type:_ boolean
|
2157
|
+
- _Default:_ true
|
2158
2158
|
|
2159
2159
|
Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.
|
2160
2160
|
|
@@ -2166,8 +2166,8 @@ Enable custom primary key support, there's no good reason to disable this unless
|
|
2166
2166
|
public readonly sandboxModeEnabled: boolean;
|
2167
2167
|
```
|
2168
2168
|
|
2169
|
-
-
|
2170
|
-
-
|
2169
|
+
- _Type:_ boolean
|
2170
|
+
- _Default:_ false
|
2171
2171
|
|
2172
2172
|
Enabling sandbox mode will enable api key auth on all models in the transformed schema.
|
2173
2173
|
|
@@ -2179,8 +2179,8 @@ Enabling sandbox mode will enable api key auth on all models in the transformed
|
|
2179
2179
|
public readonly secondaryKeyAsGSI: boolean;
|
2180
2180
|
```
|
2181
2181
|
|
2182
|
-
-
|
2183
|
-
-
|
2182
|
+
- _Type:_ boolean
|
2183
|
+
- _Default:_ true
|
2184
2184
|
|
2185
2185
|
If disabled, generated.
|
2186
2186
|
|
@@ -2192,8 +2192,8 @@ If disabled, generated.
|
|
2192
2192
|
public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
|
2193
2193
|
```
|
2194
2194
|
|
2195
|
-
-
|
2196
|
-
-
|
2195
|
+
- _Type:_ boolean
|
2196
|
+
- _Default:_ true
|
2197
2197
|
|
2198
2198
|
Restore parity w/ GQLv1.
|
2199
2199
|
|
@@ -2205,8 +2205,8 @@ Restore parity w/ GQLv1.
|
|
2205
2205
|
public readonly suppressApiKeyGeneration: boolean;
|
2206
2206
|
```
|
2207
2207
|
|
2208
|
-
-
|
2209
|
-
-
|
2208
|
+
- _Type:_ boolean
|
2209
|
+
- _Default:_ false
|
2210
2210
|
|
2211
2211
|
If enabled, disable api key resource generation even if specified as an auth rule on the construct.
|
2212
2212
|
|
@@ -2220,8 +2220,8 @@ This is a legacy parameter from the Graphql Transformer existing in Amplify CLI,
|
|
2220
2220
|
public readonly useSubUsernameForDefaultIdentityClaim: boolean;
|
2221
2221
|
```
|
2222
2222
|
|
2223
|
-
-
|
2224
|
-
-
|
2223
|
+
- _Type:_ boolean
|
2224
|
+
- _Default:_ true
|
2225
2225
|
|
2226
2226
|
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
2227
|
|
@@ -2241,13 +2241,13 @@ const queryFunctionSlot: QueryFunctionSlot = { ... }
|
|
2241
2241
|
|
2242
2242
|
#### Properties <a name="Properties" id="Properties"></a>
|
2243
2243
|
|
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>
|
2244
|
+
| **Name** | **Type** | **Description** |
|
2245
|
+
| ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
2246
|
+
| <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. |
|
2247
|
+
| <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. |
|
2248
|
+
| <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. |
|
2249
|
+
| <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. |
|
2250
|
+
| <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
2251
|
|
2252
2252
|
---
|
2253
2253
|
|
@@ -2257,7 +2257,7 @@ const queryFunctionSlot: QueryFunctionSlot = { ... }
|
|
2257
2257
|
public readonly fieldName: string;
|
2258
2258
|
```
|
2259
2259
|
|
2260
|
-
-
|
2260
|
+
- _Type:_ string
|
2261
2261
|
|
2262
2262
|
The field to attach this function to on the Api definition.
|
2263
2263
|
|
@@ -2269,7 +2269,7 @@ The field to attach this function to on the Api definition.
|
|
2269
2269
|
public readonly function: FunctionSlotOverride;
|
2270
2270
|
```
|
2271
2271
|
|
2272
|
-
-
|
2272
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
2273
2273
|
|
2274
2274
|
The overridden behavior for this slot.
|
2275
2275
|
|
@@ -2281,7 +2281,7 @@ The overridden behavior for this slot.
|
|
2281
2281
|
public readonly slotIndex: number;
|
2282
2282
|
```
|
2283
2283
|
|
2284
|
-
-
|
2284
|
+
- _Type:_ number
|
2285
2285
|
|
2286
2286
|
The slot index to use to inject this into the execution pipeline.
|
2287
2287
|
|
@@ -2295,7 +2295,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
2295
2295
|
public readonly slotName: string;
|
2296
2296
|
```
|
2297
2297
|
|
2298
|
-
-
|
2298
|
+
- _Type:_ string
|
2299
2299
|
|
2300
2300
|
The slot name to inject this behavior into.
|
2301
2301
|
|
@@ -2309,7 +2309,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
2309
2309
|
public readonly typeName: string;
|
2310
2310
|
```
|
2311
2311
|
|
2312
|
-
-
|
2312
|
+
- _Type:_ string
|
2313
2313
|
|
2314
2314
|
This slot type applies to the Query type on the Api definition.
|
2315
2315
|
|
@@ -2329,13 +2329,13 @@ const subscriptionFunctionSlot: SubscriptionFunctionSlot = { ... }
|
|
2329
2329
|
|
2330
2330
|
#### Properties <a name="Properties" id="Properties"></a>
|
2331
2331
|
|
2332
|
-
| **Name**
|
2333
|
-
|
|
2334
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.fieldName">fieldName</a></code> | <code>string</code>
|
2335
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.function">function</a></code>
|
2336
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotIndex">slotIndex</a></code> | <code>number</code>
|
2337
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.slotName">slotName</a></code>
|
2338
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot.property.typeName">typeName</a></code>
|
2332
|
+
| **Name** | **Type** | **Description** |
|
2333
|
+
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
2334
|
+
| <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. |
|
2335
|
+
| <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. |
|
2336
|
+
| <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. |
|
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. |
|
2339
2339
|
|
2340
2340
|
---
|
2341
2341
|
|
@@ -2345,7 +2345,7 @@ const subscriptionFunctionSlot: SubscriptionFunctionSlot = { ... }
|
|
2345
2345
|
public readonly fieldName: string;
|
2346
2346
|
```
|
2347
2347
|
|
2348
|
-
-
|
2348
|
+
- _Type:_ string
|
2349
2349
|
|
2350
2350
|
The field to attach this function to on the Api definition.
|
2351
2351
|
|
@@ -2357,7 +2357,7 @@ The field to attach this function to on the Api definition.
|
|
2357
2357
|
public readonly function: FunctionSlotOverride;
|
2358
2358
|
```
|
2359
2359
|
|
2360
|
-
-
|
2360
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
2361
2361
|
|
2362
2362
|
The overridden behavior for this slot.
|
2363
2363
|
|
@@ -2369,7 +2369,7 @@ The overridden behavior for this slot.
|
|
2369
2369
|
public readonly slotIndex: number;
|
2370
2370
|
```
|
2371
2371
|
|
2372
|
-
-
|
2372
|
+
- _Type:_ number
|
2373
2373
|
|
2374
2374
|
The slot index to use to inject this into the execution pipeline.
|
2375
2375
|
|
@@ -2383,7 +2383,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
2383
2383
|
public readonly slotName: string;
|
2384
2384
|
```
|
2385
2385
|
|
2386
|
-
-
|
2386
|
+
- _Type:_ string
|
2387
2387
|
|
2388
2388
|
The slot name to inject this behavior into.
|
2389
2389
|
|
@@ -2397,7 +2397,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
2397
2397
|
public readonly typeName: string;
|
2398
2398
|
```
|
2399
2399
|
|
2400
|
-
-
|
2400
|
+
- _Type:_ string
|
2401
2401
|
|
2402
2402
|
This slot type applies to the Subscription type on the Api definition.
|
2403
2403
|
|
@@ -2421,19 +2421,19 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
2421
2421
|
|
2422
2422
|
#### Properties <a name="Properties" id="Properties"></a>
|
2423
2423
|
|
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>
|
2424
|
+
| **Name** | **Type** | **Description** |
|
2425
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
2426
|
+
| <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. |
|
2427
|
+
| <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. |
|
2428
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | If enabled, set nodeToNodeEncryption on the searchable domain (if one exists). |
|
2429
|
+
| <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. |
|
2430
|
+
| <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. |
|
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> | <code>boolean</code> | Enabling sandbox mode will enable api key auth on all models in the transformed schema. |
|
2433
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code> | <code>boolean</code> | If disabled, generated. |
|
2434
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code> | <code>boolean</code> | Restore parity w/ GQLv1. |
|
2435
|
+
| <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. |
|
2436
|
+
| <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
2437
|
|
2438
2438
|
---
|
2439
2439
|
|
@@ -2443,8 +2443,8 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
2443
2443
|
public readonly disableResolverDeduping: boolean;
|
2444
2444
|
```
|
2445
2445
|
|
2446
|
-
-
|
2447
|
-
-
|
2446
|
+
- _Type:_ boolean
|
2447
|
+
- _Default:_ true
|
2448
2448
|
|
2449
2449
|
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
2450
|
|
@@ -2456,8 +2456,8 @@ Disable resolver deduping, this can sometimes cause problems because dedupe orde
|
|
2456
2456
|
public readonly enableAutoIndexQueryNames: boolean;
|
2457
2457
|
```
|
2458
2458
|
|
2459
|
-
-
|
2460
|
-
-
|
2459
|
+
- _Type:_ boolean
|
2460
|
+
- _Default:_ true
|
2461
2461
|
|
2462
2462
|
Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.
|
2463
2463
|
|
@@ -2471,14 +2471,14 @@ If enabled,
|
|
2471
2471
|
public readonly enableSearchNodeToNodeEncryption: boolean;
|
2472
2472
|
```
|
2473
2473
|
|
2474
|
-
-
|
2475
|
-
-
|
2474
|
+
- _Type:_ boolean
|
2475
|
+
- _Default:_ false
|
2476
2476
|
|
2477
2477
|
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
2478
2478
|
|
2479
2479
|
Not recommended for use, prefer
|
2480
2480
|
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
2481
|
-
|
2481
|
+
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
2482
2482
|
});
|
2483
2483
|
|
2484
2484
|
---
|
@@ -2489,8 +2489,8 @@ to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain'
|
|
2489
2489
|
public readonly enableTransformerCfnOutputs: boolean;
|
2490
2490
|
```
|
2491
2491
|
|
2492
|
-
-
|
2493
|
-
-
|
2492
|
+
- _Type:_ boolean
|
2493
|
+
- _Default:_ false
|
2494
2494
|
|
2495
2495
|
When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.
|
2496
2496
|
|
@@ -2502,8 +2502,8 @@ When enabled, internal cfn outputs which existed in Amplify-generated apps will
|
|
2502
2502
|
public readonly populateOwnerFieldForStaticGroupAuth: boolean;
|
2503
2503
|
```
|
2504
2504
|
|
2505
|
-
-
|
2506
|
-
-
|
2505
|
+
- _Type:_ boolean
|
2506
|
+
- _Default:_ true
|
2507
2507
|
|
2508
2508
|
Ensure that the owner field is still populated even if a static iam or group authorization applies.
|
2509
2509
|
|
@@ -2515,8 +2515,8 @@ Ensure that the owner field is still populated even if a static iam or group aut
|
|
2515
2515
|
public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;
|
2516
2516
|
```
|
2517
2517
|
|
2518
|
-
-
|
2519
|
-
-
|
2518
|
+
- _Type:_ boolean
|
2519
|
+
- _Default:_ true
|
2520
2520
|
|
2521
2521
|
Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.
|
2522
2522
|
|
@@ -2528,8 +2528,8 @@ Enable custom primary key support, there's no good reason to disable this unless
|
|
2528
2528
|
public readonly sandboxModeEnabled: boolean;
|
2529
2529
|
```
|
2530
2530
|
|
2531
|
-
-
|
2532
|
-
-
|
2531
|
+
- _Type:_ boolean
|
2532
|
+
- _Default:_ false
|
2533
2533
|
|
2534
2534
|
Enabling sandbox mode will enable api key auth on all models in the transformed schema.
|
2535
2535
|
|
@@ -2541,8 +2541,8 @@ Enabling sandbox mode will enable api key auth on all models in the transformed
|
|
2541
2541
|
public readonly secondaryKeyAsGSI: boolean;
|
2542
2542
|
```
|
2543
2543
|
|
2544
|
-
-
|
2545
|
-
-
|
2544
|
+
- _Type:_ boolean
|
2545
|
+
- _Default:_ true
|
2546
2546
|
|
2547
2547
|
If disabled, generated.
|
2548
2548
|
|
@@ -2554,8 +2554,8 @@ If disabled, generated.
|
|
2554
2554
|
public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
|
2555
2555
|
```
|
2556
2556
|
|
2557
|
-
-
|
2558
|
-
-
|
2557
|
+
- _Type:_ boolean
|
2558
|
+
- _Default:_ true
|
2559
2559
|
|
2560
2560
|
Restore parity w/ GQLv1.
|
2561
2561
|
|
@@ -2567,8 +2567,8 @@ Restore parity w/ GQLv1.
|
|
2567
2567
|
public readonly suppressApiKeyGeneration: boolean;
|
2568
2568
|
```
|
2569
2569
|
|
2570
|
-
-
|
2571
|
-
-
|
2570
|
+
- _Type:_ boolean
|
2571
|
+
- _Default:_ false
|
2572
2572
|
|
2573
2573
|
If enabled, disable api key resource generation even if specified as an auth rule on the construct.
|
2574
2574
|
|
@@ -2582,8 +2582,8 @@ This is a legacy parameter from the Graphql Transformer existing in Amplify CLI,
|
|
2582
2582
|
public readonly useSubUsernameForDefaultIdentityClaim: boolean;
|
2583
2583
|
```
|
2584
2584
|
|
2585
|
-
-
|
2586
|
-
-
|
2585
|
+
- _Type:_ boolean
|
2586
|
+
- _Default:_ true
|
2587
2587
|
|
2588
2588
|
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
2589
|
|
@@ -2603,8 +2603,8 @@ const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }
|
|
2603
2603
|
|
2604
2604
|
#### Properties <a name="Properties" id="Properties"></a>
|
2605
2605
|
|
2606
|
-
| **Name**
|
2607
|
-
|
|
2606
|
+
| **Name** | **Type** | **Description** |
|
2607
|
+
| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
2608
2608
|
| <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
2609
|
|
2610
2610
|
---
|
@@ -2615,7 +2615,7 @@ const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }
|
|
2615
2615
|
public readonly userPool: IUserPool;
|
2616
2616
|
```
|
2617
2617
|
|
2618
|
-
-
|
2618
|
+
- _Type:_ aws-cdk-lib.aws_cognito.IUserPool
|
2619
2619
|
|
2620
2620
|
The Cognito User Pool which is used to authenticated JWT tokens, and vends group and user information.
|
2621
2621
|
|
@@ -2630,23 +2630,22 @@ Class exposing utilities to produce IAmplifyGraphqlDefinition objects given vari
|
|
2630
2630
|
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.Initializer"></a>
|
2631
2631
|
|
2632
2632
|
```typescript
|
2633
|
-
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
2633
|
+
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';
|
2634
2634
|
|
2635
|
-
new AmplifyGraphqlDefinition()
|
2635
|
+
new AmplifyGraphqlDefinition();
|
2636
2636
|
```
|
2637
2637
|
|
2638
2638
|
| **Name** | **Type** | **Description** |
|
2639
|
-
|
|
2639
|
+
| -------- | -------- | --------------- |
|
2640
2640
|
|
2641
2641
|
---
|
2642
2642
|
|
2643
|
-
|
2644
2643
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
2645
2644
|
|
2646
|
-
| **Name**
|
2647
|
-
|
|
2648
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles">fromFiles</a></code>
|
2649
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input.
|
2645
|
+
| **Name** | **Description** |
|
2646
|
+
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
2647
|
+
| <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. |
|
2648
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input. |
|
2650
2649
|
|
2651
2650
|
---
|
2652
2651
|
|
@@ -2662,7 +2661,7 @@ Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.
|
|
2662
2661
|
|
2663
2662
|
###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles.parameter.filePaths"></a>
|
2664
2663
|
|
2665
|
-
-
|
2664
|
+
- _Type:_ string
|
2666
2665
|
|
2667
2666
|
one or more paths to the graphql files to process.
|
2668
2667
|
|
@@ -2680,29 +2679,26 @@ Produce a schema definition from a string input.
|
|
2680
2679
|
|
2681
2680
|
###### `schema`<sup>Required</sup> <a name="schema" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.schema"></a>
|
2682
2681
|
|
2683
|
-
-
|
2682
|
+
- _Type:_ string
|
2684
2683
|
|
2685
2684
|
the graphql input as a string.
|
2686
2685
|
|
2687
2686
|
---
|
2688
2687
|
|
2689
|
-
|
2690
|
-
|
2691
2688
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
2692
2689
|
|
2693
2690
|
### IAmplifyGraphqlDefinition <a name="IAmplifyGraphqlDefinition" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition"></a>
|
2694
2691
|
|
2695
|
-
-
|
2692
|
+
- _Implemented By:_ <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>
|
2696
2693
|
|
2697
2694
|
Graphql Api definition, which can be implemented in multiple ways.
|
2698
2695
|
|
2699
|
-
|
2700
2696
|
#### Properties <a name="Properties" id="Properties"></a>
|
2701
2697
|
|
2702
|
-
| **Name**
|
2703
|
-
|
|
2704
|
-
| <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.
|
2705
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.schema">schema</a></code>
|
2698
|
+
| **Name** | **Type** | **Description** |
|
2699
|
+
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
2700
|
+
| <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. |
|
2701
|
+
| <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. |
|
2706
2702
|
|
2707
2703
|
---
|
2708
2704
|
|
@@ -2712,7 +2708,7 @@ Graphql Api definition, which can be implemented in multiple ways.
|
|
2712
2708
|
public readonly functionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
2713
2709
|
```
|
2714
2710
|
|
2715
|
-
-
|
2711
|
+
- _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>[]
|
2716
2712
|
|
2717
2713
|
Retrieve any function slots defined explicitly in the Api definition.
|
2718
2714
|
|
@@ -2724,7 +2720,7 @@ Retrieve any function slots defined explicitly in the Api definition.
|
|
2724
2720
|
public readonly schema: string;
|
2725
2721
|
```
|
2726
2722
|
|
2727
|
-
-
|
2723
|
+
- _Type:_ string
|
2728
2724
|
|
2729
2725
|
Return the schema definition as a graphql string, with amplify directives allowed.
|
2730
2726
|
|
@@ -2732,17 +2728,16 @@ Return the schema definition as a graphql string, with amplify directives allowe
|
|
2732
2728
|
|
2733
2729
|
### IBackendOutputEntry <a name="IBackendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputEntry"></a>
|
2734
2730
|
|
2735
|
-
-
|
2731
|
+
- _Implemented By:_ <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>
|
2736
2732
|
|
2737
2733
|
Entry representing the required output from the backend for codegen generate commands to work.
|
2738
2734
|
|
2739
|
-
|
2740
2735
|
#### Properties <a name="Properties" id="Properties"></a>
|
2741
2736
|
|
2742
|
-
| **Name**
|
2743
|
-
|
|
2737
|
+
| **Name** | **Type** | **Description** |
|
2738
|
+
| ----------------------------------------------------------------------------------------------------------- | -------------------------------------- | -------------------------------------------------- |
|
2744
2739
|
| <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. |
|
2745
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.version">version</a></code> | <code>string</code>
|
2740
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.version">version</a></code> | <code>string</code> | The protocol version for this backend output. |
|
2746
2741
|
|
2747
2742
|
---
|
2748
2743
|
|
@@ -2752,7 +2747,7 @@ Entry representing the required output from the backend for codegen generate com
|
|
2752
2747
|
public readonly payload: {[ key: string ]: string};
|
2753
2748
|
```
|
2754
2749
|
|
2755
|
-
-
|
2750
|
+
- _Type:_ {[ key: string ]: string}
|
2756
2751
|
|
2757
2752
|
The string-map payload of generated config values.
|
2758
2753
|
|
@@ -2764,7 +2759,7 @@ The string-map payload of generated config values.
|
|
2764
2759
|
public readonly version: string;
|
2765
2760
|
```
|
2766
2761
|
|
2767
|
-
-
|
2762
|
+
- _Type:_ string
|
2768
2763
|
|
2769
2764
|
The protocol version for this backend output.
|
2770
2765
|
|
@@ -2772,14 +2767,14 @@ The protocol version for this backend output.
|
|
2772
2767
|
|
2773
2768
|
### IBackendOutputStorageStrategy <a name="IBackendOutputStorageStrategy" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy"></a>
|
2774
2769
|
|
2775
|
-
-
|
2770
|
+
- _Implemented By:_ <a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a>
|
2776
2771
|
|
2777
2772
|
Backend output strategy used to write config required for codegen tasks.
|
2778
2773
|
|
2779
2774
|
#### Methods <a name="Methods" id="Methods"></a>
|
2780
2775
|
|
2781
|
-
| **Name**
|
2782
|
-
|
|
2776
|
+
| **Name** | **Description** |
|
2777
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
|
2783
2778
|
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry">addBackendOutputEntry</a></code> | Add an entry to backend output. |
|
2784
2779
|
|
2785
2780
|
---
|
@@ -2794,7 +2789,7 @@ Add an entry to backend output.
|
|
2794
2789
|
|
2795
2790
|
###### `keyName`<sup>Required</sup> <a name="keyName" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry.parameter.keyName"></a>
|
2796
2791
|
|
2797
|
-
-
|
2792
|
+
- _Type:_ string
|
2798
2793
|
|
2799
2794
|
the key.
|
2800
2795
|
|
@@ -2802,10 +2797,8 @@ the key.
|
|
2802
2797
|
|
2803
2798
|
###### `backendOutputEntry`<sup>Required</sup> <a name="backendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry.parameter.backendOutputEntry"></a>
|
2804
2799
|
|
2805
|
-
-
|
2800
|
+
- _Type:_ <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>
|
2806
2801
|
|
2807
2802
|
the record to store in the backend output.
|
2808
2803
|
|
2809
2804
|
---
|
2810
|
-
|
2811
|
-
|