RdsDataSource¶
-
class
aws_cdk.aws_appsync.
RdsDataSource
(scope, id, *, secret_store, serverless_cluster, database_name=None, service_role=None, api, description=None, name=None)¶ Bases:
aws_cdk.aws_appsync.BackedDataSource
(experimental) An AppSync datasource backed by RDS.
- Stability
experimental
- Parameters
scope (
Construct
) –id (
str
) –secret_store (
ISecret
) – (experimental) The secret containing the credentials for the database.serverless_cluster (
IServerlessCluster
) – (experimental) The serverless cluster to call to interact with this data source.database_name (
Optional
[str
]) – (experimental) The name of the database to use within the cluster. Default: - Noneservice_role (
Optional
[IRole
]) – (experimental) The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new roleapi (
IGraphqlApi
) – (experimental) The API to attach this data source to.description (
Optional
[str
]) – (experimental) the description of the data source. Default: - Nonename (
Optional
[str
]) – (experimental) The name of the data source. Default: - id of data source
- Stability
experimental
Methods
-
create_function
(*, name, description=None, request_mapping_template=None, response_mapping_template=None)¶ (experimental) creates a new appsync function for this datasource and API using the given properties.
- Parameters
name (
str
) – (experimental) the name of the AppSync Function.description (
Optional
[str
]) – (experimental) the description for this AppSync Function. Default: - no descriptionrequest_mapping_template (
Optional
[MappingTemplate
]) – (experimental) the request mapping template for the AppSync Function. Default: - no request mapping templateresponse_mapping_template (
Optional
[MappingTemplate
]) – (experimental) the response mapping template for the AppSync Function. Default: - no response mapping template
- Stability
experimental
- Return type
-
create_resolver
(*, 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
field_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
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
ds
¶ (experimental) the underlying CFN data source resource.
- Stability
experimental
- Return type
-
grant_principal
¶ (experimental) the principal of the data source to be IGrantable.
- Stability
experimental
- Return type
-
name
¶ (experimental) the name of the data source.
- Stability
experimental
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool