Interface ISourceApiOptions

Additional API configuration for creating a AppSync Merged API.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ISourceApiOptions

Syntax (vb)

Public Interface ISourceApiOptions

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK;

            // first source API
            var firstApi = new GraphqlApi(this, "FirstSourceAPI", new GraphqlApiProps {
                Name = "FirstSourceAPI",
                Definition = Definition.FromFile(Join(__dirname, "appsync.merged-api-1.graphql"))
            });

            // second source API
            var secondApi = new GraphqlApi(this, "SecondSourceAPI", new GraphqlApiProps {
                Name = "SecondSourceAPI",
                Definition = Definition.FromFile(Join(__dirname, "appsync.merged-api-2.graphql"))
            });

            // Merged API
            var mergedApi = new GraphqlApi(this, "MergedAPI", new GraphqlApiProps {
                Name = "MergedAPI",
                Definition = Definition.FromSourceApis(new SourceApiOptions {
                    SourceApis = new [] { new SourceApi {
                        SourceApi = firstApi,
                        MergeType = MergeType.MANUAL_MERGE
                    }, new SourceApi {
                        SourceApi = secondApi,
                        MergeType = MergeType.AUTO_MERGE
                    } }
                })
            });

Synopsis

Properties

MergedApiExecutionRole	IAM Role used to validate access to source APIs at runtime and to update the merged API endpoint with the source API changes.
SourceApis	Definition of source APIs associated with this Merged API.

Properties

MergedApiExecutionRole

IAM Role used to validate access to source APIs at runtime and to update the merged API endpoint with the source API changes.

Role? MergedApiExecutionRole { get; }

Property Value

Role

Remarks

Default: - An IAM Role with acccess to source schemas will be created

SourceApis

Definition of source APIs associated with this Merged API.

ISourceApi[] SourceApis { get; }

Property Value

ISourceApi[]

Remarks

ExampleMetadata: infused