Package software.amazon.awscdk.services.appsync

Interface RdsDataSourcePropsV2

All Superinterfaces:

BackedDataSourceProps, BaseDataSourceProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RdsDataSourcePropsV2.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:05.330Z")
@Stability(Stable)
public interface RdsDataSourcePropsV2
extends software.amazon.jsii.JsiiSerializable, BackedDataSourceProps

Properties for an AppSync RDS datasource Aurora Serverless V2.

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.*;
 DatabaseCluster databaseCluster;
 GraphqlApi graphqlApi;
 Role role;
 Secret secret;
 RdsDataSourcePropsV2 rdsDataSourcePropsV2 = RdsDataSourcePropsV2.builder()
         .api(graphqlApi)
         .secretStore(secret)
         .serverlessCluster(databaseCluster)
         // 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	RdsDataSourcePropsV2.Builder	A builder for RdsDataSourcePropsV2
static final class	RdsDataSourcePropsV2.Jsii$Proxy	An implementation for RdsDataSourcePropsV2

Method Summary

Modifier and Type	Method	Description
static RdsDataSourcePropsV2.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.
IDatabaseCluster	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
IDatabaseCluster 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 RdsDataSourcePropsV2.Builder builder()

Returns:

a RdsDataSourcePropsV2.Builder of RdsDataSourcePropsV2