Package software.amazon.awscdk.services.appsync

Interface GraphqlApiAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GraphqlApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.994Z")
@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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GraphqlApiAttributes.Builder	builder()
default String	getGraphqlApiArn()	the arn for the GraphQL Api.
String	getGraphqlApiId()	an unique AWS AppSync GraphQL API identifier i.e.
default String	getGraphQLEndpointArn()	The GraphQl endpoint arn for the GraphQL API.
default List<AuthorizationType>	getModes()	The Authorization Types for this GraphQL Api.
default Visibility	getVisibility()	The GraphQl API visibility.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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