@aws-amplify/graphql-api-construct 1.3.0-rds-5.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +202 -620
- package/API.md +2 -42
- package/CHANGELOG.md +8 -3
- package/README.md +396 -371
- package/lib/amplify-graphql-api.d.ts +0 -6
- package/lib/amplify-graphql-api.js +4 -60
- package/lib/amplify-graphql-definition.d.ts +6 -17
- package/lib/amplify-graphql-definition.js +11 -26
- package/lib/index.d.ts +1 -1
- package/lib/index.js +1 -1
- package/lib/internal/authorization-modes.js +20 -2
- package/lib/types.d.ts +7 -97
- package/lib/types.js +1 -1
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/index.js +3 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/auth/v1.js +3 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/index.js +3 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/graphql/v1.js +5 -3
- package/node_modules/@aws-amplify/backend-output-schemas/lib/index.js +11 -7
- package/node_modules/@aws-amplify/backend-output-schemas/lib/platform/stack_metadata_schemas.js +4 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/index.js +3 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/stack/v1.js +3 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/index.js +3 -2
- package/node_modules/@aws-amplify/backend-output-schemas/lib/storage/v1.js +3 -2
- package/node_modules/@aws-amplify/backend-output-storage/package.json +2 -2
- package/node_modules/@aws-amplify/graphql-auth-transformer/API.md +1 -5
- package/node_modules/@aws-amplify/graphql-auth-transformer/CHANGELOG.md +2 -14
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.d.ts +1 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.js +50 -64
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/graphql-auth-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/field.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/field.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/field.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/field.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/helpers.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/helpers.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/helpers.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/helpers.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/index.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/index.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.create.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.create.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.create.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.create.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.delete.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.delete.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.delete.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.delete.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.update.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.update.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/mutation.update.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/mutation.update.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.d.ts +6 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/query.js +3 -28
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/query.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/search.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/search.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/search.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/search.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/rds/resolvers/subscription.d.ts → resolvers/subscriptions.d.ts} +2 -2
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/subscriptions.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/subscriptions.js +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/resolvers/subscriptions.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.js +0 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/schema.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/schema.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.d.ts +2 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.js +1 -4
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/utils/validations.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/package.json +11 -12
- package/node_modules/@aws-amplify/graphql-default-value-transformer/CHANGELOG.md +2 -4
- package/node_modules/@aws-amplify/graphql-default-value-transformer/lib/graphql-default-value-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-default-value-transformer/lib/graphql-default-value-transformer.js +1 -13
- package/node_modules/@aws-amplify/graphql-default-value-transformer/lib/graphql-default-value-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-default-value-transformer/package.json +8 -9
- package/node_modules/@aws-amplify/graphql-function-transformer/CHANGELOG.md +1 -1
- package/node_modules/@aws-amplify/graphql-function-transformer/package.json +7 -8
- package/node_modules/@aws-amplify/graphql-http-transformer/CHANGELOG.md +1 -1
- package/node_modules/@aws-amplify/graphql-http-transformer/package.json +7 -8
- package/node_modules/@aws-amplify/graphql-index-transformer/CHANGELOG.md +2 -6
- 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 +1 -4
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/generators/rds-vtl-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.d.ts +3 -4
- 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 +11 -20
- package/node_modules/@aws-amplify/graphql-index-transformer/lib/resolvers/resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-index-transformer/package.json +8 -9
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/API.md +0 -15
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/CHANGELOG.md +2 -10
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/assets/mapping-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.js +1 -13
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/field-mapping-resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.d.ts +1 -2
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.js +33 -16
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-maps-to-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.js +1 -3
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/package.json +13 -14
- package/node_modules/@aws-amplify/graphql-model-transformer/API.md +15 -15
- package/node_modules/@aws-amplify/graphql-model-transformer/CHANGELOG.md +2 -16
- 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 +12 -25
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-model-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-types/mutation.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-types/mutation.js +2 -9
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/graphql-types/mutation.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/rds-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/rds-notification-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/rds-patching-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.d.ts +5 -6
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.js +5 -5
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/dynamodb-vtl-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.d.ts +5 -6
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.js +11 -11
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/rds-vtl-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/vtl-generator.d.ts +5 -6
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/generators/vtl-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.d.ts +3 -4
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.js +55 -74
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/mutation.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.d.ts +1 -2
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.js +2 -8
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/query.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.d.ts +3 -10
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.js +42 -127
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resolvers/rds/resolver.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/model-resource-generator.js +5 -5
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/model-resource-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.js +1 -28
- package/node_modules/@aws-amplify/graphql-model-transformer/lib/resources/rds-model-resource-generator.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/package.json +9 -10
- package/node_modules/@aws-amplify/graphql-predictions-transformer/CHANGELOG.md +1 -1
- package/node_modules/@aws-amplify/graphql-predictions-transformer/lib/predictionsLambdaFunction.zip +0 -0
- package/node_modules/@aws-amplify/graphql-predictions-transformer/package.json +7 -8
- package/node_modules/@aws-amplify/graphql-relational-transformer/CHANGELOG.md +2 -7
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-belongs-to-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-belongs-to-transformer.js +9 -41
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-belongs-to-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-many-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-many-transformer.js +8 -35
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-many-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-one-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-one-transformer.js +8 -30
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-has-one-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-many-to-many-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-many-to-many-transformer.js +2 -3
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/graphql-many-to-many-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.d.ts +4 -4
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.js +161 -14
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolvers.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/schema.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/schema.js +8 -14
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/schema.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/types.d.ts +0 -4
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/types.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.d.ts +0 -5
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.js +1 -85
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/utils.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/package.json +10 -11
- package/node_modules/@aws-amplify/graphql-searchable-transformer/CHANGELOG.md +2 -4
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/graphql-searchable-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/graphql-searchable-transformer.js +0 -3
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/graphql-searchable-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-searchable-transformer/lib/streaming-lambda.zip +0 -0
- package/node_modules/@aws-amplify/graphql-searchable-transformer/package.json +8 -9
- package/node_modules/@aws-amplify/graphql-transformer/API.md +0 -1
- package/node_modules/@aws-amplify/graphql-transformer/CHANGELOG.md +2 -11
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.d.ts +0 -1
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.js +1 -5
- package/node_modules/@aws-amplify/graphql-transformer/lib/graphql-transformer.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer/package.json +14 -16
- package/node_modules/@aws-amplify/graphql-transformer/src/graphql-transformer.ts +2 -7
- package/node_modules/@aws-amplify/graphql-transformer-core/API.md +3 -33
- package/node_modules/@aws-amplify/graphql-transformer-core/CHANGELOG.md +2 -13
- 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/graphql-api.js +2 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/graphql-api.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.d.ts +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 +1 -10
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transform-host.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transform-host.js +1 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transform-host.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform.d.ts +3 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform.js +3 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/types.d.ts +0 -1
- 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 +3 -4
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformer-context/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformer-context/index.js +1 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/transformer-context/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.d.ts +1 -4
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.js +2 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/import-appsync-api-types.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.js +1 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/types/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/authType.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/authType.js +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/authType.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.d.ts +2 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.js +3 -14
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.d.ts +2 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.d.ts.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.js +25 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-secret-utils.js.map +1 -0
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.d.ts +1 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.js +1 -7
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/schema-utils.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/wrappers/object-definition-wrapper.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/wrappers/object-definition-wrapper.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/package.json +4 -5
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/API.md +3 -20
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/CHANGELOG.md +3 -6
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.d.ts +2 -5
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/graphql-api-provider.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.d.ts +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.d.ts.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/index.js.map +1 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/lib/transformer-context/transformer-context-provider.d.ts +0 -1
- 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 +2 -3
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/graphql-api-provider.ts +16 -17
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/index.ts +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/index.ts +0 -2
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-context-provider.ts +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-datasource-provider.ts +1 -8
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/tsconfig.tsbuildinfo +1 -1
- package/node_modules/graphql-mapping-template/CHANGELOG.md +0 -4
- package/node_modules/graphql-mapping-template/package.json +2 -3
- package/node_modules/graphql-transformer-common/API.md +0 -21
- package/node_modules/graphql-transformer-common/CHANGELOG.md +0 -11
- package/node_modules/graphql-transformer-common/lib/definition.d.ts +2 -9
- package/node_modules/graphql-transformer-common/lib/definition.d.ts.map +1 -1
- package/node_modules/graphql-transformer-common/lib/definition.js +1 -52
- package/node_modules/graphql-transformer-common/lib/definition.js.map +1 -1
- package/node_modules/graphql-transformer-common/lib/util.d.ts.map +1 -1
- package/node_modules/graphql-transformer-common/lib/util.js +1 -3
- package/node_modules/graphql-transformer-common/lib/util.js.map +1 -1
- package/node_modules/graphql-transformer-common/package.json +6 -7
- package/package.json +17 -19
- package/src/amplify-graphql-api.ts +4 -73
- package/src/amplify-graphql-definition.ts +10 -30
- package/src/index.ts +0 -6
- package/src/internal/authorization-modes.ts +22 -1
- package/src/types.ts +8 -114
- package/lib/sql-model-datasource-binding.d.ts +0 -20
- package/lib/sql-model-datasource-binding.js +0 -42
- package/node_modules/@aws-amplify/graphql-auth-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.d.ts +0 -20
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.js +0 -24
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/ddb-vtl-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/field.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/field.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/helpers.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/helpers.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.create.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.create.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.delete.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.delete.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.update.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/mutation.update.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.d.ts +0 -6
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/query.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/search.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/search.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.d.ts +0 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/ddb/resolvers/subscriptions.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.d.ts +0 -20
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.js +0 -24
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/rds-vtl-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.d.ts +0 -13
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.js +0 -157
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/common.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.d.ts +0 -5
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.js +0 -21
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.d.ts +0 -8
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.js +0 -56
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/mutation.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.d.ts +0 -8
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.js +0 -41
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/query.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.js +0 -18
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/rds/resolvers/subscription.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.d.ts +0 -19
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.js +0 -3
- package/node_modules/@aws-amplify/graphql-auth-transformer/lib/vtl-generator/vtl-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-default-value-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-function-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-http-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-index-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.d.ts +0 -10
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.js +0 -102
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-name-mapping.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.d.ts +0 -13
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.js +0 -81
- package/node_modules/@aws-amplify/graphql-maps-to-transformer/lib/graphql-refers-to-transformer.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-model-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-predictions-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-relational-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.d.ts +0 -13
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.js +0 -171
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/ddb-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.d.ts +0 -4
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.js +0 -18
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator-factory.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.d.ts +0 -8
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.js +0 -7
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.d.ts +0 -14
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.js +0 -115
- package/node_modules/@aws-amplify/graphql-relational-transformer/lib/resolver/rds-generator.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-searchable-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-sql-transformer/API.md +0 -26
- package/node_modules/@aws-amplify/graphql-sql-transformer/CHANGELOG.md +0 -10
- package/node_modules/@aws-amplify/graphql-sql-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-sql-transformer/README.md +0 -13
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.d.ts +0 -12
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.js +0 -132
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/graphql-sql-transformer.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.d.ts +0 -2
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.js +0 -6
- package/node_modules/@aws-amplify/graphql-sql-transformer/lib/index.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-sql-transformer/package.json +0 -71
- package/node_modules/@aws-amplify/graphql-transformer/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-transformer-core/LICENSE +0 -201
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.d.ts +0 -2
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.js +0 -5
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/api-category.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.d.ts +0 -3
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.js +0 -19
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/model-util.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.d.ts +0 -14
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.d.ts.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.js +0 -82
- package/node_modules/@aws-amplify/graphql-transformer-core/lib/utils/rds-util.js.map +0 -1
- package/node_modules/@aws-amplify/graphql-transformer-interfaces/LICENSE +0 -201
- package/node_modules/graphql-mapping-template/LICENSE +0 -201
- package/node_modules/graphql-transformer-common/LICENSE +0 -201
- package/src/sql-model-datasource-binding.ts +0 -45
- /package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/index.d.ts +0 -0
- /package/node_modules/@aws-amplify/graphql-auth-transformer/lib/{vtl-generator/ddb/resolvers → resolvers}/index.js +0 -0
package/README.md
CHANGED
|
@@ -165,7 +165,6 @@ The output of this construct is a mapping of L2 or L1 resources generated by the
|
|
|
165
165
|
table.pointInTimeRecoverySpecification = { pointInTimeRecoveryEnabled: false };
|
|
166
166
|
});
|
|
167
167
|
```
|
|
168
|
-
|
|
169
168
|
`resources.<ResourceType>.<ResourceName>` - you can then perform any CDK action on these resulting resoureces.
|
|
170
169
|
|
|
171
170
|
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer"></a>
|
|
@@ -176,17 +175,17 @@ import { AmplifyGraphqlApi } from '@aws-amplify/graphql-api-construct'
|
|
|
176
175
|
new AmplifyGraphqlApi(scope: Construct, id: string, props: AmplifyGraphqlApiProps)
|
|
177
176
|
```
|
|
178
177
|
|
|
179
|
-
| **Name**
|
|
180
|
-
|
|
|
181
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code>
|
|
182
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id">id</a></code>
|
|
178
|
+
| **Name** | **Type** | **Description** |
|
|
179
|
+
| --- | --- | --- |
|
|
180
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | the scope to create this construct within. |
|
|
181
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id">id</a></code> | <code>string</code> | the id to use for this api. |
|
|
183
182
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.props">props</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps">AmplifyGraphqlApiProps</a></code> | the properties used to configure the generated api. |
|
|
184
183
|
|
|
185
184
|
---
|
|
186
185
|
|
|
187
186
|
##### `scope`<sup>Required</sup> <a name="scope" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.scope"></a>
|
|
188
187
|
|
|
189
|
-
-
|
|
188
|
+
- *Type:* constructs.Construct
|
|
190
189
|
|
|
191
190
|
the scope to create this construct within.
|
|
192
191
|
|
|
@@ -194,7 +193,7 @@ the scope to create this construct within.
|
|
|
194
193
|
|
|
195
194
|
##### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.id"></a>
|
|
196
195
|
|
|
197
|
-
-
|
|
196
|
+
- *Type:* string
|
|
198
197
|
|
|
199
198
|
the id to use for this api.
|
|
200
199
|
|
|
@@ -202,7 +201,7 @@ the id to use for this api.
|
|
|
202
201
|
|
|
203
202
|
##### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.Initializer.parameter.props"></a>
|
|
204
203
|
|
|
205
|
-
-
|
|
204
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiProps">AmplifyGraphqlApiProps</a>
|
|
206
205
|
|
|
207
206
|
the properties used to configure the generated api.
|
|
208
207
|
|
|
@@ -210,19 +209,19 @@ the properties used to configure the generated api.
|
|
|
210
209
|
|
|
211
210
|
#### Methods <a name="Methods" id="Methods"></a>
|
|
212
211
|
|
|
213
|
-
| **Name**
|
|
214
|
-
|
|
|
215
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.toString">toString</a></code>
|
|
216
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource">addDynamoDbDataSource</a></code>
|
|
217
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource">addElasticsearchDataSource</a></code> | Add a new elasticsearch data source to this API.
|
|
218
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource">addEventBridgeDataSource</a></code>
|
|
219
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction">addFunction</a></code>
|
|
220
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource">addHttpDataSource</a></code>
|
|
221
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource">addLambdaDataSource</a></code>
|
|
222
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource">addNoneDataSource</a></code>
|
|
223
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource">addOpenSearchDataSource</a></code>
|
|
224
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource">addRdsDataSource</a></code>
|
|
225
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver">addResolver</a></code>
|
|
212
|
+
| **Name** | **Description** |
|
|
213
|
+
| --- | --- |
|
|
214
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
215
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource">addDynamoDbDataSource</a></code> | Add a new DynamoDB data source to this API. |
|
|
216
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource">addElasticsearchDataSource</a></code> | Add a new elasticsearch data source to this API. |
|
|
217
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource">addEventBridgeDataSource</a></code> | Add an EventBridge data source to this api. |
|
|
218
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction">addFunction</a></code> | Add an appsync function to the api. |
|
|
219
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource">addHttpDataSource</a></code> | Add a new http data source to this API. |
|
|
220
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource">addLambdaDataSource</a></code> | Add a new Lambda data source to this API. |
|
|
221
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource">addNoneDataSource</a></code> | Add a new dummy data source to this API. |
|
|
222
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource">addOpenSearchDataSource</a></code> | dd a new OpenSearch data source to this API. |
|
|
223
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource">addRdsDataSource</a></code> | Add a new Rds data source to this API. |
|
|
224
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver">addResolver</a></code> | Add a resolver to the api. |
|
|
226
225
|
|
|
227
226
|
---
|
|
228
227
|
|
|
@@ -246,7 +245,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
246
245
|
|
|
247
246
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.id"></a>
|
|
248
247
|
|
|
249
|
-
-
|
|
248
|
+
- *Type:* string
|
|
250
249
|
|
|
251
250
|
The data source's id.
|
|
252
251
|
|
|
@@ -254,7 +253,7 @@ The data source's id.
|
|
|
254
253
|
|
|
255
254
|
###### `table`<sup>Required</sup> <a name="table" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.table"></a>
|
|
256
255
|
|
|
257
|
-
-
|
|
256
|
+
- *Type:* aws-cdk-lib.aws_dynamodb.ITable
|
|
258
257
|
|
|
259
258
|
The DynamoDB table backing this data source.
|
|
260
259
|
|
|
@@ -262,7 +261,7 @@ The DynamoDB table backing this data source.
|
|
|
262
261
|
|
|
263
262
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addDynamoDbDataSource.parameter.options"></a>
|
|
264
263
|
|
|
265
|
-
-
|
|
264
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
266
265
|
|
|
267
266
|
The optional configuration for this data source.
|
|
268
267
|
|
|
@@ -280,7 +279,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
280
279
|
|
|
281
280
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.id"></a>
|
|
282
281
|
|
|
283
|
-
-
|
|
282
|
+
- *Type:* string
|
|
284
283
|
|
|
285
284
|
The data source's id.
|
|
286
285
|
|
|
@@ -288,7 +287,7 @@ The data source's id.
|
|
|
288
287
|
|
|
289
288
|
###### `domain`<sup>Required</sup> <a name="domain" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.domain"></a>
|
|
290
289
|
|
|
291
|
-
-
|
|
290
|
+
- *Type:* aws-cdk-lib.aws_elasticsearch.IDomain
|
|
292
291
|
|
|
293
292
|
The elasticsearch domain for this data source.
|
|
294
293
|
|
|
@@ -296,7 +295,7 @@ The elasticsearch domain for this data source.
|
|
|
296
295
|
|
|
297
296
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addElasticsearchDataSource.parameter.options"></a>
|
|
298
297
|
|
|
299
|
-
-
|
|
298
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
300
299
|
|
|
301
300
|
The optional configuration for this data source.
|
|
302
301
|
|
|
@@ -314,7 +313,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
314
313
|
|
|
315
314
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.id"></a>
|
|
316
315
|
|
|
317
|
-
-
|
|
316
|
+
- *Type:* string
|
|
318
317
|
|
|
319
318
|
The data source's id.
|
|
320
319
|
|
|
@@ -322,7 +321,7 @@ The data source's id.
|
|
|
322
321
|
|
|
323
322
|
###### `eventBus`<sup>Required</sup> <a name="eventBus" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.eventBus"></a>
|
|
324
323
|
|
|
325
|
-
-
|
|
324
|
+
- *Type:* aws-cdk-lib.aws_events.IEventBus
|
|
326
325
|
|
|
327
326
|
The EventBridge EventBus on which to put events.
|
|
328
327
|
|
|
@@ -330,7 +329,7 @@ The EventBridge EventBus on which to put events.
|
|
|
330
329
|
|
|
331
330
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addEventBridgeDataSource.parameter.options"></a>
|
|
332
331
|
|
|
333
|
-
-
|
|
332
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
334
333
|
|
|
335
334
|
The optional configuration for this data source.
|
|
336
335
|
|
|
@@ -346,7 +345,7 @@ Add an appsync function to the api.
|
|
|
346
345
|
|
|
347
346
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction.parameter.id"></a>
|
|
348
347
|
|
|
349
|
-
-
|
|
348
|
+
- *Type:* string
|
|
350
349
|
|
|
351
350
|
the function's id.
|
|
352
351
|
|
|
@@ -354,7 +353,7 @@ the function's id.
|
|
|
354
353
|
|
|
355
354
|
###### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addFunction.parameter.props"></a>
|
|
356
355
|
|
|
357
|
-
-
|
|
356
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AddFunctionProps">AddFunctionProps</a>
|
|
358
357
|
|
|
359
358
|
---
|
|
360
359
|
|
|
@@ -370,7 +369,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
370
369
|
|
|
371
370
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.id"></a>
|
|
372
371
|
|
|
373
|
-
-
|
|
372
|
+
- *Type:* string
|
|
374
373
|
|
|
375
374
|
The data source's id.
|
|
376
375
|
|
|
@@ -378,7 +377,7 @@ The data source's id.
|
|
|
378
377
|
|
|
379
378
|
###### `endpoint`<sup>Required</sup> <a name="endpoint" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.endpoint"></a>
|
|
380
379
|
|
|
381
|
-
-
|
|
380
|
+
- *Type:* string
|
|
382
381
|
|
|
383
382
|
The http endpoint.
|
|
384
383
|
|
|
@@ -386,7 +385,7 @@ The http endpoint.
|
|
|
386
385
|
|
|
387
386
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addHttpDataSource.parameter.options"></a>
|
|
388
387
|
|
|
389
|
-
-
|
|
388
|
+
- *Type:* aws-cdk-lib.aws_appsync.HttpDataSourceOptions
|
|
390
389
|
|
|
391
390
|
The optional configuration for this data source.
|
|
392
391
|
|
|
@@ -404,7 +403,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
404
403
|
|
|
405
404
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.id"></a>
|
|
406
405
|
|
|
407
|
-
-
|
|
406
|
+
- *Type:* string
|
|
408
407
|
|
|
409
408
|
The data source's id.
|
|
410
409
|
|
|
@@ -412,7 +411,7 @@ The data source's id.
|
|
|
412
411
|
|
|
413
412
|
###### `lambdaFunction`<sup>Required</sup> <a name="lambdaFunction" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.lambdaFunction"></a>
|
|
414
413
|
|
|
415
|
-
-
|
|
414
|
+
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
416
415
|
|
|
417
416
|
The Lambda function to call to interact with this data source.
|
|
418
417
|
|
|
@@ -420,7 +419,7 @@ The Lambda function to call to interact with this data source.
|
|
|
420
419
|
|
|
421
420
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addLambdaDataSource.parameter.options"></a>
|
|
422
421
|
|
|
423
|
-
-
|
|
422
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
424
423
|
|
|
425
424
|
The optional configuration for this data source.
|
|
426
425
|
|
|
@@ -439,7 +438,7 @@ Useful for pipeline resolvers and for backend changes that don't require a data
|
|
|
439
438
|
|
|
440
439
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource.parameter.id"></a>
|
|
441
440
|
|
|
442
|
-
-
|
|
441
|
+
- *Type:* string
|
|
443
442
|
|
|
444
443
|
The data source's id.
|
|
445
444
|
|
|
@@ -447,7 +446,7 @@ The data source's id.
|
|
|
447
446
|
|
|
448
447
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addNoneDataSource.parameter.options"></a>
|
|
449
448
|
|
|
450
|
-
-
|
|
449
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
451
450
|
|
|
452
451
|
The optional configuration for this data source.
|
|
453
452
|
|
|
@@ -465,7 +464,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
465
464
|
|
|
466
465
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.id"></a>
|
|
467
466
|
|
|
468
|
-
-
|
|
467
|
+
- *Type:* string
|
|
469
468
|
|
|
470
469
|
The data source's id.
|
|
471
470
|
|
|
@@ -473,7 +472,7 @@ The data source's id.
|
|
|
473
472
|
|
|
474
473
|
###### `domain`<sup>Required</sup> <a name="domain" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.domain"></a>
|
|
475
474
|
|
|
476
|
-
-
|
|
475
|
+
- *Type:* aws-cdk-lib.aws_opensearchservice.IDomain
|
|
477
476
|
|
|
478
477
|
The OpenSearch domain for this data source.
|
|
479
478
|
|
|
@@ -481,7 +480,7 @@ The OpenSearch domain for this data source.
|
|
|
481
480
|
|
|
482
481
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addOpenSearchDataSource.parameter.options"></a>
|
|
483
482
|
|
|
484
|
-
-
|
|
483
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
485
484
|
|
|
486
485
|
The optional configuration for this data source.
|
|
487
486
|
|
|
@@ -499,7 +498,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
499
498
|
|
|
500
499
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.id"></a>
|
|
501
500
|
|
|
502
|
-
-
|
|
501
|
+
- *Type:* string
|
|
503
502
|
|
|
504
503
|
The data source's id.
|
|
505
504
|
|
|
@@ -507,7 +506,7 @@ The data source's id.
|
|
|
507
506
|
|
|
508
507
|
###### `serverlessCluster`<sup>Required</sup> <a name="serverlessCluster" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.serverlessCluster"></a>
|
|
509
508
|
|
|
510
|
-
-
|
|
509
|
+
- *Type:* aws-cdk-lib.aws_rds.IServerlessCluster
|
|
511
510
|
|
|
512
511
|
The serverless cluster to interact with this data source.
|
|
513
512
|
|
|
@@ -515,7 +514,7 @@ The serverless cluster to interact with this data source.
|
|
|
515
514
|
|
|
516
515
|
###### `secretStore`<sup>Required</sup> <a name="secretStore" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.secretStore"></a>
|
|
517
516
|
|
|
518
|
-
-
|
|
517
|
+
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
|
|
519
518
|
|
|
520
519
|
The secret store that contains the username and password for the serverless cluster.
|
|
521
520
|
|
|
@@ -523,7 +522,7 @@ The secret store that contains the username and password for the serverless clus
|
|
|
523
522
|
|
|
524
523
|
###### `databaseName`<sup>Optional</sup> <a name="databaseName" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.databaseName"></a>
|
|
525
524
|
|
|
526
|
-
-
|
|
525
|
+
- *Type:* string
|
|
527
526
|
|
|
528
527
|
The optional name of the database to use within the cluster.
|
|
529
528
|
|
|
@@ -531,7 +530,7 @@ The optional name of the database to use within the cluster.
|
|
|
531
530
|
|
|
532
531
|
###### `options`<sup>Optional</sup> <a name="options" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addRdsDataSource.parameter.options"></a>
|
|
533
532
|
|
|
534
|
-
-
|
|
533
|
+
- *Type:* aws-cdk-lib.aws_appsync.DataSourceOptions
|
|
535
534
|
|
|
536
535
|
The optional configuration for this data source.
|
|
537
536
|
|
|
@@ -549,7 +548,7 @@ This is a proxy method to the L2 GraphqlApi Construct.
|
|
|
549
548
|
|
|
550
549
|
###### `id`<sup>Required</sup> <a name="id" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver.parameter.id"></a>
|
|
551
550
|
|
|
552
|
-
-
|
|
551
|
+
- *Type:* string
|
|
553
552
|
|
|
554
553
|
The resolver's id.
|
|
555
554
|
|
|
@@ -557,7 +556,7 @@ The resolver's id.
|
|
|
557
556
|
|
|
558
557
|
###### `props`<sup>Required</sup> <a name="props" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.addResolver.parameter.props"></a>
|
|
559
558
|
|
|
560
|
-
-
|
|
559
|
+
- *Type:* aws-cdk-lib.aws_appsync.ExtendedResolverProps
|
|
561
560
|
|
|
562
561
|
the resolver properties.
|
|
563
562
|
|
|
@@ -565,8 +564,8 @@ the resolver properties.
|
|
|
565
564
|
|
|
566
565
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
567
566
|
|
|
568
|
-
| **Name**
|
|
569
|
-
|
|
|
567
|
+
| **Name** | **Description** |
|
|
568
|
+
| --- | --- |
|
|
570
569
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
571
570
|
|
|
572
571
|
---
|
|
@@ -583,7 +582,7 @@ Checks if `x` is a construct.
|
|
|
583
582
|
|
|
584
583
|
###### `x`<sup>Required</sup> <a name="x" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.isConstruct.parameter.x"></a>
|
|
585
584
|
|
|
586
|
-
-
|
|
585
|
+
- *Type:* any
|
|
587
586
|
|
|
588
587
|
Any object.
|
|
589
588
|
|
|
@@ -596,10 +595,10 @@ Any object.
|
|
|
596
595
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
597
596
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiId">apiId</a></code> | <code>string</code> | Generated Api Id. |
|
|
598
597
|
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.generatedFunctionSlots">generatedFunctionSlots</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot">MutationFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot">QueryFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot">SubscriptionFunctionSlot</a>[]</code> | Resolvers generated by the transform process, persisted on the side in order to facilitate pulling a manifest for the purposes of inspecting and producing overrides. |
|
|
599
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.graphqlUrl">graphqlUrl</a></code>
|
|
600
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.realtimeUrl">realtimeUrl</a></code>
|
|
601
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.resources">resources</a></code>
|
|
602
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiKey">apiKey</a></code>
|
|
598
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.graphqlUrl">graphqlUrl</a></code> | <code>string</code> | Graphql URL For the generated API. |
|
|
599
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.realtimeUrl">realtimeUrl</a></code> | <code>string</code> | Realtime URL For the generated API. |
|
|
600
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.resources">resources</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources">AmplifyGraphqlApiResources</a></code> | Generated L1 and L2 CDK resources. |
|
|
601
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApi.property.apiKey">apiKey</a></code> | <code>string</code> | Generated Api Key if generated. |
|
|
603
602
|
|
|
604
603
|
---
|
|
605
604
|
|
|
@@ -609,7 +608,7 @@ Any object.
|
|
|
609
608
|
public readonly node: Node;
|
|
610
609
|
```
|
|
611
610
|
|
|
612
|
-
-
|
|
611
|
+
- *Type:* constructs.Node
|
|
613
612
|
|
|
614
613
|
The tree node.
|
|
615
614
|
|
|
@@ -635,7 +634,7 @@ May be a CDK Token.
|
|
|
635
634
|
public readonly generatedFunctionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
|
636
635
|
```
|
|
637
636
|
|
|
638
|
-
-
|
|
637
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot">MutationFunctionSlot</a> | <a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot">QueryFunctionSlot</a> | <a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot">SubscriptionFunctionSlot</a>[]
|
|
639
638
|
|
|
640
639
|
Resolvers generated by the transform process, persisted on the side in order to facilitate pulling a manifest for the purposes of inspecting and producing overrides.
|
|
641
640
|
|
|
@@ -647,7 +646,7 @@ Resolvers generated by the transform process, persisted on the side in order to
|
|
|
647
646
|
public readonly graphqlUrl: string;
|
|
648
647
|
```
|
|
649
648
|
|
|
650
|
-
-
|
|
649
|
+
- *Type:* string
|
|
651
650
|
|
|
652
651
|
Graphql URL For the generated API.
|
|
653
652
|
|
|
@@ -661,7 +660,7 @@ May be a CDK Token.
|
|
|
661
660
|
public readonly realtimeUrl: string;
|
|
662
661
|
```
|
|
663
662
|
|
|
664
|
-
-
|
|
663
|
+
- *Type:* string
|
|
665
664
|
|
|
666
665
|
Realtime URL For the generated API.
|
|
667
666
|
|
|
@@ -675,7 +674,7 @@ May be a CDK Token.
|
|
|
675
674
|
public readonly resources: AmplifyGraphqlApiResources;
|
|
676
675
|
```
|
|
677
676
|
|
|
678
|
-
-
|
|
677
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlApiResources">AmplifyGraphqlApiResources</a>
|
|
679
678
|
|
|
680
679
|
Generated L1 and L2 CDK resources.
|
|
681
680
|
|
|
@@ -687,7 +686,7 @@ Generated L1 and L2 CDK resources.
|
|
|
687
686
|
public readonly apiKey: string;
|
|
688
687
|
```
|
|
689
688
|
|
|
690
|
-
-
|
|
689
|
+
- *Type:* string
|
|
691
690
|
|
|
692
691
|
Generated Api Key if generated.
|
|
693
692
|
|
|
@@ -695,6 +694,7 @@ May be a CDK Token.
|
|
|
695
694
|
|
|
696
695
|
---
|
|
697
696
|
|
|
697
|
+
|
|
698
698
|
## Structs <a name="Structs" id="Structs"></a>
|
|
699
699
|
|
|
700
700
|
### AddFunctionProps <a name="AddFunctionProps" id="@aws-amplify/graphql-api-construct.AddFunctionProps"></a>
|
|
@@ -711,15 +711,15 @@ const addFunctionProps: AddFunctionProps = { ... }
|
|
|
711
711
|
|
|
712
712
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
713
713
|
|
|
714
|
-
| **Name**
|
|
715
|
-
|
|
|
716
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.dataSource">dataSource</a></code>
|
|
717
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.name">name</a></code>
|
|
718
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.code">code</a></code>
|
|
719
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.description">description</a></code>
|
|
720
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.requestMappingTemplate">requestMappingTemplate</a></code>
|
|
714
|
+
| **Name** | **Type** | **Description** |
|
|
715
|
+
| --- | --- | --- |
|
|
716
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.dataSource">dataSource</a></code> | <code>aws-cdk-lib.aws_appsync.BaseDataSource</code> | the data source linked to this AppSync Function. |
|
|
717
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.name">name</a></code> | <code>string</code> | the name of the AppSync Function. |
|
|
718
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.code">code</a></code> | <code>aws-cdk-lib.aws_appsync.Code</code> | The function code. |
|
|
719
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.description">description</a></code> | <code>string</code> | the description for this AppSync Function. |
|
|
720
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.requestMappingTemplate">requestMappingTemplate</a></code> | <code>aws-cdk-lib.aws_appsync.MappingTemplate</code> | the request mapping template for the AppSync Function. |
|
|
721
721
|
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.responseMappingTemplate">responseMappingTemplate</a></code> | <code>aws-cdk-lib.aws_appsync.MappingTemplate</code> | the response mapping template for the AppSync Function. |
|
|
722
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.runtime">runtime</a></code>
|
|
722
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AddFunctionProps.property.runtime">runtime</a></code> | <code>aws-cdk-lib.aws_appsync.FunctionRuntime</code> | The functions runtime. |
|
|
723
723
|
|
|
724
724
|
---
|
|
725
725
|
|
|
@@ -729,7 +729,7 @@ const addFunctionProps: AddFunctionProps = { ... }
|
|
|
729
729
|
public readonly dataSource: BaseDataSource;
|
|
730
730
|
```
|
|
731
731
|
|
|
732
|
-
-
|
|
732
|
+
- *Type:* aws-cdk-lib.aws_appsync.BaseDataSource
|
|
733
733
|
|
|
734
734
|
the data source linked to this AppSync Function.
|
|
735
735
|
|
|
@@ -741,7 +741,7 @@ the data source linked to this AppSync Function.
|
|
|
741
741
|
public readonly name: string;
|
|
742
742
|
```
|
|
743
743
|
|
|
744
|
-
-
|
|
744
|
+
- *Type:* string
|
|
745
745
|
|
|
746
746
|
the name of the AppSync Function.
|
|
747
747
|
|
|
@@ -753,8 +753,8 @@ the name of the AppSync Function.
|
|
|
753
753
|
public readonly code: Code;
|
|
754
754
|
```
|
|
755
755
|
|
|
756
|
-
-
|
|
757
|
-
-
|
|
756
|
+
- *Type:* aws-cdk-lib.aws_appsync.Code
|
|
757
|
+
- *Default:* no code is used
|
|
758
758
|
|
|
759
759
|
The function code.
|
|
760
760
|
|
|
@@ -766,8 +766,8 @@ The function code.
|
|
|
766
766
|
public readonly description: string;
|
|
767
767
|
```
|
|
768
768
|
|
|
769
|
-
-
|
|
770
|
-
-
|
|
769
|
+
- *Type:* string
|
|
770
|
+
- *Default:* no description
|
|
771
771
|
|
|
772
772
|
the description for this AppSync Function.
|
|
773
773
|
|
|
@@ -779,8 +779,8 @@ the description for this AppSync Function.
|
|
|
779
779
|
public readonly requestMappingTemplate: MappingTemplate;
|
|
780
780
|
```
|
|
781
781
|
|
|
782
|
-
-
|
|
783
|
-
-
|
|
782
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
783
|
+
- *Default:* no request mapping template
|
|
784
784
|
|
|
785
785
|
the request mapping template for the AppSync Function.
|
|
786
786
|
|
|
@@ -792,8 +792,8 @@ the request mapping template for the AppSync Function.
|
|
|
792
792
|
public readonly responseMappingTemplate: MappingTemplate;
|
|
793
793
|
```
|
|
794
794
|
|
|
795
|
-
-
|
|
796
|
-
-
|
|
795
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
796
|
+
- *Default:* no response mapping template
|
|
797
797
|
|
|
798
798
|
the response mapping template for the AppSync Function.
|
|
799
799
|
|
|
@@ -805,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,25 +1311,27 @@ 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
|
|
|
1326
|
-
#####
|
|
1326
|
+
##### ~~`adminRoles`~~<sup>Optional</sup> <a name="adminRoles" id="@aws-amplify/graphql-api-construct.AuthorizationModes.property.adminRoles"></a>
|
|
1327
|
+
|
|
1328
|
+
- *Deprecated:* , use iamConfig.allowListedRoles instead.
|
|
1327
1329
|
|
|
1328
1330
|
```typescript
|
|
1329
1331
|
public readonly adminRoles: IRole[];
|
|
1330
1332
|
```
|
|
1331
1333
|
|
|
1332
|
-
-
|
|
1334
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole[]
|
|
1333
1335
|
|
|
1334
1336
|
A list of roles granted full R/W access to the Api.
|
|
1335
1337
|
|
|
@@ -1341,7 +1343,7 @@ A list of roles granted full R/W access to the Api.
|
|
|
1341
1343
|
public readonly apiKeyConfig: ApiKeyAuthorizationConfig;
|
|
1342
1344
|
```
|
|
1343
1345
|
|
|
1344
|
-
-
|
|
1346
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.ApiKeyAuthorizationConfig">ApiKeyAuthorizationConfig</a>
|
|
1345
1347
|
|
|
1346
1348
|
AppSync Api Key config, required if a 'apiKey' auth provider is specified in the Api.
|
|
1347
1349
|
|
|
@@ -1355,7 +1357,7 @@ Applies to 'public' auth strategy.
|
|
|
1355
1357
|
public readonly defaultAuthorizationMode: string;
|
|
1356
1358
|
```
|
|
1357
1359
|
|
|
1358
|
-
-
|
|
1360
|
+
- *Type:* string
|
|
1359
1361
|
|
|
1360
1362
|
Default auth mode to provide to the Api, required if more than one config type is specified.
|
|
1361
1363
|
|
|
@@ -1367,7 +1369,7 @@ Default auth mode to provide to the Api, required if more than one config type i
|
|
|
1367
1369
|
public readonly iamConfig: IAMAuthorizationConfig;
|
|
1368
1370
|
```
|
|
1369
1371
|
|
|
1370
|
-
-
|
|
1372
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig">IAMAuthorizationConfig</a>
|
|
1371
1373
|
|
|
1372
1374
|
IAM Auth config, required if an 'iam' auth provider is specified in the Api.
|
|
1373
1375
|
|
|
@@ -1381,7 +1383,7 @@ Applies to 'public' and 'private' auth strategies.
|
|
|
1381
1383
|
public readonly lambdaConfig: LambdaAuthorizationConfig;
|
|
1382
1384
|
```
|
|
1383
1385
|
|
|
1384
|
-
-
|
|
1386
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig">LambdaAuthorizationConfig</a>
|
|
1385
1387
|
|
|
1386
1388
|
Lambda config, required if a 'function' auth provider is specified in the Api.
|
|
1387
1389
|
|
|
@@ -1395,7 +1397,7 @@ Applies to 'custom' auth strategy.
|
|
|
1395
1397
|
public readonly oidcConfig: OIDCAuthorizationConfig;
|
|
1396
1398
|
```
|
|
1397
1399
|
|
|
1398
|
-
-
|
|
1400
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig">OIDCAuthorizationConfig</a>
|
|
1399
1401
|
|
|
1400
1402
|
Cognito OIDC config, required if a 'oidc' auth provider is specified in the Api.
|
|
1401
1403
|
|
|
@@ -1409,7 +1411,7 @@ Applies to 'owner', 'private', and 'group' auth strategies.
|
|
|
1409
1411
|
public readonly userPoolConfig: UserPoolAuthorizationConfig;
|
|
1410
1412
|
```
|
|
1411
1413
|
|
|
1412
|
-
-
|
|
1414
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.UserPoolAuthorizationConfig">UserPoolAuthorizationConfig</a>
|
|
1413
1415
|
|
|
1414
1416
|
Cognito UserPool config, required if a 'userPools' auth provider is specified in the Api.
|
|
1415
1417
|
|
|
@@ -1431,10 +1433,10 @@ const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy =
|
|
|
1431
1433
|
|
|
1432
1434
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1433
1435
|
|
|
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>
|
|
1436
|
+
| **Name** | **Type** | **Description** |
|
|
1437
|
+
| --- | --- | --- |
|
|
1438
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AutomergeConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
1439
|
+
| <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
1440
|
|
|
1439
1441
|
---
|
|
1440
1442
|
|
|
@@ -1444,7 +1446,7 @@ const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy =
|
|
|
1444
1446
|
public readonly detectionType: string;
|
|
1445
1447
|
```
|
|
1446
1448
|
|
|
1447
|
-
-
|
|
1449
|
+
- *Type:* string
|
|
1448
1450
|
|
|
1449
1451
|
The conflict detection type used for resolution.
|
|
1450
1452
|
|
|
@@ -1456,7 +1458,7 @@ The conflict detection type used for resolution.
|
|
|
1456
1458
|
public readonly handlerType: string;
|
|
1457
1459
|
```
|
|
1458
1460
|
|
|
1459
|
-
-
|
|
1461
|
+
- *Type:* string
|
|
1460
1462
|
|
|
1461
1463
|
This conflict resolution strategy executes an auto-merge.
|
|
1462
1464
|
|
|
@@ -1478,10 +1480,10 @@ const conflictResolution: ConflictResolution = { ... }
|
|
|
1478
1480
|
|
|
1479
1481
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1480
1482
|
|
|
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>
|
|
1483
|
+
| **Name** | **Type** | **Description** |
|
|
1484
|
+
| --- | --- | --- |
|
|
1485
|
+
| <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. |
|
|
1486
|
+
| <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
1487
|
|
|
1486
1488
|
---
|
|
1487
1489
|
|
|
@@ -1491,7 +1493,7 @@ const conflictResolution: ConflictResolution = { ... }
|
|
|
1491
1493
|
public readonly models: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy};
|
|
1492
1494
|
```
|
|
1493
1495
|
|
|
1494
|
-
-
|
|
1496
|
+
- *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
1497
|
|
|
1496
1498
|
Model-specific conflict resolution overrides.
|
|
1497
1499
|
|
|
@@ -1503,7 +1505,7 @@ Model-specific conflict resolution overrides.
|
|
|
1503
1505
|
public readonly project: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy;
|
|
1504
1506
|
```
|
|
1505
1507
|
|
|
1506
|
-
-
|
|
1508
|
+
- *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
1509
|
|
|
1508
1510
|
Project-wide config for conflict resolution.
|
|
1509
1511
|
|
|
@@ -1525,8 +1527,8 @@ const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }
|
|
|
1525
1527
|
|
|
1526
1528
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1527
1529
|
|
|
1528
|
-
| **Name**
|
|
1529
|
-
|
|
|
1530
|
+
| **Name** | **Type** | **Description** |
|
|
1531
|
+
| --- | --- | --- |
|
|
1530
1532
|
| <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
1533
|
|
|
1532
1534
|
---
|
|
@@ -1537,7 +1539,7 @@ const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }
|
|
|
1537
1539
|
public readonly detectionType: string;
|
|
1538
1540
|
```
|
|
1539
1541
|
|
|
1540
|
-
-
|
|
1542
|
+
- *Type:* string
|
|
1541
1543
|
|
|
1542
1544
|
The conflict detection type used for resolution.
|
|
1543
1545
|
|
|
@@ -1557,11 +1559,11 @@ const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ...
|
|
|
1557
1559
|
|
|
1558
1560
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1559
1561
|
|
|
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>
|
|
1562
|
+
| **Name** | **Type** | **Description** |
|
|
1563
|
+
| --- | --- | --- |
|
|
1564
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.CustomConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
1565
|
+
| <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. |
|
|
1566
|
+
| <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
1567
|
|
|
1566
1568
|
---
|
|
1567
1569
|
|
|
@@ -1571,7 +1573,7 @@ const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ...
|
|
|
1571
1573
|
public readonly detectionType: string;
|
|
1572
1574
|
```
|
|
1573
1575
|
|
|
1574
|
-
-
|
|
1576
|
+
- *Type:* string
|
|
1575
1577
|
|
|
1576
1578
|
The conflict detection type used for resolution.
|
|
1577
1579
|
|
|
@@ -1583,7 +1585,7 @@ The conflict detection type used for resolution.
|
|
|
1583
1585
|
public readonly conflictHandler: IFunction;
|
|
1584
1586
|
```
|
|
1585
1587
|
|
|
1586
|
-
-
|
|
1588
|
+
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
1587
1589
|
|
|
1588
1590
|
The function which will be invoked for conflict resolution.
|
|
1589
1591
|
|
|
@@ -1595,7 +1597,7 @@ The function which will be invoked for conflict resolution.
|
|
|
1595
1597
|
public readonly handlerType: string;
|
|
1596
1598
|
```
|
|
1597
1599
|
|
|
1598
|
-
-
|
|
1600
|
+
- *Type:* string
|
|
1599
1601
|
|
|
1600
1602
|
This conflict resolution strategy uses a lambda handler type.
|
|
1601
1603
|
|
|
@@ -1617,11 +1619,11 @@ const functionSlotBase: FunctionSlotBase = { ... }
|
|
|
1617
1619
|
|
|
1618
1620
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1619
1621
|
|
|
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>
|
|
1622
|
+
| **Name** | **Type** | **Description** |
|
|
1623
|
+
| --- | --- | --- |
|
|
1624
|
+
| <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. |
|
|
1625
|
+
| <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. |
|
|
1626
|
+
| <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
1627
|
|
|
1626
1628
|
---
|
|
1627
1629
|
|
|
@@ -1631,7 +1633,7 @@ const functionSlotBase: FunctionSlotBase = { ... }
|
|
|
1631
1633
|
public readonly fieldName: string;
|
|
1632
1634
|
```
|
|
1633
1635
|
|
|
1634
|
-
-
|
|
1636
|
+
- *Type:* string
|
|
1635
1637
|
|
|
1636
1638
|
The field to attach this function to on the Api definition.
|
|
1637
1639
|
|
|
@@ -1643,7 +1645,7 @@ The field to attach this function to on the Api definition.
|
|
|
1643
1645
|
public readonly function: FunctionSlotOverride;
|
|
1644
1646
|
```
|
|
1645
1647
|
|
|
1646
|
-
-
|
|
1648
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
1647
1649
|
|
|
1648
1650
|
The overridden behavior for this slot.
|
|
1649
1651
|
|
|
@@ -1655,7 +1657,7 @@ The overridden behavior for this slot.
|
|
|
1655
1657
|
public readonly slotIndex: number;
|
|
1656
1658
|
```
|
|
1657
1659
|
|
|
1658
|
-
-
|
|
1660
|
+
- *Type:* number
|
|
1659
1661
|
|
|
1660
1662
|
The slot index to use to inject this into the execution pipeline.
|
|
1661
1663
|
|
|
@@ -1680,9 +1682,9 @@ const functionSlotOverride: FunctionSlotOverride = { ... }
|
|
|
1680
1682
|
|
|
1681
1683
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1682
1684
|
|
|
1683
|
-
| **Name**
|
|
1684
|
-
|
|
|
1685
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride.property.requestMappingTemplate">requestMappingTemplate</a></code>
|
|
1685
|
+
| **Name** | **Type** | **Description** |
|
|
1686
|
+
| --- | --- | --- |
|
|
1687
|
+
| <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
1688
|
| <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
1689
|
|
|
1688
1690
|
---
|
|
@@ -1693,7 +1695,7 @@ const functionSlotOverride: FunctionSlotOverride = { ... }
|
|
|
1693
1695
|
public readonly requestMappingTemplate: MappingTemplate;
|
|
1694
1696
|
```
|
|
1695
1697
|
|
|
1696
|
-
-
|
|
1698
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
1697
1699
|
|
|
1698
1700
|
Override request mapping template for the function slot.
|
|
1699
1701
|
|
|
@@ -1707,7 +1709,7 @@ Executed before the datasource is invoked.
|
|
|
1707
1709
|
public readonly responseMappingTemplate: MappingTemplate;
|
|
1708
1710
|
```
|
|
1709
1711
|
|
|
1710
|
-
-
|
|
1712
|
+
- *Type:* aws-cdk-lib.aws_appsync.MappingTemplate
|
|
1711
1713
|
|
|
1712
1714
|
Override response mapping template for the function slot.
|
|
1713
1715
|
|
|
@@ -1729,11 +1731,12 @@ const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }
|
|
|
1729
1731
|
|
|
1730
1732
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1731
1733
|
|
|
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>
|
|
1734
|
+
| **Name** | **Type** | **Description** |
|
|
1735
|
+
| --- | --- | --- |
|
|
1736
|
+
| <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. |
|
|
1737
|
+
| <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
1738
|
| <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. |
|
|
1739
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.allowListedRoles">allowListedRoles</a></code> | <code>string \| aws-cdk-lib.aws_iam.IRole[]</code> | A list of IAM roles which will be granted full read/write access to the generated model if IAM auth is enabled. |
|
|
1737
1740
|
|
|
1738
1741
|
---
|
|
1739
1742
|
|
|
@@ -1743,7 +1746,7 @@ const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }
|
|
|
1743
1746
|
public readonly authenticatedUserRole: IRole;
|
|
1744
1747
|
```
|
|
1745
1748
|
|
|
1746
|
-
-
|
|
1749
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1747
1750
|
|
|
1748
1751
|
Authenticated user role, applies to { provider: iam, allow: private } access.
|
|
1749
1752
|
|
|
@@ -1755,7 +1758,7 @@ Authenticated user role, applies to { provider: iam, allow: private } access.
|
|
|
1755
1758
|
public readonly identityPoolId: string;
|
|
1756
1759
|
```
|
|
1757
1760
|
|
|
1758
|
-
-
|
|
1761
|
+
- *Type:* string
|
|
1759
1762
|
|
|
1760
1763
|
ID for the Cognito Identity Pool vending auth and unauth roles.
|
|
1761
1764
|
|
|
@@ -1769,12 +1772,27 @@ Format: `<region>:<id string>`
|
|
|
1769
1772
|
public readonly unauthenticatedUserRole: IRole;
|
|
1770
1773
|
```
|
|
1771
1774
|
|
|
1772
|
-
-
|
|
1775
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1773
1776
|
|
|
1774
1777
|
Unauthenticated user role, applies to { provider: iam, allow: public } access.
|
|
1775
1778
|
|
|
1776
1779
|
---
|
|
1777
1780
|
|
|
1781
|
+
##### `allowListedRoles`<sup>Optional</sup> <a name="allowListedRoles" id="@aws-amplify/graphql-api-construct.IAMAuthorizationConfig.property.allowListedRoles"></a>
|
|
1782
|
+
|
|
1783
|
+
```typescript
|
|
1784
|
+
public readonly allowListedRoles: string | IRole[];
|
|
1785
|
+
```
|
|
1786
|
+
|
|
1787
|
+
- *Type:* string | aws-cdk-lib.aws_iam.IRole[]
|
|
1788
|
+
|
|
1789
|
+
A list of IAM roles which will be granted full read/write access to the generated model if IAM auth is enabled.
|
|
1790
|
+
|
|
1791
|
+
If an IRole is provided, the role `name` will be used for matching.
|
|
1792
|
+
If a string is provided, the raw value will be used for matching.
|
|
1793
|
+
|
|
1794
|
+
---
|
|
1795
|
+
|
|
1778
1796
|
### LambdaAuthorizationConfig <a name="LambdaAuthorizationConfig" id="@aws-amplify/graphql-api-construct.LambdaAuthorizationConfig"></a>
|
|
1779
1797
|
|
|
1780
1798
|
Configuration for Custom Lambda authorization on the Graphql Api.
|
|
@@ -1789,10 +1807,10 @@ const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }
|
|
|
1789
1807
|
|
|
1790
1808
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1791
1809
|
|
|
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>
|
|
1810
|
+
| **Name** | **Type** | **Description** |
|
|
1811
|
+
| --- | --- | --- |
|
|
1812
|
+
| <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. |
|
|
1813
|
+
| <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
1814
|
|
|
1797
1815
|
---
|
|
1798
1816
|
|
|
@@ -1802,7 +1820,7 @@ const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }
|
|
|
1802
1820
|
public readonly function: IFunction;
|
|
1803
1821
|
```
|
|
1804
1822
|
|
|
1805
|
-
-
|
|
1823
|
+
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
1806
1824
|
|
|
1807
1825
|
The authorizer lambda function.
|
|
1808
1826
|
|
|
@@ -1814,7 +1832,7 @@ The authorizer lambda function.
|
|
|
1814
1832
|
public readonly ttl: Duration;
|
|
1815
1833
|
```
|
|
1816
1834
|
|
|
1817
|
-
-
|
|
1835
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1818
1836
|
|
|
1819
1837
|
How long the results are cached.
|
|
1820
1838
|
|
|
@@ -1834,13 +1852,13 @@ const mutationFunctionSlot: MutationFunctionSlot = { ... }
|
|
|
1834
1852
|
|
|
1835
1853
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1836
1854
|
|
|
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>
|
|
1855
|
+
| **Name** | **Type** | **Description** |
|
|
1856
|
+
| --- | --- | --- |
|
|
1857
|
+
| <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. |
|
|
1858
|
+
| <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. |
|
|
1859
|
+
| <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. |
|
|
1860
|
+
| <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. |
|
|
1861
|
+
| <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
1862
|
|
|
1845
1863
|
---
|
|
1846
1864
|
|
|
@@ -1850,7 +1868,7 @@ const mutationFunctionSlot: MutationFunctionSlot = { ... }
|
|
|
1850
1868
|
public readonly fieldName: string;
|
|
1851
1869
|
```
|
|
1852
1870
|
|
|
1853
|
-
-
|
|
1871
|
+
- *Type:* string
|
|
1854
1872
|
|
|
1855
1873
|
The field to attach this function to on the Api definition.
|
|
1856
1874
|
|
|
@@ -1862,7 +1880,7 @@ The field to attach this function to on the Api definition.
|
|
|
1862
1880
|
public readonly function: FunctionSlotOverride;
|
|
1863
1881
|
```
|
|
1864
1882
|
|
|
1865
|
-
-
|
|
1883
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
1866
1884
|
|
|
1867
1885
|
The overridden behavior for this slot.
|
|
1868
1886
|
|
|
@@ -1874,7 +1892,7 @@ The overridden behavior for this slot.
|
|
|
1874
1892
|
public readonly slotIndex: number;
|
|
1875
1893
|
```
|
|
1876
1894
|
|
|
1877
|
-
-
|
|
1895
|
+
- *Type:* number
|
|
1878
1896
|
|
|
1879
1897
|
The slot index to use to inject this into the execution pipeline.
|
|
1880
1898
|
|
|
@@ -1888,7 +1906,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
1888
1906
|
public readonly slotName: string;
|
|
1889
1907
|
```
|
|
1890
1908
|
|
|
1891
|
-
-
|
|
1909
|
+
- *Type:* string
|
|
1892
1910
|
|
|
1893
1911
|
The slot name to inject this behavior into.
|
|
1894
1912
|
|
|
@@ -1902,7 +1920,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
1902
1920
|
public readonly typeName: string;
|
|
1903
1921
|
```
|
|
1904
1922
|
|
|
1905
|
-
-
|
|
1923
|
+
- *Type:* string
|
|
1906
1924
|
|
|
1907
1925
|
This slot type applies to the Mutation type on the Api definition.
|
|
1908
1926
|
|
|
@@ -1922,13 +1940,13 @@ const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }
|
|
|
1922
1940
|
|
|
1923
1941
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
1924
1942
|
|
|
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>
|
|
1943
|
+
| **Name** | **Type** | **Description** |
|
|
1944
|
+
| --- | --- | --- |
|
|
1945
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcIssuerUrl">oidcIssuerUrl</a></code> | <code>string</code> | Url for the OIDC token issuer. |
|
|
1946
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OIDCAuthorizationConfig.property.oidcProviderName">oidcProviderName</a></code> | <code>string</code> | The issuer for the OIDC configuration. |
|
|
1947
|
+
| <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. |
|
|
1948
|
+
| <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. |
|
|
1949
|
+
| <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
1950
|
|
|
1933
1951
|
---
|
|
1934
1952
|
|
|
@@ -1938,7 +1956,7 @@ const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }
|
|
|
1938
1956
|
public readonly oidcIssuerUrl: string;
|
|
1939
1957
|
```
|
|
1940
1958
|
|
|
1941
|
-
-
|
|
1959
|
+
- *Type:* string
|
|
1942
1960
|
|
|
1943
1961
|
Url for the OIDC token issuer.
|
|
1944
1962
|
|
|
@@ -1950,7 +1968,7 @@ Url for the OIDC token issuer.
|
|
|
1950
1968
|
public readonly oidcProviderName: string;
|
|
1951
1969
|
```
|
|
1952
1970
|
|
|
1953
|
-
-
|
|
1971
|
+
- *Type:* string
|
|
1954
1972
|
|
|
1955
1973
|
The issuer for the OIDC configuration.
|
|
1956
1974
|
|
|
@@ -1962,7 +1980,7 @@ The issuer for the OIDC configuration.
|
|
|
1962
1980
|
public readonly tokenExpiryFromAuth: Duration;
|
|
1963
1981
|
```
|
|
1964
1982
|
|
|
1965
|
-
-
|
|
1983
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1966
1984
|
|
|
1967
1985
|
The duration an OIDC token is valid after being authenticated by OIDC provider.
|
|
1968
1986
|
|
|
@@ -1976,7 +1994,7 @@ auth_time claim in OIDC token is required for this validation to work.
|
|
|
1976
1994
|
public readonly tokenExpiryFromIssue: Duration;
|
|
1977
1995
|
```
|
|
1978
1996
|
|
|
1979
|
-
-
|
|
1997
|
+
- *Type:* aws-cdk-lib.Duration
|
|
1980
1998
|
|
|
1981
1999
|
The duration an OIDC token is valid after being issued to a user.
|
|
1982
2000
|
|
|
@@ -1990,7 +2008,7 @@ This validation uses iat claim of OIDC token.
|
|
|
1990
2008
|
public readonly clientId: string;
|
|
1991
2009
|
```
|
|
1992
2010
|
|
|
1993
|
-
-
|
|
2011
|
+
- *Type:* string
|
|
1994
2012
|
|
|
1995
2013
|
The client identifier of the Relying party at the OpenID identity provider.
|
|
1996
2014
|
|
|
@@ -2012,10 +2030,10 @@ const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy
|
|
|
2012
2030
|
|
|
2013
2031
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2014
2032
|
|
|
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>
|
|
2033
|
+
| **Name** | **Type** | **Description** |
|
|
2034
|
+
| --- | --- | --- |
|
|
2035
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.OptimisticConflictResolutionStrategy.property.detectionType">detectionType</a></code> | <code>string</code> | The conflict detection type used for resolution. |
|
|
2036
|
+
| <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
2037
|
|
|
2020
2038
|
---
|
|
2021
2039
|
|
|
@@ -2025,7 +2043,7 @@ const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy
|
|
|
2025
2043
|
public readonly detectionType: string;
|
|
2026
2044
|
```
|
|
2027
2045
|
|
|
2028
|
-
-
|
|
2046
|
+
- *Type:* string
|
|
2029
2047
|
|
|
2030
2048
|
The conflict detection type used for resolution.
|
|
2031
2049
|
|
|
@@ -2037,9 +2055,9 @@ The conflict detection type used for resolution.
|
|
|
2037
2055
|
public readonly handlerType: string;
|
|
2038
2056
|
```
|
|
2039
2057
|
|
|
2040
|
-
-
|
|
2058
|
+
- *Type:* string
|
|
2041
2059
|
|
|
2042
|
-
This conflict resolution strategy the
|
|
2060
|
+
This conflict resolution strategy the _version to perform optimistic concurrency.
|
|
2043
2061
|
|
|
2044
2062
|
For more information, refer to https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html#conflict-detection-and-resolution
|
|
2045
2063
|
|
|
@@ -2059,19 +2077,19 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
|
|
|
2059
2077
|
|
|
2060
2078
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2061
2079
|
|
|
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>
|
|
2080
|
+
| **Name** | **Type** | **Description** |
|
|
2081
|
+
| --- | --- | --- |
|
|
2082
|
+
| <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. |
|
|
2083
|
+
| <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. |
|
|
2084
|
+
| <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). |
|
|
2085
|
+
| <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. |
|
|
2086
|
+
| <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. |
|
|
2087
|
+
| <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. |
|
|
2088
|
+
| <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. |
|
|
2089
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code> | <code>boolean</code> | If disabled, generated. |
|
|
2090
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code> | <code>boolean</code> | Restore parity w/ GQLv1. |
|
|
2091
|
+
| <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. |
|
|
2092
|
+
| <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
2093
|
|
|
2076
2094
|
---
|
|
2077
2095
|
|
|
@@ -2081,8 +2099,8 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
|
|
|
2081
2099
|
public readonly disableResolverDeduping: boolean;
|
|
2082
2100
|
```
|
|
2083
2101
|
|
|
2084
|
-
-
|
|
2085
|
-
-
|
|
2102
|
+
- *Type:* boolean
|
|
2103
|
+
- *Default:* true
|
|
2086
2104
|
|
|
2087
2105
|
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
2106
|
|
|
@@ -2094,8 +2112,8 @@ Disable resolver deduping, this can sometimes cause problems because dedupe orde
|
|
|
2094
2112
|
public readonly enableAutoIndexQueryNames: boolean;
|
|
2095
2113
|
```
|
|
2096
2114
|
|
|
2097
|
-
-
|
|
2098
|
-
-
|
|
2115
|
+
- *Type:* boolean
|
|
2116
|
+
- *Default:* true
|
|
2099
2117
|
|
|
2100
2118
|
Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.
|
|
2101
2119
|
|
|
@@ -2109,14 +2127,14 @@ If enabled,
|
|
|
2109
2127
|
public readonly enableSearchNodeToNodeEncryption: boolean;
|
|
2110
2128
|
```
|
|
2111
2129
|
|
|
2112
|
-
-
|
|
2113
|
-
-
|
|
2130
|
+
- *Type:* boolean
|
|
2131
|
+
- *Default:* false
|
|
2114
2132
|
|
|
2115
2133
|
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
|
2116
2134
|
|
|
2117
2135
|
Not recommended for use, prefer
|
|
2118
2136
|
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
|
2119
|
-
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2137
|
+
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2120
2138
|
});
|
|
2121
2139
|
|
|
2122
2140
|
---
|
|
@@ -2127,8 +2145,8 @@ domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
|
2127
2145
|
public readonly enableTransformerCfnOutputs: boolean;
|
|
2128
2146
|
```
|
|
2129
2147
|
|
|
2130
|
-
-
|
|
2131
|
-
-
|
|
2148
|
+
- *Type:* boolean
|
|
2149
|
+
- *Default:* false
|
|
2132
2150
|
|
|
2133
2151
|
When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.
|
|
2134
2152
|
|
|
@@ -2140,8 +2158,8 @@ When enabled, internal cfn outputs which existed in Amplify-generated apps will
|
|
|
2140
2158
|
public readonly populateOwnerFieldForStaticGroupAuth: boolean;
|
|
2141
2159
|
```
|
|
2142
2160
|
|
|
2143
|
-
-
|
|
2144
|
-
-
|
|
2161
|
+
- *Type:* boolean
|
|
2162
|
+
- *Default:* true
|
|
2145
2163
|
|
|
2146
2164
|
Ensure that the owner field is still populated even if a static iam or group authorization applies.
|
|
2147
2165
|
|
|
@@ -2153,8 +2171,8 @@ Ensure that the owner field is still populated even if a static iam or group aut
|
|
|
2153
2171
|
public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;
|
|
2154
2172
|
```
|
|
2155
2173
|
|
|
2156
|
-
-
|
|
2157
|
-
-
|
|
2174
|
+
- *Type:* boolean
|
|
2175
|
+
- *Default:* true
|
|
2158
2176
|
|
|
2159
2177
|
Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.
|
|
2160
2178
|
|
|
@@ -2166,8 +2184,8 @@ Enable custom primary key support, there's no good reason to disable this unless
|
|
|
2166
2184
|
public readonly sandboxModeEnabled: boolean;
|
|
2167
2185
|
```
|
|
2168
2186
|
|
|
2169
|
-
-
|
|
2170
|
-
-
|
|
2187
|
+
- *Type:* boolean
|
|
2188
|
+
- *Default:* false
|
|
2171
2189
|
|
|
2172
2190
|
Enabling sandbox mode will enable api key auth on all models in the transformed schema.
|
|
2173
2191
|
|
|
@@ -2179,8 +2197,8 @@ Enabling sandbox mode will enable api key auth on all models in the transformed
|
|
|
2179
2197
|
public readonly secondaryKeyAsGSI: boolean;
|
|
2180
2198
|
```
|
|
2181
2199
|
|
|
2182
|
-
-
|
|
2183
|
-
-
|
|
2200
|
+
- *Type:* boolean
|
|
2201
|
+
- *Default:* true
|
|
2184
2202
|
|
|
2185
2203
|
If disabled, generated.
|
|
2186
2204
|
|
|
@@ -2192,8 +2210,8 @@ If disabled, generated.
|
|
|
2192
2210
|
public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
|
|
2193
2211
|
```
|
|
2194
2212
|
|
|
2195
|
-
-
|
|
2196
|
-
-
|
|
2213
|
+
- *Type:* boolean
|
|
2214
|
+
- *Default:* true
|
|
2197
2215
|
|
|
2198
2216
|
Restore parity w/ GQLv1.
|
|
2199
2217
|
|
|
@@ -2205,8 +2223,8 @@ Restore parity w/ GQLv1.
|
|
|
2205
2223
|
public readonly suppressApiKeyGeneration: boolean;
|
|
2206
2224
|
```
|
|
2207
2225
|
|
|
2208
|
-
-
|
|
2209
|
-
-
|
|
2226
|
+
- *Type:* boolean
|
|
2227
|
+
- *Default:* false
|
|
2210
2228
|
|
|
2211
2229
|
If enabled, disable api key resource generation even if specified as an auth rule on the construct.
|
|
2212
2230
|
|
|
@@ -2220,8 +2238,8 @@ This is a legacy parameter from the Graphql Transformer existing in Amplify CLI,
|
|
|
2220
2238
|
public readonly useSubUsernameForDefaultIdentityClaim: boolean;
|
|
2221
2239
|
```
|
|
2222
2240
|
|
|
2223
|
-
-
|
|
2224
|
-
-
|
|
2241
|
+
- *Type:* boolean
|
|
2242
|
+
- *Default:* true
|
|
2225
2243
|
|
|
2226
2244
|
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
2245
|
|
|
@@ -2241,13 +2259,13 @@ const queryFunctionSlot: QueryFunctionSlot = { ... }
|
|
|
2241
2259
|
|
|
2242
2260
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2243
2261
|
|
|
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>
|
|
2262
|
+
| **Name** | **Type** | **Description** |
|
|
2263
|
+
| --- | --- | --- |
|
|
2264
|
+
| <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. |
|
|
2265
|
+
| <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. |
|
|
2266
|
+
| <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. |
|
|
2267
|
+
| <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. |
|
|
2268
|
+
| <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
2269
|
|
|
2252
2270
|
---
|
|
2253
2271
|
|
|
@@ -2257,7 +2275,7 @@ const queryFunctionSlot: QueryFunctionSlot = { ... }
|
|
|
2257
2275
|
public readonly fieldName: string;
|
|
2258
2276
|
```
|
|
2259
2277
|
|
|
2260
|
-
-
|
|
2278
|
+
- *Type:* string
|
|
2261
2279
|
|
|
2262
2280
|
The field to attach this function to on the Api definition.
|
|
2263
2281
|
|
|
@@ -2269,7 +2287,7 @@ The field to attach this function to on the Api definition.
|
|
|
2269
2287
|
public readonly function: FunctionSlotOverride;
|
|
2270
2288
|
```
|
|
2271
2289
|
|
|
2272
|
-
-
|
|
2290
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
2273
2291
|
|
|
2274
2292
|
The overridden behavior for this slot.
|
|
2275
2293
|
|
|
@@ -2281,7 +2299,7 @@ The overridden behavior for this slot.
|
|
|
2281
2299
|
public readonly slotIndex: number;
|
|
2282
2300
|
```
|
|
2283
2301
|
|
|
2284
|
-
-
|
|
2302
|
+
- *Type:* number
|
|
2285
2303
|
|
|
2286
2304
|
The slot index to use to inject this into the execution pipeline.
|
|
2287
2305
|
|
|
@@ -2295,7 +2313,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
2295
2313
|
public readonly slotName: string;
|
|
2296
2314
|
```
|
|
2297
2315
|
|
|
2298
|
-
-
|
|
2316
|
+
- *Type:* string
|
|
2299
2317
|
|
|
2300
2318
|
The slot name to inject this behavior into.
|
|
2301
2319
|
|
|
@@ -2309,7 +2327,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
2309
2327
|
public readonly typeName: string;
|
|
2310
2328
|
```
|
|
2311
2329
|
|
|
2312
|
-
-
|
|
2330
|
+
- *Type:* string
|
|
2313
2331
|
|
|
2314
2332
|
This slot type applies to the Query type on the Api definition.
|
|
2315
2333
|
|
|
@@ -2329,13 +2347,13 @@ const subscriptionFunctionSlot: SubscriptionFunctionSlot = { ... }
|
|
|
2329
2347
|
|
|
2330
2348
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2331
2349
|
|
|
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>
|
|
2350
|
+
| **Name** | **Type** | **Description** |
|
|
2351
|
+
| --- | --- | --- |
|
|
2352
|
+
| <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. |
|
|
2353
|
+
| <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. |
|
|
2354
|
+
| <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. |
|
|
2355
|
+
| <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. |
|
|
2356
|
+
| <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
2357
|
|
|
2340
2358
|
---
|
|
2341
2359
|
|
|
@@ -2345,7 +2363,7 @@ const subscriptionFunctionSlot: SubscriptionFunctionSlot = { ... }
|
|
|
2345
2363
|
public readonly fieldName: string;
|
|
2346
2364
|
```
|
|
2347
2365
|
|
|
2348
|
-
-
|
|
2366
|
+
- *Type:* string
|
|
2349
2367
|
|
|
2350
2368
|
The field to attach this function to on the Api definition.
|
|
2351
2369
|
|
|
@@ -2357,7 +2375,7 @@ The field to attach this function to on the Api definition.
|
|
|
2357
2375
|
public readonly function: FunctionSlotOverride;
|
|
2358
2376
|
```
|
|
2359
2377
|
|
|
2360
|
-
-
|
|
2378
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.FunctionSlotOverride">FunctionSlotOverride</a>
|
|
2361
2379
|
|
|
2362
2380
|
The overridden behavior for this slot.
|
|
2363
2381
|
|
|
@@ -2369,7 +2387,7 @@ The overridden behavior for this slot.
|
|
|
2369
2387
|
public readonly slotIndex: number;
|
|
2370
2388
|
```
|
|
2371
2389
|
|
|
2372
|
-
-
|
|
2390
|
+
- *Type:* number
|
|
2373
2391
|
|
|
2374
2392
|
The slot index to use to inject this into the execution pipeline.
|
|
2375
2393
|
|
|
@@ -2383,7 +2401,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
2383
2401
|
public readonly slotName: string;
|
|
2384
2402
|
```
|
|
2385
2403
|
|
|
2386
|
-
-
|
|
2404
|
+
- *Type:* string
|
|
2387
2405
|
|
|
2388
2406
|
The slot name to inject this behavior into.
|
|
2389
2407
|
|
|
@@ -2397,7 +2415,7 @@ For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/
|
|
|
2397
2415
|
public readonly typeName: string;
|
|
2398
2416
|
```
|
|
2399
2417
|
|
|
2400
|
-
-
|
|
2418
|
+
- *Type:* string
|
|
2401
2419
|
|
|
2402
2420
|
This slot type applies to the Subscription type on the Api definition.
|
|
2403
2421
|
|
|
@@ -2421,19 +2439,19 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
|
2421
2439
|
|
|
2422
2440
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2423
2441
|
|
|
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>
|
|
2442
|
+
| **Name** | **Type** | **Description** |
|
|
2443
|
+
| --- | --- | --- |
|
|
2444
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.disableResolverDeduping">disableResolverDeduping</a></code> | <code>boolean</code> | Disable resolver deduping, this can sometimes cause problems because dedupe ordering isn't stable today, which can lead to circular dependencies across stacks if models are reordered. |
|
|
2445
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableAutoIndexQueryNames">enableAutoIndexQueryNames</a></code> | <code>boolean</code> | Automate generation of query names, and as a result attaching all indexes as queries to the generated Api. |
|
|
2446
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | If enabled, set nodeToNodeEncryption on the searchable domain (if one exists). |
|
|
2447
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableTransformerCfnOutputs">enableTransformerCfnOutputs</a></code> | <code>boolean</code> | When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted. |
|
|
2448
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.populateOwnerFieldForStaticGroupAuth">populateOwnerFieldForStaticGroupAuth</a></code> | <code>boolean</code> | Ensure that the owner field is still populated even if a static iam or group authorization applies. |
|
|
2449
|
+
| <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. |
|
|
2450
|
+
| <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. |
|
|
2451
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.secondaryKeyAsGSI">secondaryKeyAsGSI</a></code> | <code>boolean</code> | If disabled, generated. |
|
|
2452
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.shouldDeepMergeDirectiveConfigDefaults">shouldDeepMergeDirectiveConfigDefaults</a></code> | <code>boolean</code> | Restore parity w/ GQLv1. |
|
|
2453
|
+
| <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. |
|
|
2454
|
+
| <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
2455
|
|
|
2438
2456
|
---
|
|
2439
2457
|
|
|
@@ -2443,8 +2461,8 @@ const translationBehavior: TranslationBehavior = { ... }
|
|
|
2443
2461
|
public readonly disableResolverDeduping: boolean;
|
|
2444
2462
|
```
|
|
2445
2463
|
|
|
2446
|
-
-
|
|
2447
|
-
-
|
|
2464
|
+
- *Type:* boolean
|
|
2465
|
+
- *Default:* true
|
|
2448
2466
|
|
|
2449
2467
|
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
2468
|
|
|
@@ -2456,8 +2474,8 @@ Disable resolver deduping, this can sometimes cause problems because dedupe orde
|
|
|
2456
2474
|
public readonly enableAutoIndexQueryNames: boolean;
|
|
2457
2475
|
```
|
|
2458
2476
|
|
|
2459
|
-
-
|
|
2460
|
-
-
|
|
2477
|
+
- *Type:* boolean
|
|
2478
|
+
- *Default:* true
|
|
2461
2479
|
|
|
2462
2480
|
Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.
|
|
2463
2481
|
|
|
@@ -2471,14 +2489,14 @@ If enabled,
|
|
|
2471
2489
|
public readonly enableSearchNodeToNodeEncryption: boolean;
|
|
2472
2490
|
```
|
|
2473
2491
|
|
|
2474
|
-
-
|
|
2475
|
-
-
|
|
2492
|
+
- *Type:* boolean
|
|
2493
|
+
- *Default:* false
|
|
2476
2494
|
|
|
2477
2495
|
If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).
|
|
2478
2496
|
|
|
2479
2497
|
Not recommended for use, prefer
|
|
2480
2498
|
to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {
|
|
2481
|
-
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2499
|
+
domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
2482
2500
|
});
|
|
2483
2501
|
|
|
2484
2502
|
---
|
|
@@ -2489,8 +2507,8 @@ domain.NodeToNodeEncryptionOptions = { Enabled: True };
|
|
|
2489
2507
|
public readonly enableTransformerCfnOutputs: boolean;
|
|
2490
2508
|
```
|
|
2491
2509
|
|
|
2492
|
-
-
|
|
2493
|
-
-
|
|
2510
|
+
- *Type:* boolean
|
|
2511
|
+
- *Default:* false
|
|
2494
2512
|
|
|
2495
2513
|
When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.
|
|
2496
2514
|
|
|
@@ -2502,8 +2520,8 @@ When enabled, internal cfn outputs which existed in Amplify-generated apps will
|
|
|
2502
2520
|
public readonly populateOwnerFieldForStaticGroupAuth: boolean;
|
|
2503
2521
|
```
|
|
2504
2522
|
|
|
2505
|
-
-
|
|
2506
|
-
-
|
|
2523
|
+
- *Type:* boolean
|
|
2524
|
+
- *Default:* true
|
|
2507
2525
|
|
|
2508
2526
|
Ensure that the owner field is still populated even if a static iam or group authorization applies.
|
|
2509
2527
|
|
|
@@ -2515,8 +2533,8 @@ Ensure that the owner field is still populated even if a static iam or group aut
|
|
|
2515
2533
|
public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;
|
|
2516
2534
|
```
|
|
2517
2535
|
|
|
2518
|
-
-
|
|
2519
|
-
-
|
|
2536
|
+
- *Type:* boolean
|
|
2537
|
+
- *Default:* true
|
|
2520
2538
|
|
|
2521
2539
|
Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.
|
|
2522
2540
|
|
|
@@ -2528,8 +2546,8 @@ Enable custom primary key support, there's no good reason to disable this unless
|
|
|
2528
2546
|
public readonly sandboxModeEnabled: boolean;
|
|
2529
2547
|
```
|
|
2530
2548
|
|
|
2531
|
-
-
|
|
2532
|
-
-
|
|
2549
|
+
- *Type:* boolean
|
|
2550
|
+
- *Default:* false
|
|
2533
2551
|
|
|
2534
2552
|
Enabling sandbox mode will enable api key auth on all models in the transformed schema.
|
|
2535
2553
|
|
|
@@ -2541,8 +2559,8 @@ Enabling sandbox mode will enable api key auth on all models in the transformed
|
|
|
2541
2559
|
public readonly secondaryKeyAsGSI: boolean;
|
|
2542
2560
|
```
|
|
2543
2561
|
|
|
2544
|
-
-
|
|
2545
|
-
-
|
|
2562
|
+
- *Type:* boolean
|
|
2563
|
+
- *Default:* true
|
|
2546
2564
|
|
|
2547
2565
|
If disabled, generated.
|
|
2548
2566
|
|
|
@@ -2554,8 +2572,8 @@ If disabled, generated.
|
|
|
2554
2572
|
public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
|
|
2555
2573
|
```
|
|
2556
2574
|
|
|
2557
|
-
-
|
|
2558
|
-
-
|
|
2575
|
+
- *Type:* boolean
|
|
2576
|
+
- *Default:* true
|
|
2559
2577
|
|
|
2560
2578
|
Restore parity w/ GQLv1.
|
|
2561
2579
|
|
|
@@ -2567,8 +2585,8 @@ Restore parity w/ GQLv1.
|
|
|
2567
2585
|
public readonly suppressApiKeyGeneration: boolean;
|
|
2568
2586
|
```
|
|
2569
2587
|
|
|
2570
|
-
-
|
|
2571
|
-
-
|
|
2588
|
+
- *Type:* boolean
|
|
2589
|
+
- *Default:* false
|
|
2572
2590
|
|
|
2573
2591
|
If enabled, disable api key resource generation even if specified as an auth rule on the construct.
|
|
2574
2592
|
|
|
@@ -2582,8 +2600,8 @@ This is a legacy parameter from the Graphql Transformer existing in Amplify CLI,
|
|
|
2582
2600
|
public readonly useSubUsernameForDefaultIdentityClaim: boolean;
|
|
2583
2601
|
```
|
|
2584
2602
|
|
|
2585
|
-
-
|
|
2586
|
-
-
|
|
2603
|
+
- *Type:* boolean
|
|
2604
|
+
- *Default:* true
|
|
2587
2605
|
|
|
2588
2606
|
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
2607
|
|
|
@@ -2603,8 +2621,8 @@ const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }
|
|
|
2603
2621
|
|
|
2604
2622
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2605
2623
|
|
|
2606
|
-
| **Name**
|
|
2607
|
-
|
|
|
2624
|
+
| **Name** | **Type** | **Description** |
|
|
2625
|
+
| --- | --- | --- |
|
|
2608
2626
|
| <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
2627
|
|
|
2610
2628
|
---
|
|
@@ -2615,7 +2633,7 @@ const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }
|
|
|
2615
2633
|
public readonly userPool: IUserPool;
|
|
2616
2634
|
```
|
|
2617
2635
|
|
|
2618
|
-
-
|
|
2636
|
+
- *Type:* aws-cdk-lib.aws_cognito.IUserPool
|
|
2619
2637
|
|
|
2620
2638
|
The Cognito User Pool which is used to authenticated JWT tokens, and vends group and user information.
|
|
2621
2639
|
|
|
@@ -2630,22 +2648,23 @@ Class exposing utilities to produce IAmplifyGraphqlDefinition objects given vari
|
|
|
2630
2648
|
#### Initializers <a name="Initializers" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.Initializer"></a>
|
|
2631
2649
|
|
|
2632
2650
|
```typescript
|
|
2633
|
-
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
2651
|
+
import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
|
|
2634
2652
|
|
|
2635
|
-
new AmplifyGraphqlDefinition()
|
|
2653
|
+
new AmplifyGraphqlDefinition()
|
|
2636
2654
|
```
|
|
2637
2655
|
|
|
2638
2656
|
| **Name** | **Type** | **Description** |
|
|
2639
|
-
|
|
|
2657
|
+
| --- | --- | --- |
|
|
2640
2658
|
|
|
2641
2659
|
---
|
|
2642
2660
|
|
|
2661
|
+
|
|
2643
2662
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
2644
2663
|
|
|
2645
|
-
| **Name**
|
|
2646
|
-
|
|
|
2647
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles">fromFiles</a></code>
|
|
2648
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input.
|
|
2664
|
+
| **Name** | **Description** |
|
|
2665
|
+
| --- | --- |
|
|
2666
|
+
| <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. |
|
|
2667
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input. |
|
|
2649
2668
|
|
|
2650
2669
|
---
|
|
2651
2670
|
|
|
@@ -2661,7 +2680,7 @@ Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.
|
|
|
2661
2680
|
|
|
2662
2681
|
###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles.parameter.filePaths"></a>
|
|
2663
2682
|
|
|
2664
|
-
-
|
|
2683
|
+
- *Type:* string
|
|
2665
2684
|
|
|
2666
2685
|
one or more paths to the graphql files to process.
|
|
2667
2686
|
|
|
@@ -2679,26 +2698,29 @@ Produce a schema definition from a string input.
|
|
|
2679
2698
|
|
|
2680
2699
|
###### `schema`<sup>Required</sup> <a name="schema" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.schema"></a>
|
|
2681
2700
|
|
|
2682
|
-
-
|
|
2701
|
+
- *Type:* string
|
|
2683
2702
|
|
|
2684
2703
|
the graphql input as a string.
|
|
2685
2704
|
|
|
2686
2705
|
---
|
|
2687
2706
|
|
|
2707
|
+
|
|
2708
|
+
|
|
2688
2709
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
2689
2710
|
|
|
2690
2711
|
### IAmplifyGraphqlDefinition <a name="IAmplifyGraphqlDefinition" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition"></a>
|
|
2691
2712
|
|
|
2692
|
-
-
|
|
2713
|
+
- *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>
|
|
2693
2714
|
|
|
2694
2715
|
Graphql Api definition, which can be implemented in multiple ways.
|
|
2695
2716
|
|
|
2717
|
+
|
|
2696
2718
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2697
2719
|
|
|
2698
|
-
| **Name**
|
|
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>
|
|
2720
|
+
| **Name** | **Type** | **Description** |
|
|
2721
|
+
| --- | --- | --- |
|
|
2722
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.functionSlots">functionSlots</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot">MutationFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot">QueryFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot">SubscriptionFunctionSlot</a>[]</code> | Retrieve any function slots defined explicitly in the Api definition. |
|
|
2723
|
+
| <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. |
|
|
2702
2724
|
|
|
2703
2725
|
---
|
|
2704
2726
|
|
|
@@ -2708,7 +2730,7 @@ Graphql Api definition, which can be implemented in multiple ways.
|
|
|
2708
2730
|
public readonly functionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];
|
|
2709
2731
|
```
|
|
2710
2732
|
|
|
2711
|
-
-
|
|
2733
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot">MutationFunctionSlot</a> | <a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot">QueryFunctionSlot</a> | <a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot">SubscriptionFunctionSlot</a>[]
|
|
2712
2734
|
|
|
2713
2735
|
Retrieve any function slots defined explicitly in the Api definition.
|
|
2714
2736
|
|
|
@@ -2720,7 +2742,7 @@ Retrieve any function slots defined explicitly in the Api definition.
|
|
|
2720
2742
|
public readonly schema: string;
|
|
2721
2743
|
```
|
|
2722
2744
|
|
|
2723
|
-
-
|
|
2745
|
+
- *Type:* string
|
|
2724
2746
|
|
|
2725
2747
|
Return the schema definition as a graphql string, with amplify directives allowed.
|
|
2726
2748
|
|
|
@@ -2728,16 +2750,17 @@ Return the schema definition as a graphql string, with amplify directives allowe
|
|
|
2728
2750
|
|
|
2729
2751
|
### IBackendOutputEntry <a name="IBackendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputEntry"></a>
|
|
2730
2752
|
|
|
2731
|
-
-
|
|
2753
|
+
- *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>
|
|
2732
2754
|
|
|
2733
2755
|
Entry representing the required output from the backend for codegen generate commands to work.
|
|
2734
2756
|
|
|
2757
|
+
|
|
2735
2758
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2736
2759
|
|
|
2737
|
-
| **Name**
|
|
2738
|
-
|
|
|
2760
|
+
| **Name** | **Type** | **Description** |
|
|
2761
|
+
| --- | --- | --- |
|
|
2739
2762
|
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.payload">payload</a></code> | <code>{[ key: string ]: string}</code> | The string-map payload of generated config values. |
|
|
2740
|
-
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.version">version</a></code> | <code>string</code>
|
|
2763
|
+
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry.property.version">version</a></code> | <code>string</code> | The protocol version for this backend output. |
|
|
2741
2764
|
|
|
2742
2765
|
---
|
|
2743
2766
|
|
|
@@ -2747,7 +2770,7 @@ Entry representing the required output from the backend for codegen generate com
|
|
|
2747
2770
|
public readonly payload: {[ key: string ]: string};
|
|
2748
2771
|
```
|
|
2749
2772
|
|
|
2750
|
-
-
|
|
2773
|
+
- *Type:* {[ key: string ]: string}
|
|
2751
2774
|
|
|
2752
2775
|
The string-map payload of generated config values.
|
|
2753
2776
|
|
|
@@ -2759,7 +2782,7 @@ The string-map payload of generated config values.
|
|
|
2759
2782
|
public readonly version: string;
|
|
2760
2783
|
```
|
|
2761
2784
|
|
|
2762
|
-
-
|
|
2785
|
+
- *Type:* string
|
|
2763
2786
|
|
|
2764
2787
|
The protocol version for this backend output.
|
|
2765
2788
|
|
|
@@ -2767,14 +2790,14 @@ The protocol version for this backend output.
|
|
|
2767
2790
|
|
|
2768
2791
|
### IBackendOutputStorageStrategy <a name="IBackendOutputStorageStrategy" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy"></a>
|
|
2769
2792
|
|
|
2770
|
-
-
|
|
2793
|
+
- *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy">IBackendOutputStorageStrategy</a>
|
|
2771
2794
|
|
|
2772
2795
|
Backend output strategy used to write config required for codegen tasks.
|
|
2773
2796
|
|
|
2774
2797
|
#### Methods <a name="Methods" id="Methods"></a>
|
|
2775
2798
|
|
|
2776
|
-
| **Name**
|
|
2777
|
-
|
|
|
2799
|
+
| **Name** | **Description** |
|
|
2800
|
+
| --- | --- |
|
|
2778
2801
|
| <code><a href="#@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry">addBackendOutputEntry</a></code> | Add an entry to backend output. |
|
|
2779
2802
|
|
|
2780
2803
|
---
|
|
@@ -2789,7 +2812,7 @@ Add an entry to backend output.
|
|
|
2789
2812
|
|
|
2790
2813
|
###### `keyName`<sup>Required</sup> <a name="keyName" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry.parameter.keyName"></a>
|
|
2791
2814
|
|
|
2792
|
-
-
|
|
2815
|
+
- *Type:* string
|
|
2793
2816
|
|
|
2794
2817
|
the key.
|
|
2795
2818
|
|
|
@@ -2797,8 +2820,10 @@ the key.
|
|
|
2797
2820
|
|
|
2798
2821
|
###### `backendOutputEntry`<sup>Required</sup> <a name="backendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputStorageStrategy.addBackendOutputEntry.parameter.backendOutputEntry"></a>
|
|
2799
2822
|
|
|
2800
|
-
-
|
|
2823
|
+
- *Type:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>
|
|
2801
2824
|
|
|
2802
2825
|
the record to store in the backend output.
|
|
2803
2826
|
|
|
2804
2827
|
---
|
|
2828
|
+
|
|
2829
|
+
|