Class SourceApiAssociation

AppSync SourceApiAssociation which associates an AppSync source API to an AppSync Merged API.

Inheritance
object
Resource
SourceApiAssociation
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SourceApiAssociation : Resource, ISourceApiAssociation, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class SourceApiAssociation Inherits Resource Implements ISourceApiAssociation, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

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

SourceApiAssociation(Construct, string, ISourceApiAssociationProps)

AppSync SourceApiAssociation which associates an AppSync source API to an AppSync Merged API.

Properties

Association

The underlying CFN source api association resource.
AssociationArn

The association arn.
AssociationId

The association id.
MergeType

The merge type for the source api association.
MergedApi

The merged api in the association.
PROPERTY_INJECTION_ID

Uniquely identifies this class.
SourceApi

The source api in the association.

Methods

FromSourceApiAssociationAttributes(Construct, string, ISourceApiAssociationAttributes)

Import Appsync Source Api Association from source API, merged api, and merge type.

Constructors

SourceApiAssociation(Construct, string, ISourceApiAssociationProps)

AppSync SourceApiAssociation which associates an AppSync source API to an AppSync Merged API.

public SourceApiAssociation(Construct scope, string id, ISourceApiAssociationProps props)
Parameters
scope Construct
id string
props ISourceApiAssociationProps
Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

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

Association

The underlying CFN source api association resource.

public virtual CfnSourceApiAssociation Association { get; }
Property Value

CfnSourceApiAssociation

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

AssociationArn

The association arn.

public virtual string AssociationArn { get; }
Property Value

string

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

AssociationId

The association id.

public virtual string AssociationId { get; }
Property Value

string

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

MergeType

The merge type for the source api association.

public virtual MergeType MergeType { get; }
Property Value

MergeType

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

MergedApi

The merged api in the association.

public virtual IGraphqlApi MergedApi { get; }
Property Value

IGraphqlApi

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

SourceApi

The source api in the association.

public virtual IGraphqlApi SourceApi { get; }
Property Value

IGraphqlApi

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

Methods

FromSourceApiAssociationAttributes(Construct, string, ISourceApiAssociationAttributes)

Import Appsync Source Api Association from source API, merged api, and merge type.

public static ISourceApiAssociation FromSourceApiAssociationAttributes(Construct scope, string id, ISourceApiAssociationAttributes attrs)
Parameters
scope Construct
id string
attrs ISourceApiAssociationAttributes
Returns

ISourceApiAssociation

Remarks

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable