Class SourceApiAssociationProps

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

Inheritance

object

SourceApiAssociationProps

Implements

ISourceApiAssociationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SourceApiAssociationProps : ISourceApiAssociationProps

Syntax (vb)

Public Class SourceApiAssociationProps Implements 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

Constructors

SourceApiAssociationProps()

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

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.

Constructors

SourceApiAssociationProps()

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

public SourceApiAssociationProps()

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
            });

Properties

Description

The description of the source api association.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - None

MergeType

The merge type for the source.

public MergeType? MergeType { get; set; }

Property Value

MergeType?

Remarks

Default: - AUTO_MERGE

MergedApi

The merged api to associate.

public IGraphqlApi MergedApi { get; set; }

Property Value

IGraphqlApi

Remarks

ExampleMetadata: infused

MergedApiExecutionRole

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

public IRole MergedApiExecutionRole { get; set; }

Property Value

IRole

Remarks

ExampleMetadata: infused

SourceApi

The source api to associate.

public IGraphqlApi SourceApi { get; set; }

Property Value

IGraphqlApi

Remarks

ExampleMetadata: infused

Implements

ISourceApiAssociationProps