GraphqlApiBase
- class aws_cdk.aws_appsync.GraphqlApiBase(scope, id, *, account=None, environment_from_arn=None, physical_name=None, region=None)
Bases:
Resource
(experimental) Base Class for GraphQL API.
- Stability:
experimental
- Parameters:
scope (
Construct
) –id (
str
) –account (
Optional
[str
]) – The AWS account ID this resource belongs to. Default: - the resource is in the same account as the stack it belongs toenvironment_from_arn (
Optional
[str
]) – ARN to deduce region and account from. The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with eitheraccount
orregion
. Default: - take environment fromaccount
,region
parameters, or use Stack environment.physical_name (
Optional
[str
]) – The value passed in by users to the physical name prop of the resource. -undefined
implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name -PhysicalName.GENERATE_IF_NEEDED
is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. Default: - The physical name will be allocated by CloudFormation at deployment timeregion (
Optional
[str
]) – The AWS region this resource belongs to. Default: - the resource is in the same region as the stack it belongs to
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_elasticsearch_data_source(id, domain, *, description=None, name=None)
(deprecated) add a new elasticsearch data source to this API.
- Parameters:
id (
str
) – The data source’s id.domain (
IDomain
) – The elasticsearch domain for 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
- Deprecated:
use
addOpenSearchDataSource
- Stability:
deprecated
- 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 (
Union
[AwsIamConfig
,Dict
[str
,Any
],None
]) – (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_open_search_data_source(id, domain, *, description=None, name=None)
(experimental) add a new OpenSearch data source to this API.
- Parameters:
id (
str
) – The data source’s id.domain (
IDomain
) – The OpenSearch domain for 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_rds_data_source(id, serverless_cluster, secret_store, database_name=None, *, description=None, name=None)
(experimental) add a new Rds data source to this API.
- Parameters:
id (
str
) – The data source’s id.serverless_cluster (
IServerlessCluster
) – The serverless cluster to interact with this data source.secret_store (
ISecret
) – The secret store that contains the username and password for the serverless cluster.database_name (
Optional
[str
]) – The optional name of the database to use within the 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
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- create_resolver(*, data_source=None, field_name, type_name, caching_config=None, 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.caching_config (
Union
[CachingConfig
,Dict
[str
,Any
],None
]) – (experimental) The caching configuration for this resolver. Default: - No caching configurationpipeline_config (
Optional
[Sequence
[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:
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- api_id
(experimental) an unique AWS AppSync GraphQL API identifier i.e. ‘lxz775lwdrgcndgz3nurvac7oa’.
- Stability:
experimental
- arn
(experimental) the ARN of the API.
- Stability:
experimental
- 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.
- node
The construct tree node associated with this construct.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool