Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Exemplos de Aurora usando o SDK para Kotlin
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS SDK para Kotlin com Aurora.
As *noções básicas* são exemplos de código que mostram como realizar as operações essenciais em um serviço.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
*Cenários* são exemplos de código que mostram como realizar tarefas específicas chamando várias funções dentro de um serviço ou combinadas com outros Serviços da AWS.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Conceitos básicos](#basics)
+ [Ações](#actions)
+ [Cenários](#scenarios)
## Conceitos básicos
### Conheça os conceitos básicos
O exemplo de código a seguir mostra como:
+ Criar um grupo de parâmetros de cluster do banco de dados do Aurora e definir os valores dos parâmetros.
+ Criar um cluster de banco de dados que use o grupo de parâmetros.
+ Criar uma instância de banco de dados que contenha um banco de dados.
+ Crie um snapshot do cluster do banco de dados e limpe os recursos.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
/**
Before running this Kotlin code example, set up your development environment, including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
This example requires an AWS Secrets Manager secret that contains the database credentials. If you do not create a
secret, this example will not work. For more details, see:
https://docs.aws.amazon.com/secretsmanager/latest/userguide/integrating_how-services-use-secrets_RS.html
This Kotlin example performs the following tasks:
1. Returns a list of the available DB engines.
2. Creates a custom DB parameter group.
3. Gets the parameter groups.
4. Gets the parameters in the group.
5. Modifies the auto_increment_increment parameter.
6. Displays the updated parameter value.
7. Gets a list of allowed engine versions.
8. Creates an Aurora DB cluster database.
9. Waits for DB instance to be ready.
10. Gets a list of instance classes available for the selected engine.
11. Creates a database instance in the cluster.
12. Waits for the database instance in the cluster to be ready.
13. Creates a snapshot.
14. Waits for DB snapshot to be ready.
15. Deletes the DB instance.
16. Deletes the DB cluster.
17. Deletes the DB cluster group.
*/
var slTime: Long = 20
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
dbClusterGroupName - The database group name.
dbParameterGroupFamily - The database parameter group name.
dbInstanceClusterIdentifier - The database instance identifier.
dbName - The database name.
dbSnapshotIdentifier - The snapshot identifier.
secretName - The name of the AWS Secrets Manager secret that contains the database credentials.
"""
if (args.size != 7) {
println(usage)
exitProcess(1)
}
val dbClusterGroupName = args[0]
val dbParameterGroupFamily = args[1]
val dbInstanceClusterIdentifier = args[2]
val dbInstanceIdentifier = args[3]
val dbName = args[4]
val dbSnapshotIdentifier = args[5]
val secretName = args[6]
val gson = Gson()
val user = gson.fromJson(getSecretValues(secretName).toString(), User::class.java)
val username = user.username
val userPassword = user.password
println("1. Return a list of the available DB engines")
describeAuroraDBEngines()
println("2. Create a custom parameter group")
createDBClusterParameterGroup(dbClusterGroupName, dbParameterGroupFamily)
println("3. Get the parameter group")
describeDbClusterParameterGroups(dbClusterGroupName)
println("4. Get the parameters in the group")
describeDbClusterParameters(dbClusterGroupName, 0)
println("5. Modify the auto_increment_offset parameter")
modifyDBClusterParas(dbClusterGroupName)
println("6. Display the updated parameter value")
describeDbClusterParameters(dbClusterGroupName, -1)
println("7. Get a list of allowed engine versions")
getAllowedClusterEngines(dbParameterGroupFamily)
println("8. Create an Aurora DB cluster database")
val arnClusterVal = createDBCluster(dbClusterGroupName, dbName, dbInstanceClusterIdentifier, username, userPassword)
println("The ARN of the cluster is $arnClusterVal")
println("9. Wait for DB instance to be ready")
waitForClusterInstanceReady(dbInstanceClusterIdentifier)
println("10. Get a list of instance classes available for the selected engine")
val instanceClass = getListInstanceClasses()
println("11. Create a database instance in the cluster.")
val clusterDBARN = createDBInstanceCluster(dbInstanceIdentifier, dbInstanceClusterIdentifier, instanceClass)
println("The ARN of the database is $clusterDBARN")
println("12. Wait for DB instance to be ready")
waitDBAuroraInstanceReady(dbInstanceIdentifier)
println("13. Create a snapshot")
createDBClusterSnapshot(dbInstanceClusterIdentifier, dbSnapshotIdentifier)
println("14. Wait for DB snapshot to be ready")
waitSnapshotReady(dbSnapshotIdentifier, dbInstanceClusterIdentifier)
println("15. Delete the DB instance")
deleteDBInstance(dbInstanceIdentifier)
println("16. Delete the DB cluster")
deleteCluster(dbInstanceClusterIdentifier)
println("17. Delete the DB cluster group")
if (clusterDBARN != null) {
deleteDBClusterGroup(dbClusterGroupName, clusterDBARN)
}
println("The Scenario has successfully completed.")
}
@Throws(InterruptedException::class)
suspend fun deleteDBClusterGroup(
dbClusterGroupName: String,
clusterDBARN: String,
) {
var isDataDel = false
var didFind: Boolean
var instanceARN: String
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
// Make sure that the database has been deleted.
while (!isDataDel) {
val response = rdsClient.describeDbInstances()
val instanceList = response.dbInstances
val listSize = instanceList?.size
isDataDel = false
didFind = false
var index = 1
if (instanceList != null) {
for (instance in instanceList) {
instanceARN = instance.dbInstanceArn.toString()
if (instanceARN.compareTo(clusterDBARN) == 0) {
println("$clusterDBARN still exists")
didFind = true
}
if (index == listSize && !didFind) {
// Went through the entire list and did not find the database ARN.
isDataDel = true
}
delay(slTime * 1000)
index++
}
}
}
val clusterParameterGroupRequest =
DeleteDbClusterParameterGroupRequest {
dbClusterParameterGroupName = dbClusterGroupName
}
rdsClient.deleteDbClusterParameterGroup(clusterParameterGroupRequest)
println("$dbClusterGroupName was deleted.")
}
}
suspend fun deleteCluster(dbInstanceClusterIdentifier: String) {
val deleteDbClusterRequest =
DeleteDbClusterRequest {
dbClusterIdentifier = dbInstanceClusterIdentifier
skipFinalSnapshot = true
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
rdsClient.deleteDbCluster(deleteDbClusterRequest)
println("$dbInstanceClusterIdentifier was deleted!")
}
}
suspend fun deleteDBInstance(dbInstanceIdentifierVal: String) {
val deleteDbInstanceRequest =
DeleteDbInstanceRequest {
dbInstanceIdentifier = dbInstanceIdentifierVal
deleteAutomatedBackups = true
skipFinalSnapshot = true
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.deleteDbInstance(deleteDbInstanceRequest)
print("The status of the database is ${response.dbInstance?.dbInstanceStatus}")
}
}
suspend fun waitSnapshotReady(
dbSnapshotIdentifier: String?,
dbInstanceClusterIdentifier: String?,
) {
var snapshotReady = false
var snapshotReadyStr: String
println("Waiting for the snapshot to become available.")
val snapshotsRequest =
DescribeDbClusterSnapshotsRequest {
dbClusterSnapshotIdentifier = dbSnapshotIdentifier
dbClusterIdentifier = dbInstanceClusterIdentifier
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
while (!snapshotReady) {
val response = rdsClient.describeDbClusterSnapshots(snapshotsRequest)
val snapshotList = response.dbClusterSnapshots
if (snapshotList != null) {
for (snapshot in snapshotList) {
snapshotReadyStr = snapshot.status.toString()
if (snapshotReadyStr.contains("available")) {
snapshotReady = true
} else {
println(".")
delay(slTime * 5000)
}
}
}
}
}
println("The Snapshot is available!")
}
suspend fun createDBClusterSnapshot(
dbInstanceClusterIdentifier: String?,
dbSnapshotIdentifier: String?,
) {
val snapshotRequest =
CreateDbClusterSnapshotRequest {
dbClusterIdentifier = dbInstanceClusterIdentifier
dbClusterSnapshotIdentifier = dbSnapshotIdentifier
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbClusterSnapshot(snapshotRequest)
println("The Snapshot ARN is ${response.dbClusterSnapshot?.dbClusterSnapshotArn}")
}
}
suspend fun waitDBAuroraInstanceReady(dbInstanceIdentifierVal: String?) {
var instanceReady = false
var instanceReadyStr: String
println("Waiting for instance to become available.")
val instanceRequest =
DescribeDbInstancesRequest {
dbInstanceIdentifier = dbInstanceIdentifierVal
}
var endpoint = ""
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
while (!instanceReady) {
val response = rdsClient.describeDbInstances(instanceRequest)
response.dbInstances?.forEach { instance ->
instanceReadyStr = instance.dbInstanceStatus.toString()
if (instanceReadyStr.contains("available")) {
endpoint = instance.endpoint?.address.toString()
instanceReady = true
} else {
print(".")
delay(sleepTime * 1000)
}
}
}
}
println("Database instance is available! The connection endpoint is $endpoint")
}
suspend fun createDBInstanceCluster(
dbInstanceIdentifierVal: String?,
dbInstanceClusterIdentifierVal: String?,
instanceClassVal: String?,
): String? {
val instanceRequest =
CreateDbInstanceRequest {
dbInstanceIdentifier = dbInstanceIdentifierVal
dbClusterIdentifier = dbInstanceClusterIdentifierVal
engine = "aurora-mysql"
dbInstanceClass = instanceClassVal
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbInstance(instanceRequest)
print("The status is ${response.dbInstance?.dbInstanceStatus}")
return response.dbInstance?.dbInstanceArn
}
}
suspend fun getListInstanceClasses(): String {
val optionsRequest =
DescribeOrderableDbInstanceOptionsRequest {
engine = "aurora-mysql"
maxRecords = 20
}
var instanceClass = ""
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeOrderableDbInstanceOptions(optionsRequest)
response.orderableDbInstanceOptions?.forEach { instanceOption ->
instanceClass = instanceOption.dbInstanceClass.toString()
println("The instance class is ${instanceOption.dbInstanceClass}")
println("The engine version is ${instanceOption.engineVersion}")
}
}
return instanceClass
}
// Waits until the database instance is available.
suspend fun waitForClusterInstanceReady(dbClusterIdentifierVal: String?) {
var instanceReady = false
var instanceReadyStr: String
println("Waiting for instance to become available.")
val instanceRequest =
DescribeDbClustersRequest {
dbClusterIdentifier = dbClusterIdentifierVal
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
while (!instanceReady) {
val response = rdsClient.describeDbClusters(instanceRequest)
response.dbClusters?.forEach { cluster ->
instanceReadyStr = cluster.status.toString()
if (instanceReadyStr.contains("available")) {
instanceReady = true
} else {
print(".")
delay(sleepTime * 1000)
}
}
}
}
println("Database cluster is available!")
}
suspend fun createDBCluster(
dbParameterGroupFamilyVal: String?,
dbName: String?,
dbClusterIdentifierVal: String?,
userName: String?,
password: String?,
): String? {
val clusterRequest =
CreateDbClusterRequest {
databaseName = dbName
dbClusterIdentifier = dbClusterIdentifierVal
dbClusterParameterGroupName = dbParameterGroupFamilyVal
engine = "aurora-mysql"
masterUsername = userName
masterUserPassword = password
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbCluster(clusterRequest)
return response.dbCluster?.dbClusterArn
}
}
// Get a list of allowed engine versions.
suspend fun getAllowedClusterEngines(dbParameterGroupFamilyVal: String?) {
val versionsRequest =
DescribeDbEngineVersionsRequest {
dbParameterGroupFamily = dbParameterGroupFamilyVal
engine = "aurora-mysql"
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbEngineVersions(versionsRequest)
response.dbEngineVersions?.forEach { dbEngine ->
println("The engine version is ${dbEngine.engineVersion}")
println("The engine description is ${dbEngine.dbEngineDescription}")
}
}
}
// Modify the auto_increment_offset parameter.
suspend fun modifyDBClusterParas(dClusterGroupName: String?) {
val parameter1 =
Parameter {
parameterName = "auto_increment_offset"
applyMethod = ApplyMethod.fromValue("immediate")
parameterValue = "5"
}
val paraList = ArrayList()
paraList.add(parameter1)
val groupRequest =
ModifyDbClusterParameterGroupRequest {
dbClusterParameterGroupName = dClusterGroupName
parameters = paraList
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.modifyDbClusterParameterGroup(groupRequest)
println("The parameter group ${response.dbClusterParameterGroupName} was successfully modified")
}
}
suspend fun describeDbClusterParameters(
dbCLusterGroupName: String?,
flag: Int,
) {
val dbParameterGroupsRequest: DescribeDbClusterParametersRequest
dbParameterGroupsRequest =
if (flag == 0) {
DescribeDbClusterParametersRequest {
dbClusterParameterGroupName = dbCLusterGroupName
}
} else {
DescribeDbClusterParametersRequest {
dbClusterParameterGroupName = dbCLusterGroupName
source = "user"
}
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbClusterParameters(dbParameterGroupsRequest)
response.parameters?.forEach { para ->
// Only print out information about either auto_increment_offset or auto_increment_increment.
val paraName = para.parameterName
if (paraName != null) {
if (paraName.compareTo("auto_increment_offset") == 0 || paraName.compareTo("auto_increment_increment ") == 0) {
println("*** The parameter name is $paraName")
println("*** The parameter value is ${para.parameterValue}")
println("*** The parameter data type is ${para.dataType}")
println("*** The parameter description is ${para.description}")
println("*** The parameter allowed values is ${para.allowedValues}")
}
}
}
}
}
suspend fun describeDbClusterParameterGroups(dbClusterGroupName: String?) {
val groupsRequest =
DescribeDbClusterParameterGroupsRequest {
dbClusterParameterGroupName = dbClusterGroupName
maxRecords = 20
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbClusterParameterGroups(groupsRequest)
response.dbClusterParameterGroups?.forEach { group ->
println("The group name is ${group.dbClusterParameterGroupName}")
println("The group ARN is ${group.dbClusterParameterGroupArn}")
}
}
}
suspend fun createDBClusterParameterGroup(
dbClusterGroupNameVal: String?,
dbParameterGroupFamilyVal: String?,
) {
val groupRequest =
CreateDbClusterParameterGroupRequest {
dbClusterParameterGroupName = dbClusterGroupNameVal
dbParameterGroupFamily = dbParameterGroupFamilyVal
description = "Created by using the AWS SDK for Kotlin"
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbClusterParameterGroup(groupRequest)
println("The group name is ${response.dbClusterParameterGroup?.dbClusterParameterGroupName}")
}
}
suspend fun describeAuroraDBEngines() {
val engineVersionsRequest =
DescribeDbEngineVersionsRequest {
engine = "aurora-mysql"
defaultOnly = true
maxRecords = 20
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbEngineVersions(engineVersionsRequest)
response.dbEngineVersions?.forEach { engineOb ->
println("The name of the DB parameter group family for the database engine is ${engineOb.dbParameterGroupFamily}")
println("The name of the database engine ${engineOb.engine}")
println("The version number of the database engine ${engineOb.engineVersion}")
}
}
}
```
+ Consulte detalhes da API nos tópicos a seguir na *Referência de API do AWS SDK para Kotlin*.
+ [CriarDBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CriarDBClusterParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Criar DBCluster instantâneo](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CriarDBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ExcluirDBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ExcluirDBClusterParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ExcluirDBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescreverDBClusterParameterGroups](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Descreva DBCluster os parâmetros](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Descreva os DBCluster instantâneos](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescreverDBClusters](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Descreva DBEngine as versões](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescreverDBInstances](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeOrderableDBInstanceOpções](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ModifiqueDBClusterParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
## Ações
### `CreateDBCluster`
O código de exemplo a seguir mostra como usar `CreateDBCluster`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun createDBCluster(
dbParameterGroupFamilyVal: String?,
dbName: String?,
dbClusterIdentifierVal: String?,
userName: String?,
password: String?,
): String? {
val clusterRequest =
CreateDbClusterRequest {
databaseName = dbName
dbClusterIdentifier = dbClusterIdentifierVal
dbClusterParameterGroupName = dbParameterGroupFamilyVal
engine = "aurora-mysql"
masterUsername = userName
masterUserPassword = password
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbCluster(clusterRequest)
return response.dbCluster?.dbClusterArn
}
}
```
+ Para obter detalhes da API, consulte [Criar DBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `CreateDBClusterParameterGroup`
O código de exemplo a seguir mostra como usar `CreateDBClusterParameterGroup`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun createDBClusterParameterGroup(
dbClusterGroupNameVal: String?,
dbParameterGroupFamilyVal: String?,
) {
val groupRequest =
CreateDbClusterParameterGroupRequest {
dbClusterParameterGroupName = dbClusterGroupNameVal
dbParameterGroupFamily = dbParameterGroupFamilyVal
description = "Created by using the AWS SDK for Kotlin"
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbClusterParameterGroup(groupRequest)
println("The group name is ${response.dbClusterParameterGroup?.dbClusterParameterGroupName}")
}
}
```
+ Para obter detalhes da API, consulte [Criar DBCluster ParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `CreateDBClusterSnapshot`
O código de exemplo a seguir mostra como usar `CreateDBClusterSnapshot`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun createDBClusterSnapshot(
dbInstanceClusterIdentifier: String?,
dbSnapshotIdentifier: String?,
) {
val snapshotRequest =
CreateDbClusterSnapshotRequest {
dbClusterIdentifier = dbInstanceClusterIdentifier
dbClusterSnapshotIdentifier = dbSnapshotIdentifier
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbClusterSnapshot(snapshotRequest)
println("The Snapshot ARN is ${response.dbClusterSnapshot?.dbClusterSnapshotArn}")
}
}
```
+ Para obter detalhes da API, consulte [Criar DBCluster instantâneo](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `CreateDBInstance`
O código de exemplo a seguir mostra como usar `CreateDBInstance`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun createDBInstanceCluster(
dbInstanceIdentifierVal: String?,
dbInstanceClusterIdentifierVal: String?,
instanceClassVal: String?,
): String? {
val instanceRequest =
CreateDbInstanceRequest {
dbInstanceIdentifier = dbInstanceIdentifierVal
dbClusterIdentifier = dbInstanceClusterIdentifierVal
engine = "aurora-mysql"
dbInstanceClass = instanceClassVal
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.createDbInstance(instanceRequest)
print("The status is ${response.dbInstance?.dbInstanceStatus}")
return response.dbInstance?.dbInstanceArn
}
}
```
+ Para obter detalhes da API, consulte [Criar DBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DeleteDBCluster`
O código de exemplo a seguir mostra como usar `DeleteDBCluster`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun deleteCluster(dbInstanceClusterIdentifier: String) {
val deleteDbClusterRequest =
DeleteDbClusterRequest {
dbClusterIdentifier = dbInstanceClusterIdentifier
skipFinalSnapshot = true
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
rdsClient.deleteDbCluster(deleteDbClusterRequest)
println("$dbInstanceClusterIdentifier was deleted!")
}
}
```
+ Para obter detalhes da API, consulte [Excluir DBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DeleteDBClusterParameterGroup`
O código de exemplo a seguir mostra como usar `DeleteDBClusterParameterGroup`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
@Throws(InterruptedException::class)
suspend fun deleteDBClusterGroup(
dbClusterGroupName: String,
clusterDBARN: String,
) {
var isDataDel = false
var didFind: Boolean
var instanceARN: String
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
// Make sure that the database has been deleted.
while (!isDataDel) {
val response = rdsClient.describeDbInstances()
val instanceList = response.dbInstances
val listSize = instanceList?.size
isDataDel = false
didFind = false
var index = 1
if (instanceList != null) {
for (instance in instanceList) {
instanceARN = instance.dbInstanceArn.toString()
if (instanceARN.compareTo(clusterDBARN) == 0) {
println("$clusterDBARN still exists")
didFind = true
}
if (index == listSize && !didFind) {
// Went through the entire list and did not find the database ARN.
isDataDel = true
}
delay(slTime * 1000)
index++
}
}
}
val clusterParameterGroupRequest =
DeleteDbClusterParameterGroupRequest {
dbClusterParameterGroupName = dbClusterGroupName
}
rdsClient.deleteDbClusterParameterGroup(clusterParameterGroupRequest)
println("$dbClusterGroupName was deleted.")
}
}
```
+ Para obter detalhes da API, consulte [Excluir DBCluster ParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DeleteDBInstance`
O código de exemplo a seguir mostra como usar `DeleteDBInstance`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun deleteDBInstance(dbInstanceIdentifierVal: String) {
val deleteDbInstanceRequest =
DeleteDbInstanceRequest {
dbInstanceIdentifier = dbInstanceIdentifierVal
deleteAutomatedBackups = true
skipFinalSnapshot = true
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.deleteDbInstance(deleteDbInstanceRequest)
print("The status of the database is ${response.dbInstance?.dbInstanceStatus}")
}
}
```
+ Para obter detalhes da API, consulte [Excluir DBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DescribeDBClusterParameterGroups`
O código de exemplo a seguir mostra como usar `DescribeDBClusterParameterGroups`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun describeDbClusterParameterGroups(dbClusterGroupName: String?) {
val groupsRequest =
DescribeDbClusterParameterGroupsRequest {
dbClusterParameterGroupName = dbClusterGroupName
maxRecords = 20
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbClusterParameterGroups(groupsRequest)
response.dbClusterParameterGroups?.forEach { group ->
println("The group name is ${group.dbClusterParameterGroupName}")
println("The group ARN is ${group.dbClusterParameterGroupArn}")
}
}
}
```
+ Para obter detalhes da API, consulte [Descrever DBCluster ParameterGroups](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DescribeDBClusterParameters`
O código de exemplo a seguir mostra como usar `DescribeDBClusterParameters`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun describeDbClusterParameters(
dbCLusterGroupName: String?,
flag: Int,
) {
val dbParameterGroupsRequest: DescribeDbClusterParametersRequest
dbParameterGroupsRequest =
if (flag == 0) {
DescribeDbClusterParametersRequest {
dbClusterParameterGroupName = dbCLusterGroupName
}
} else {
DescribeDbClusterParametersRequest {
dbClusterParameterGroupName = dbCLusterGroupName
source = "user"
}
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbClusterParameters(dbParameterGroupsRequest)
response.parameters?.forEach { para ->
// Only print out information about either auto_increment_offset or auto_increment_increment.
val paraName = para.parameterName
if (paraName != null) {
if (paraName.compareTo("auto_increment_offset") == 0 || paraName.compareTo("auto_increment_increment ") == 0) {
println("*** The parameter name is $paraName")
println("*** The parameter value is ${para.parameterValue}")
println("*** The parameter data type is ${para.dataType}")
println("*** The parameter description is ${para.description}")
println("*** The parameter allowed values is ${para.allowedValues}")
}
}
}
}
}
```
+ Para obter detalhes da API, consulte [Descrição DBCluster dos parâmetros](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DescribeDBClusterSnapshots`
O código de exemplo a seguir mostra como usar `DescribeDBClusterSnapshots`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun waitSnapshotReady(
dbSnapshotIdentifier: String?,
dbInstanceClusterIdentifier: String?,
) {
var snapshotReady = false
var snapshotReadyStr: String
println("Waiting for the snapshot to become available.")
val snapshotsRequest =
DescribeDbClusterSnapshotsRequest {
dbClusterSnapshotIdentifier = dbSnapshotIdentifier
dbClusterIdentifier = dbInstanceClusterIdentifier
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
while (!snapshotReady) {
val response = rdsClient.describeDbClusterSnapshots(snapshotsRequest)
val snapshotList = response.dbClusterSnapshots
if (snapshotList != null) {
for (snapshot in snapshotList) {
snapshotReadyStr = snapshot.status.toString()
if (snapshotReadyStr.contains("available")) {
snapshotReady = true
} else {
println(".")
delay(slTime * 5000)
}
}
}
}
}
println("The Snapshot is available!")
}
```
+ Para obter detalhes da API, consulte [Descrever DBCluster instantâneos](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DescribeDBClusters`
O código de exemplo a seguir mostra como usar `DescribeDBClusters`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun describeDbClusterParameters(
dbCLusterGroupName: String?,
flag: Int,
) {
val dbParameterGroupsRequest: DescribeDbClusterParametersRequest
dbParameterGroupsRequest =
if (flag == 0) {
DescribeDbClusterParametersRequest {
dbClusterParameterGroupName = dbCLusterGroupName
}
} else {
DescribeDbClusterParametersRequest {
dbClusterParameterGroupName = dbCLusterGroupName
source = "user"
}
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbClusterParameters(dbParameterGroupsRequest)
response.parameters?.forEach { para ->
// Only print out information about either auto_increment_offset or auto_increment_increment.
val paraName = para.parameterName
if (paraName != null) {
if (paraName.compareTo("auto_increment_offset") == 0 || paraName.compareTo("auto_increment_increment ") == 0) {
println("*** The parameter name is $paraName")
println("*** The parameter value is ${para.parameterValue}")
println("*** The parameter data type is ${para.dataType}")
println("*** The parameter description is ${para.description}")
println("*** The parameter allowed values is ${para.allowedValues}")
}
}
}
}
}
```
+ Para obter detalhes da API, consulte [Descrever DBClusters](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DescribeDBEngineVersions`
O código de exemplo a seguir mostra como usar `DescribeDBEngineVersions`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
// Get a list of allowed engine versions.
suspend fun getAllowedClusterEngines(dbParameterGroupFamilyVal: String?) {
val versionsRequest =
DescribeDbEngineVersionsRequest {
dbParameterGroupFamily = dbParameterGroupFamilyVal
engine = "aurora-mysql"
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.describeDbEngineVersions(versionsRequest)
response.dbEngineVersions?.forEach { dbEngine ->
println("The engine version is ${dbEngine.engineVersion}")
println("The engine description is ${dbEngine.dbEngineDescription}")
}
}
}
```
+ Para obter detalhes da API, consulte [Descrever DBEngine versões](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `DescribeDBInstances`
O código de exemplo a seguir mostra como usar `DescribeDBInstances`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
suspend fun waitDBAuroraInstanceReady(dbInstanceIdentifierVal: String?) {
var instanceReady = false
var instanceReadyStr: String
println("Waiting for instance to become available.")
val instanceRequest =
DescribeDbInstancesRequest {
dbInstanceIdentifier = dbInstanceIdentifierVal
}
var endpoint = ""
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
while (!instanceReady) {
val response = rdsClient.describeDbInstances(instanceRequest)
response.dbInstances?.forEach { instance ->
instanceReadyStr = instance.dbInstanceStatus.toString()
if (instanceReadyStr.contains("available")) {
endpoint = instance.endpoint?.address.toString()
instanceReady = true
} else {
print(".")
delay(sleepTime * 1000)
}
}
}
}
println("Database instance is available! The connection endpoint is $endpoint")
}
```
+ Para obter detalhes da API, consulte [Descrever DBInstances](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
### `ModifyDBClusterParameterGroup`
O código de exemplo a seguir mostra como usar `ModifyDBClusterParameterGroup`.
**SDK para Kotlin**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/rds#code-examples).
```
// Modify the auto_increment_offset parameter.
suspend fun modifyDBClusterParas(dClusterGroupName: String?) {
val parameter1 =
Parameter {
parameterName = "auto_increment_offset"
applyMethod = ApplyMethod.fromValue("immediate")
parameterValue = "5"
}
val paraList = ArrayList()
paraList.add(parameter1)
val groupRequest =
ModifyDbClusterParameterGroupRequest {
dbClusterParameterGroupName = dClusterGroupName
parameters = paraList
}
RdsClient.fromEnvironment { region = "us-west-2" }.use { rdsClient ->
val response = rdsClient.modifyDbClusterParameterGroup(groupRequest)
println("The parameter group ${response.dbClusterParameterGroupName} was successfully modified")
}
}
```
+ Para obter detalhes da API, consulte [Modificar DBCluster ParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) no *AWS SDK para referência da API Kotlin*.
## Cenários
### Crie um rastreador de itens de trabalho do Aurora Sem Servidor
O exemplo de código a seguir mostra como criar uma aplicação Web que rastreia os itens de trabalho em um banco de dados do Amazon Aurora Sem Servidor e usa o Amazon Simple Email Service (Amazon SES) para enviar relatórios.
**SDK para Kotlin**
Mostra como construir uma aplicação Web que monitora e gera relatórios sobre itens de trabalho armazenados em um banco de dados do Amazon RDS.
Para obter o código-fonte completo e instruções sobre como configurar uma API Spring REST que consulta dados do Amazon Aurora Serverless e para uso por um aplicativo React, veja o exemplo completo em. [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/usecases/serverless_rds)
**Serviços usados neste exemplo**
+ Aurora
+ Amazon RDS
+ Serviços de dados do Amazon RDS
+ Amazon SES