io.cloudshiftdev.awscdk.services.appsync.RdsDataSource.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.appsync
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.services.iam.IRole
import io.cloudshiftdev.awscdk.services.rds.IServerlessCluster
import io.cloudshiftdev.awscdk.services.secretsmanager.ISecret
import kotlin.String
import kotlin.Unit
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* An AppSync datasource backed by RDS.
*
* Example:
*
* ```
* // Build a data source for AppSync to access the database.
* GraphqlApi api;
* // Create username and password secret for DB Cluster
* DatabaseSecret secret = DatabaseSecret.Builder.create(this, "AuroraSecret")
* .username("clusteradmin")
* .build();
* // The VPC to place the cluster in
* Vpc vpc = new Vpc(this, "AuroraVpc");
* // Create the serverless cluster, provide all values needed to customise the database.
* ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AuroraCluster")
* .engine(DatabaseClusterEngine.AURORA_MYSQL)
* .vpc(vpc)
* .credentials(Map.of("username", "clusteradmin"))
* .clusterIdentifier("db-endpoint-test")
* .defaultDatabaseName("demos")
* .build();
* RdsDataSource rdsDS = api.addRdsDataSource("rds", cluster, secret, "demos");
* // Set up a resolver for an RDS query.
* rdsDS.createResolver("QueryGetDemosRdsResolver", BaseResolverProps.builder()
* .typeName("Query")
* .fieldName("getDemosRds")
* .requestMappingTemplate(MappingTemplate.fromString("\n {\n \"version\": \"2018-05-29\",\n
* \"statements\": [\n \"SELECT * FROM demos\"\n ]\n }\n "))
* .responseMappingTemplate(MappingTemplate.fromString("\n
* $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])\n "))
* .build());
* // Set up a resolver for an RDS mutation.
* rdsDS.createResolver("MutationAddDemoRdsResolver", BaseResolverProps.builder()
* .typeName("Mutation")
* .fieldName("addDemoRds")
* .requestMappingTemplate(MappingTemplate.fromString("\n {\n \"version\": \"2018-05-29\",\n
* \"statements\": [\n \"INSERT INTO demos VALUES (:id, :version)\",\n \"SELECT * WHERE id =
* :id\"\n ],\n \"variableMap\": {\n \":id\": $util.toJson($util.autoId()),\n
* \":version\": $util.toJson($ctx.args.version)\n }\n }\n "))
* .responseMappingTemplate(MappingTemplate.fromString("\n
* $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])\n "))
* .build());
* ```
*/
public open class RdsDataSource(
cdkObject: software.amazon.awscdk.services.appsync.RdsDataSource,
) : BackedDataSource(cdkObject) {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: RdsDataSourceProps,
) :
this(software.amazon.awscdk.services.appsync.RdsDataSource(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(RdsDataSourceProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: RdsDataSourceProps.Builder.() -> Unit,
) : this(scope, id, RdsDataSourceProps(props)
)
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.appsync.RdsDataSource].
*/
@CdkDslMarker
public interface Builder {
/**
* The API to attach this data source to.
*
* @param api The API to attach this data source to.
*/
public fun api(api: IGraphqlApi)
/**
* The name of the database to use within the cluster.
*
* Default: - None
*
* @param databaseName The name of the database to use within the cluster.
*/
public fun databaseName(databaseName: String)
/**
* the description of the data source.
*
* Default: - None
*
* @param description the description of the data source.
*/
public fun description(description: String)
/**
* The name of the data source.
*
* Default: - id of data source
*
* @param name The name of the data source.
*/
public fun name(name: String)
/**
* The secret containing the credentials for the database.
*
* @param secretStore The secret containing the credentials for the database.
*/
public fun secretStore(secretStore: ISecret)
/**
* The serverless cluster to call to interact with this data source.
*
* @param serverlessCluster The serverless cluster to call to interact with this data source.
*/
public fun serverlessCluster(serverlessCluster: IServerlessCluster)
/**
* The IAM service role to be assumed by AppSync to interact with the data source.
*
* Default: - Create a new role
*
* @param serviceRole The IAM service role to be assumed by AppSync to interact with the data
* source.
*/
public fun serviceRole(serviceRole: IRole)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.appsync.RdsDataSource.Builder =
software.amazon.awscdk.services.appsync.RdsDataSource.Builder.create(scope, id)
/**
* The API to attach this data source to.
*
* @param api The API to attach this data source to.
*/
override fun api(api: IGraphqlApi) {
cdkBuilder.api(api.let(IGraphqlApi.Companion::unwrap))
}
/**
* The name of the database to use within the cluster.
*
* Default: - None
*
* @param databaseName The name of the database to use within the cluster.
*/
override fun databaseName(databaseName: String) {
cdkBuilder.databaseName(databaseName)
}
/**
* the description of the data source.
*
* Default: - None
*
* @param description the description of the data source.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* The name of the data source.
*
* Default: - id of data source
*
* @param name The name of the data source.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* The secret containing the credentials for the database.
*
* @param secretStore The secret containing the credentials for the database.
*/
override fun secretStore(secretStore: ISecret) {
cdkBuilder.secretStore(secretStore.let(ISecret.Companion::unwrap))
}
/**
* The serverless cluster to call to interact with this data source.
*
* @param serverlessCluster The serverless cluster to call to interact with this data source.
*/
override fun serverlessCluster(serverlessCluster: IServerlessCluster) {
cdkBuilder.serverlessCluster(serverlessCluster.let(IServerlessCluster.Companion::unwrap))
}
/**
* The IAM service role to be assumed by AppSync to interact with the data source.
*
* Default: - Create a new role
*
* @param serviceRole The IAM service role to be assumed by AppSync to interact with the data
* source.
*/
override fun serviceRole(serviceRole: IRole) {
cdkBuilder.serviceRole(serviceRole.let(IRole.Companion::unwrap))
}
public fun build(): software.amazon.awscdk.services.appsync.RdsDataSource = cdkBuilder.build()
}
public companion object {
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): RdsDataSource {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return RdsDataSource(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.appsync.RdsDataSource):
RdsDataSource = RdsDataSource(cdkObject)
internal fun unwrap(wrapped: RdsDataSource):
software.amazon.awscdk.services.appsync.RdsDataSource = wrapped.cdkObject as
software.amazon.awscdk.services.appsync.RdsDataSource
}
}