Interface GraphqlApiAttributes

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GraphqlApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:14.664Z") @Stability(Stable) public interface GraphqlApiAttributes extends software.amazon.jsii.JsiiSerializable
Attributes for GraphQL imports.

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

    • getGraphqlApiId

      @Stability(Stable) @NotNull String getGraphqlApiId()
      an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
    • getGraphqlApiArn

      @Stability(Stable) @Nullable default String getGraphqlApiArn()
      the arn for the GraphQL Api.

      Default: - autogenerated arn

    • getGraphQLEndpointArn

      @Stability(Stable) @Nullable default String getGraphQLEndpointArn()
      The GraphQl endpoint arn for the GraphQL API.

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

    • getModes

      @Stability(Stable) @Nullable default List<AuthorizationType> getModes()
      The Authorization Types for this GraphQL Api.

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

    • getVisibility

      @Stability(Stable) @Nullable default Visibility getVisibility()
      The GraphQl API visibility.

      Default: - GLOBAL

    • builder

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