Class SourceApiAssociation

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

Inheritance

System.Object

Resource

SourceApiAssociation

Implements

ISourceApiAssociation

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SourceApiAssociation : Resource, ISourceApiAssociation, IResource

Syntax (vb)

Public Class SourceApiAssociation
    Inherits Resource
    Implements ISourceApiAssociation, IResource

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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
SourceApiAssociation(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
SourceApiAssociation(Construct, String, ISourceApiAssociationProps)

Properties

Association	The underlying CFN source api association resource.
AssociationArn	The association arn.
AssociationId	The association id.
MergedApi	The merged api in the association.
MergeType	The merge type for the source api association.
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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected SourceApiAssociation(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

SourceApiAssociation(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected SourceApiAssociation(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

SourceApiAssociation(Construct, String, ISourceApiAssociationProps)

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

Parameters

scope Constructs.Construct
id System.String
props ISourceApiAssociationProps

Properties

Association

The underlying CFN source api association resource.

public virtual CfnSourceApiAssociation Association { get; }

Property Value

CfnSourceApiAssociation

AssociationArn

The association arn.

public virtual string AssociationArn { get; }

Property Value

System.String

AssociationId

The association id.

public virtual string AssociationId { get; }

Property Value

System.String

MergedApi

The merged api in the association.

public virtual IGraphqlApi MergedApi { get; }

Property Value

IGraphqlApi

MergeType

The merge type for the source api association.

public virtual MergeType MergeType { get; }

Property Value

MergeType

SourceApi

The source api in the association.

public virtual IGraphqlApi SourceApi { get; }

Property Value

IGraphqlApi

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 Constructs.Construct
id System.String
attrs ISourceApiAssociationAttributes

Returns

ISourceApiAssociation

Implements

ISourceApiAssociation

IResource

Constructs.IConstruct

Constructs.IDependable