SourceApiAssociation
Describes the configuration of a source API. 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 AWS Resource Access Manager. For more information about sharing resources from other accounts, see What is AWS Resource Access Manager? in the AWS Resource Access Manager guide.
Contents
- associationArn
-
The Amazon Resource Name (ARN) of the source API association.
Type: String
Required: No
- associationId
-
The ID generated by the AppSync service for the source API association.
Type: String
Required: No
- description
-
The description field.
Type: String
Required: No
- lastSuccessfulMergeDate
-
The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.
Type: Timestamp
Required: No
- mergedApiArn
-
The Amazon Resource Name (ARN) of the AppSync Merged API.
Type: String
Required: No
- mergedApiId
-
The ID of the AppSync Merged API.
Type: String
Required: No
- sourceApiArn
-
The Amazon Resource Name (ARN) of the AppSync source API.
Type: String
Required: No
- sourceApiAssociationConfig
-
The
SourceApiAssociationConfigobject data.Type: SourceApiAssociationConfig object
Required: No
- sourceApiAssociationStatus
-
The state of the source API association.
Type: String
Valid Values:
MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS | AUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS | DELETION_FAILEDRequired: No
- sourceApiAssociationStatusDetail
-
The detailed message related to the current state of the source API association.
Type: String
Required: No
- sourceApiId
-
The ID of the AppSync source API.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
