SourceApiAssociationProps

class aws_cdk.aws_appsync.SourceApiAssociationProps(*, merged_api, merged_api_execution_role, source_api, description=None, merge_type=None)

Bases: object

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

Parameters:

  • merged_api (IGraphqlApi) – The merged api to associate.

  • merged_api_execution_role (IRole) – The merged api execution role for adding the access policy for the source api.

  • source_api (IGraphqlApi) – The source api to associate.

  • description (Optional[str]) – The description of the source api association. Default: - None

  • merge_type (Optional[MergeType]) – The merge type for the source. Default: - AUTO_MERGE

ExampleMetadata:

infused

Example:

source_api = appsync.GraphqlApi(self, "FirstSourceAPI",
    name="FirstSourceAPI",
    definition=appsync.Definition.from_file(path.join(__dirname, "appsync.merged-api-1.graphql"))
)

imported_merged_api = appsync.GraphqlApi.from_graphql_api_attributes(self, "ImportedMergedApi",
    graphql_api_id="MyApiId",
    graphql_api_arn="MyApiArn"
)

imported_execution_role = iam.Role.from_role_arn(self, "ExecutionRole", "arn:aws:iam::ACCOUNT:role/MyExistingRole")
appsync.SourceApiAssociation(self, "SourceApiAssociation2",
    source_api=source_api,
    merged_api=imported_merged_api,
    merge_type=appsync.MergeType.MANUAL_MERGE,
    merged_api_execution_role=imported_execution_role
)

Attributes

description

The description of the source api association.

Default:

  • None

merge_type

The merge type for the source.

Default:

  • AUTO_MERGE

merged_api

The merged api to associate.

merged_api_execution_role

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

source_api

The source api to associate.