AWS CDK Reference

Appearance

v2.275.0

GraphqlApiAttributes Struct ​

Attributes for GraphQL imports.

Source
aws-appsync/lib/graphqlapi.ts
Type last changed
v2.142.0 · 16 May 2024

Example ​

ts
const sourceApi = new appsync.GraphqlApi(this, 'FirstSourceAPI', {
  name: 'FirstSourceAPI',
  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.merged-api-1.graphql')),
});

const importedMergedApi = appsync.GraphqlApi.fromGraphqlApiAttributes(this, 'ImportedMergedApi', {
  graphqlApiId: 'MyApiId',
  graphqlApiArn: 'MyApiArn',
});

const importedExecutionRole = iam.Role.fromRoleArn(this, 'ExecutionRole', 'arn:aws:iam::ACCOUNT:role/MyExistingRole');
new appsync.SourceApiAssociation(this, 'SourceApiAssociation2', {
   sourceApi: sourceApi,
   mergedApi: importedMergedApi,
   mergeType: appsync.MergeType.MANUAL_MERGE,
   mergedApiExecutionRole: importedExecutionRole,
});

Properties ​

graphqlApiArnoptionalstringgraphql_api_arnoptionalstrgraphqlApiArnoptionalStringGraphqlApiArnoptionalstringGraphqlApiArnoptional*string#
the arn for the GraphQL Api.

Default: autogenerated arn

graphqlApiIdstringgraphql_api_idstrgraphqlApiIdStringGraphqlApiIdstringGraphqlApiId*stringrequired#
a unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
graphQLEndpointArnoptionalstringgraph_ql_endpoint_arnoptionalstrgraphQLEndpointArnoptionalStringGraphQLEndpointArnoptionalstringGraphQLEndpointArnoptional*string#
The GraphQl endpoint arn for the GraphQL API.

Default: none, required to construct event rules from imported APIs

modesoptionalAuthorizationType[]modesoptionaltyping.List[AuthorizationType]modesoptionalList<AuthorizationType>ModesoptionalAuthorizationType[]Modesoptional*[]AuthorizationType#
The Authorization Types for this GraphQL Api.

Default: none, required to construct event rules from imported APIs

visibilityoptionalVisibilityvisibilityoptionalVisibilityvisibilityoptionalVisibilityVisibilityoptionalVisibilityVisibilityoptionalVisibility= GLOBAL#
The GraphQl API visibility.