Interface ISourceApiAssociationProps

Properties for SourceApiAssociation which associates an AppSync Source API with an AppSync Merged API.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ISourceApiAssociationProps

Syntax (vb)

Public Interface ISourceApiAssociationProps

Remarks

ExampleMetadata: infused

Examples

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

            var importedMergedApi = GraphqlApi.FromGraphqlApiAttributes(this, "ImportedMergedApi", new GraphqlApiAttributes {
                GraphqlApiId = "MyApiId",
                GraphqlApiArn = "MyApiArn"
            });

            var importedExecutionRole = Role.FromRoleArn(this, "ExecutionRole", "arn:aws:iam::ACCOUNT:role/MyExistingRole");
            new SourceApiAssociation(this, "SourceApiAssociation2", new SourceApiAssociationProps {
                SourceApi = sourceApi,
                MergedApi = importedMergedApi,
                MergeType = MergeType.MANUAL_MERGE,
                MergedApiExecutionRole = importedExecutionRole
            });

Synopsis

Properties

Description	The description of the source api association.
MergeType	The merge type for the source.
MergedApi	The merged api to associate.
MergedApiExecutionRole	The merged api execution role for adding the access policy for the source api.
SourceApi	The source api to associate.

Properties

Description

The description of the source api association.

string? Description { get; }

Property Value

string

Remarks

Default: - None

MergeType

The merge type for the source.

MergeType? MergeType { get; }

Property Value

MergeType?

Remarks

Default: - AUTO_MERGE

MergedApi

The merged api to associate.

IGraphqlApi MergedApi { get; }

Property Value

IGraphqlApi

Remarks

ExampleMetadata: infused

MergedApiExecutionRole

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

IRole MergedApiExecutionRole { get; }

Property Value

IRole

Remarks

ExampleMetadata: infused

SourceApi

The source api to associate.

IGraphqlApi SourceApi { get; }

Property Value

IGraphqlApi

Remarks

ExampleMetadata: infused