Package software.amazon.awscdk.services.appsync

Interface SourceApiAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SourceApiAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:28.951Z")
@Stability(Stable)
public interface SourceApiAssociationProps
extends software.amazon.jsii.JsiiSerializable

Properties for SourceApiAssociation which associates an AppSync Source API with an AppSync Merged 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SourceApiAssociationProps.Builder	builder()
default String	getDescription()	The description of the source api association.
IGraphqlApi	getMergedApi()	The merged api to associate.
IRole	getMergedApiExecutionRole()	The merged api execution role for adding the access policy for the source api.
default MergeType	getMergeType()	The merge type for the source.
IGraphqlApi	getSourceApi()	The source api to associate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMergedApi

@Stability(Stable)
@NotNull
IGraphqlApi getMergedApi()

The merged api to associate.

getMergedApiExecutionRole

@Stability(Stable)
@NotNull
IRole getMergedApiExecutionRole()

The merged api execution role for adding the access policy for the source api.

getSourceApi

@Stability(Stable)
@NotNull
IGraphqlApi getSourceApi()

The source api to associate.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the source api association.

Default: - None

getMergeType

@Stability(Stable)
@Nullable
default MergeType getMergeType()

The merge type for the source.

Default: - AUTO_MERGE

builder

@Stability(Stable)
static SourceApiAssociationProps.Builder builder()

Returns:

a SourceApiAssociationProps.Builder of SourceApiAssociationProps