Definition

class aws_cdk.aws_appsync.Definition

Bases: object

AppSync definition.

Specify how you want to define your AppSync API.

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

schema: Schema, when AppSync API is created from schema file.

source_api_options: Source APIs for Merged API.

Static Methods

classmethod from_file(file_path)

Schema from file, allows schema definition through schema.graphql file.

Parameters:: file_path (str) – the file path of the schema file.
Return type:: Definition
Returns:: Definition with schema from file

classmethod from_schema(schema)

Schema from schema object.

Parameters:: schema (ISchema) – SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file.
Return type:: Definition
Returns:: Definition with schema from file

classmethod from_source_apis(*, source_apis, merged_api_execution_role=None)

Schema from existing AppSync APIs - used for creating a AppSync Merged API.

Parameters:

source_apis (Sequence[Union[SourceApi, Dict[str, Any]]]) – Definition of source APIs associated with this Merged API.
merged_api_execution_role (Optional[Role]) – IAM Role used to validate access to source APIs at runtime and to update the merged API endpoint with the source API changes. Default: - An IAM Role with acccess to source schemas will be created

Return type:

Definition

Returns:

Definition with for AppSync Merged API