IGraphqlApi¶
-
class
aws_cdk.aws_appsync.
IGraphqlApi
(*args, **kwds)¶ Bases:
aws_cdk.core.IResource
,typing_extensions.Protocol
(experimental) Interface for GraphQL.
- Stability
experimental
Methods
-
add_dynamo_db_data_source
(id, table, *, description=None, name=None)¶ (experimental) add a new DynamoDB data source to this API.
- Parameters
id (
str
) – The data source’s id.table (
ITable
) – The DynamoDB table backing this data source.description (
Optional
[str
]) – (experimental) The description of the data source. Default: - No descriptionname (
Optional
[str
]) – (experimental) The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
- Stability
experimental
- Return type
-
add_http_data_source
(id, endpoint, *, authorization_config=None, description=None, name=None)¶ (experimental) add a new http data source to this API.
- Parameters
id (
str
) – The data source’s id.endpoint (
str
) – The http endpoint.authorization_config (
Optional
[AwsIamConfig
]) – (experimental) The authorization config in case the HTTP endpoint requires authorization. Default: - nonedescription (
Optional
[str
]) – (experimental) The description of the data source. Default: - No descriptionname (
Optional
[str
]) – (experimental) The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
- Stability
experimental
- Return type
-
add_lambda_data_source
(id, lambda_function, *, description=None, name=None)¶ (experimental) add a new Lambda data source to this API.
- Parameters
id (
str
) – The data source’s id.lambda_function (
IFunction
) – The Lambda function to call to interact with this data source.description (
Optional
[str
]) – (experimental) The description of the data source. Default: - No descriptionname (
Optional
[str
]) – (experimental) The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
- Stability
experimental
- Return type
-
add_none_data_source
(id, *, description=None, name=None)¶ (experimental) add a new dummy data source to this API.
Useful for pipeline resolvers and for backend changes that don’t require a data source.
- Parameters
id (
str
) – The data source’s id.description (
Optional
[str
]) – (experimental) The description of the data source. Default: - No descriptionname (
Optional
[str
]) – (experimental) The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
- Stability
experimental
- Return type
-
add_rds_data_source
(id, database_cluster, secret_store, *, description=None, name=None)¶ (experimental) add a new Rds data source to this API.
- Parameters
id (
str
) – The data source’s id.database_cluster (
IDatabaseCluster
) – The database cluster to interact with this data source.secret_store (
ISecret
) – The secret store that contains the username and password for the database cluster.description (
Optional
[str
]) – (experimental) The description of the data source. Default: - No descriptionname (
Optional
[str
]) – (experimental) The name of the data source, overrides the id given by cdk. Default: - generated by cdk given the id
- Stability
experimental
- Return type
-
add_schema_dependency
(construct)¶ (experimental) Add schema dependency if not imported.
- Parameters
construct (
CfnResource
) – the dependee.- Stability
experimental
- Return type
bool
-
create_resolver
(*, data_source=None, field_name, type_name, pipeline_config=None, request_mapping_template=None, response_mapping_template=None)¶ (experimental) creates a new resolver for this datasource and API using the given properties.
- Parameters
data_source (
Optional
[BaseDataSource
]) – (experimental) The data source this resolver is using. Default: - No datasourcefield_name (
str
) – (experimental) name of the GraphQL field in the given type this resolver is attached to.type_name (
str
) – (experimental) name of the GraphQL type this resolver is attached to.pipeline_config (
Optional
[List
[IAppsyncFunction
]]) – (experimental) configuration of the pipeline resolver. Default: - no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unitrequest_mapping_template (
Optional
[MappingTemplate
]) – (experimental) The request mapping template for this resolver. Default: - No mapping templateresponse_mapping_template (
Optional
[MappingTemplate
]) – (experimental) The response mapping template for this resolver. Default: - No mapping template
- Stability
experimental
- Return type
Attributes
-
api_id
¶ (experimental) an unique AWS AppSync GraphQL API identifier i.e. ‘lxz775lwdrgcndgz3nurvac7oa’.
- Stability
experimental
- Attribute
true
- Return type
str
-
arn
¶ (experimental) the ARN of the API.
- Stability
experimental
- Attribute
true
- Return type
str
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node for this construct.
- Return type