Package software.amazon.awscdk.services.appsync

Interface SourceApi

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SourceApi.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:57.206Z") @Stability(Stable) public interface SourceApi extends software.amazon.jsii.JsiiSerializable
Configuration of source API.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 GraphqlApi graphqlApi;
 SourceApi sourceApi = SourceApi.builder()
         .sourceApi(graphqlApi)
         // the properties below are optional
         .description("description")
         .mergeType(MergeType.MANUAL_MERGE)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    SourceApi.Builder
    A builder for SourceApi
    static final class 
    SourceApi.Jsii$Proxy
    An implementation for SourceApi

  • Method Summary

    Modifier and Type
    Method
    Description
    static SourceApi.Builder
    builder()
     
    default String
    getDescription()
    Description of the Source API asssociation.
    default MergeType
    getMergeType()
    Merging option used to associate the source API to the Merged API.
    IGraphqlApi
    getSourceApi()
    Source API that is associated with the merged API.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getSourceApi

      @Stability(Stable) @NotNull IGraphqlApi getSourceApi()
      Source API that is associated with the merged API.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Description of the Source API asssociation.

    • getMergeType

      @Stability(Stable) @Nullable default MergeType getMergeType()
      Merging option used to associate the source API to the Merged API.

      Default: - Auto merge. The merge is triggered automatically when the source API has changed

    • builder

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