Package software.amazon.awscdk.services.appsync

Interface RdsDataSourceProps

All Superinterfaces:

BackedDataSourceProps, BaseDataSourceProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RdsDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.538Z")
@Stability(Stable)
public interface RdsDataSourceProps
extends software.amazon.jsii.JsiiSerializable, BackedDataSourceProps

Properties for an AppSync RDS datasource Aurora Serverless V1.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.rds.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 GraphqlApi graphqlApi;
 Role role;
 Secret secret;
 ServerlessCluster serverlessCluster;
 RdsDataSourceProps rdsDataSourceProps = RdsDataSourceProps.builder()
         .api(graphqlApi)
         .secretStore(secret)
         .serverlessCluster(serverlessCluster)
         // the properties below are optional
         .databaseName("databaseName")
         .description("description")
         .name("name")
         .serviceRole(role)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RdsDataSourceProps.Builder	A builder for RdsDataSourceProps
static final class	RdsDataSourceProps.Jsii$Proxy	An implementation for RdsDataSourceProps

Method Summary

Modifier and Type	Method	Description
static RdsDataSourceProps.Builder	builder()
default String	getDatabaseName()	The name of the database to use within the cluster.
ISecret	getSecretStore()	The secret containing the credentials for the database.
IServerlessCluster	getServerlessCluster()	The serverless cluster to call to interact with this data source.

Methods inherited from interface software.amazon.awscdk.services.appsync.BackedDataSourceProps

getServiceRole

Methods inherited from interface software.amazon.awscdk.services.appsync.BaseDataSourceProps

getApi, getDescription, getName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecretStore

@Stability(Stable)
@NotNull
ISecret getSecretStore()

The secret containing the credentials for the database.

getServerlessCluster

@Stability(Stable)
@NotNull
IServerlessCluster getServerlessCluster()

The serverless cluster to call to interact with this data source.

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

The name of the database to use within the cluster.

Default: - None

builder

@Stability(Stable)
static RdsDataSourceProps.Builder builder()

Returns:

a RdsDataSourceProps.Builder of RdsDataSourceProps