AppSyncRdsDataSource

class aws_cdk.aws_appsync.AppSyncRdsDataSource(scope, id, *, secret_store, serverless_cluster, database_name=None, service_role=None, api, description=None, name=None)

Bases: AppSyncBackedDataSource

An AppSync datasource backed by RDS.

ExampleMetadata:: infused

Example:

import aws_cdk.aws_secretsmanager as secretsmanager

# vpc: ec2.Vpc

database_name = "mydb"
cluster = rds.DatabaseCluster(self, "Cluster",
    engine=rds.DatabaseClusterEngine.aurora_postgres(version=rds.AuroraPostgresEngineVersion.VER_16_6),
    writer=rds.ClusterInstance.serverless_v2("writer"),
    vpc=vpc,
    credentials={"username": "clusteradmin"},
    default_database_name=database_name,
    enable_data_api=True
)

secret = secretsmanager.Secret.from_secret_name_v2(self, "Secret", "db-secretName")

api = appsync.EventApi(self, "EventApiRds",
    api_name="RdsEventApi"
)

data_source = api.add_rds_data_source("rdsds", cluster, secret, database_name)

Parameters:

scope (Construct)
id (str)
secret_store (ISecret) – The secret containing the credentials for the database.
serverless_cluster (IServerlessCluster) – The serverless cluster to call to interact with this data source.
database_name (Optional[str]) – The name of the database to use within the cluster. Default: - None
service_role (Optional[IRole]) – The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new role
api (IApi) – The API to attach this data source to.
description (Optional[str]) – The description of the data source. Default: - None
name (Optional[str]) – The name of the data source. The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed. Default: - id of data source

Methods

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

grant_principal: The principal of the data source to be IGrantable.

name: The name of the data source.

node: The tree node.

resource: The underlying CFN data source resource.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.