Interface RdsDataSourceProps

All Superinterfaces:
BackedDataSourceProps, BaseDataSourceProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RdsDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:10.426Z") @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();
 
  • 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