Class CfnSourceApiAssociation
Describes the configuration of a source API.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSourceApiAssociation : CfnResource, IInspectable
Syntax (vb)
Public Class CfnSourceApiAssociation
Inherits CfnResource
Implements IInspectable
Remarks
A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API. Source APIs can originate from your account or from other accounts via Resource Access Manager.
CloudformationResource: AWS::AppSync::SourceApiAssociation
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var cfnSourceApiAssociation = new CfnSourceApiAssociation(this, "MyCfnSourceApiAssociation", new CfnSourceApiAssociationProps {
Description = "description",
MergedApiIdentifier = "mergedApiIdentifier",
SourceApiAssociationConfig = new SourceApiAssociationConfigProperty {
MergeType = "mergeType"
},
SourceApiIdentifier = "sourceApiIdentifier"
});
Synopsis
Constructors
CfnSourceApiAssociation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSourceApiAssociation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSourceApiAssociation(Construct, String, ICfnSourceApiAssociationProps) |
Properties
AttrAssociationArn | The Amazon Resource Name (ARN) of the source API association. |
AttrAssociationId | The ID generated by the AppSync service for the source API association. |
AttrLastSuccessfulMergeDate | The datetime value of the last successful merge of the source API association. |
AttrMergedApiArn | The Amazon Resource Name (ARN) of the merged API. |
AttrMergedApiId | The ID of the merged API. |
AttrSourceApiArn | The source API's Amazon Resource Name (ARN) value. |
AttrSourceApiAssociationStatus | The state of the source API association. |
AttrSourceApiAssociationStatusDetail | The message describing the state of the source API association. |
AttrSourceApiId | The ID of the source API. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description field of the association configuration. |
MergedApiIdentifier | The identifier of the AppSync Merged API. |
SourceApiAssociationConfig | The |
SourceApiIdentifier | The identifier of the AppSync Source API. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSourceApiAssociation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSourceApiAssociation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSourceApiAssociation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSourceApiAssociation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSourceApiAssociation(Construct, String, ICfnSourceApiAssociationProps)
public CfnSourceApiAssociation(Construct scope, string id, ICfnSourceApiAssociationProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSourceApiAssociationProps
Resource properties.
Properties
AttrAssociationArn
The Amazon Resource Name (ARN) of the source API association.
public virtual string AttrAssociationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AssociationArn
AttrAssociationId
The ID generated by the AppSync service for the source API association.
public virtual string AttrAssociationId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AssociationId
AttrLastSuccessfulMergeDate
The datetime value of the last successful merge of the source API association.
public virtual string AttrLastSuccessfulMergeDate { get; }
Property Value
System.String
Remarks
The result will be in UTC format and your local time zone.
CloudformationAttribute: LastSuccessfulMergeDate
AttrMergedApiArn
The Amazon Resource Name (ARN) of the merged API.
public virtual string AttrMergedApiArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: MergedApiArn
AttrMergedApiId
The ID of the merged API.
public virtual string AttrMergedApiId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: MergedApiId
AttrSourceApiArn
The source API's Amazon Resource Name (ARN) value.
public virtual string AttrSourceApiArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceApiArn
AttrSourceApiAssociationStatus
The state of the source API association.
public virtual string AttrSourceApiAssociationStatus { get; }
Property Value
System.String
Remarks
The following values are valid:
MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS | AUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS | DELETION_FAILED
CloudformationAttribute: SourceApiAssociationStatus
AttrSourceApiAssociationStatusDetail
The message describing the state of the source API association.
public virtual string AttrSourceApiAssociationStatusDetail { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceApiAssociationStatusDetail
AttrSourceApiId
The ID of the source API.
public virtual string AttrSourceApiId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceApiId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description field of the association configuration.
public virtual string Description { get; set; }
Property Value
System.String
MergedApiIdentifier
The identifier of the AppSync Merged API.
public virtual string MergedApiIdentifier { get; set; }
Property Value
System.String
SourceApiAssociationConfig
The SourceApiAssociationConfig
object data.
public virtual object SourceApiAssociationConfig { get; set; }
Property Value
System.Object
SourceApiIdentifier
The identifier of the AppSync Source API.
public virtual string SourceApiIdentifier { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>