Interface GraphqlApiAttributes
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
GraphqlApiAttributes.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-13T21:17:29.064Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forGraphqlApiAttributes
static final class
An implementation forGraphqlApiAttributes
-
Method Summary
Modifier and TypeMethodDescriptionstatic GraphqlApiAttributes.Builder
builder()
default String
the arn for the GraphQL Api.an unique AWS AppSync GraphQL API identifier i.e.default String
The GraphQl endpoint arn for the GraphQL API.default List<AuthorizationType>
getModes()
The Authorization Types for this GraphQL Api.default Visibility
The GraphQl API visibility.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getGraphqlApiId
an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'. -
getGraphqlApiArn
the arn for the GraphQL Api.Default: - autogenerated arn
-
getGraphQLEndpointArn
The GraphQl endpoint arn for the GraphQL API.Default: - none, required to construct event rules from imported APIs
-
getModes
The Authorization Types for this GraphQL Api.Default: - none, required to construct event rules from imported APIs
-
getVisibility
The GraphQl API visibility.Default: - GLOBAL
-
builder
- Returns:
- a
GraphqlApiAttributes.Builder
ofGraphqlApiAttributes
-