Package software.amazon.awscdk.services.appsync

Interface GraphqlApiProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GraphqlApiProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)", date="2024-01-03T18:29:22.019Z") @Stability(Stable) public interface GraphqlApiProps extends software.amazon.jsii.JsiiSerializable
Properties for an AppSync GraphQL API.

Example: 

 GraphqlApi sourceApi = GraphqlApi.Builder.create(this, "FirstSourceAPI")
         .name("FirstSourceAPI")
         .definition(Definition.fromFile(join(__dirname, "appsync.merged-api-1.graphql")))
         .build();
 IGraphqlApi importedMergedApi = GraphqlApi.fromGraphqlApiAttributes(this, "ImportedMergedApi", GraphqlApiAttributes.builder()
         .graphqlApiId("MyApiId")
         .graphqlApiArn("MyApiArn")
         .build());
 IRole importedExecutionRole = Role.fromRoleArn(this, "ExecutionRole", "arn:aws:iam::ACCOUNT:role/MyExistingRole");
 SourceApiAssociation.Builder.create(this, "SourceApiAssociation2")
         .sourceApi(sourceApi)
         .mergedApi(importedMergedApi)
         .mergeType(MergeType.MANUAL_MERGE)
         .mergedApiExecutionRole(importedExecutionRole)
         .build();

  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      the name of the GraphQL API.

    • getAuthorizationConfig

      @Stability(Stable) @Nullable default AuthorizationConfig getAuthorizationConfig()
      Optional authorization configuration.

      Default: - API Key authorization

    • getDefinition

      @Stability(Stable) @Nullable default Definition getDefinition()
      Definition (schema file or source APIs) for this GraphQL Api.

    • getDomainName

      @Stability(Stable) @Nullable default DomainOptions getDomainName()
      The domain name configuration for the GraphQL API.

      The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to enable custom domain URL

      Default: - no domain name

    • getIntrospectionConfig

      @Stability(Stable) @Nullable default IntrospectionConfig getIntrospectionConfig()
      A value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection.

      Default: IntrospectionConfig.ENABLED

    • getLogConfig

      @Stability(Stable) @Nullable default LogConfig getLogConfig()
      Logging configuration for this api.

      Default: - None

    • getSchema

      @Stability(Deprecated) @Deprecated @Nullable default ISchema getSchema()
      Deprecated.
      use Definition.schema instead
      (deprecated) GraphQL schema definition. Specify how you want to define your schema.

      SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file

      Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)

    • getVisibility

      @Stability(Stable) @Nullable default Visibility getVisibility()
      A value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE).

      Default: - GLOBAL

    • getXrayEnabled

      @Stability(Stable) @Nullable default Boolean getXrayEnabled()
      A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

      Default: - false

    • builder

      @Stability(Stable) static GraphqlApiProps.Builder builder()
      Returns:
      a GraphqlApiProps.Builder of GraphqlApiProps