tags;
Aws::ACM::Model::Tag tag;
tag.WithKey(tagKey).WithValue(tagValue);
tags.push_back(tag);
request.WithCertificateArn(certificateArn).WithTags(tags);
Aws::ACM::Model::AddTagsToCertificateOutcome outcome =
acmClient.AddTagsToCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: addTagsToCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
}
else {
std::cout << "Success: Tag with key '" << tagKey <<
"' and value '" << tagValue <<
"' added to certificate with ARN '" <<
certificateArn << "'." << std::endl;
}
return outcome.IsSuccess();
}
```
+ Pour plus de détails sur l'API, reportez-vous [AddTagsToCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/AddTagsToCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour ajouter des balises à un certificat ACM existant**
La commande `add-tags-to-certificate` suivante ajoute deux balises au certificat spécifié. Utilisez un espace pour séparer plusieurs balises :
```
aws acm add-tags-to-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice Key=Purpose,Value=Website
```
+ Pour plus de détails sur l'API, reportez-vous [AddTagsToCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/add-tags-to-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class AddTagsToCertificate {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
addTags(certArn);
}
/**
* Adds tags to a certificate in AWS Certificate Manager (ACM).
*
* @param certArn the Amazon Resource Name (ARN) of the certificate to add tags to
*/
public static void addTags(String certArn) {
AcmClient acmClient = AcmClient.create();
List expectedTags = List.of(Tag.builder().key("key").value("value").build());
AddTagsToCertificateRequest addTagsToCertificateRequest = AddTagsToCertificateRequest.builder()
.certificateArn(certArn)
.tags(expectedTags)
.build();
try {
acmClient.addTagsToCertificate(addTagsToCertificateRequest);
System.out.println("Successfully added tags to a certificate");
} catch (AcmException e) {
System.out.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [AddTagsToCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/AddTagsToCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def add_tags(self, certificate_arn, tags):
"""
Adds tags to a certificate. Tags are key-value pairs that contain custom
metadata.
:param certificate_arn: The ARN of the certificate.
:param tags: A dictionary of key-value tags to add to the certificate.
"""
try:
self.acm_client.add_tags_to_certificate(
CertificateArn=certificate_arn,
Tags=[{"Key": key, "Value": value} for key, value in tags.items()],
)
logger.info("Added %s tags to certificate %s.", len(tags), certificate_arn)
except ClientError:
logger.exception("Couldn't add tags to certificate %s.", certificate_arn)
raise
```
+ Pour plus de détails sur l'API, consultez [AddTagsToCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/AddTagsToCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
lo_acm->addtagstocertificate(
iv_certificatearn = iv_certificate_arn
it_tags = it_tags
).
MESSAGE 'Tags added to certificate successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
CATCH /aws1/cx_acminvalidtagex.
MESSAGE 'Invalid tag provided.' TYPE 'I'.
CATCH /aws1/cx_acmtoomanytagsex.
MESSAGE 'Too many tags for certificate.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [AddTagsToCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `DeleteCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Delete an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::deleteCertificate(const Aws::String &certificateArn,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::DeleteCertificateRequest request;
request.WithCertificateArn(certificateArn);
Aws::ACM::Model::DeleteCertificateOutcome outcome =
acmClient.DeleteCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: DeleteCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
}
else {
std::cout << "Success: The certificate with the ARN '" <<
certificateArn << "' is deleted." << std::endl;
}
return outcome.IsSuccess();
}
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/DeleteCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer un certificat ACM de votre compte**
La commande `delete-certificate` suivante supprime le certificat avec l’ARN spécifié :
```
aws acm delete-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/delete-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class DeleteCert {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
deleteCertificate(certArn);
}
/**
* Deletes an SSL/TLS certificate from the AWS Certificate Manager (ACM).
*
* @param certArn the Amazon Resource Name (ARN) of the certificate to be deleted
*/
public static void deleteCertificate( String certArn) {
AcmClient acmClient = AcmClient.create();
DeleteCertificateRequest request = DeleteCertificateRequest.builder()
.certificateArn(certArn)
.build();
try {
acmClient.deleteCertificate(request);
System.out.println("The certificate was deleted");
} catch (AcmException e) {
System.out.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/DeleteCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : supprime le certificat identifié par l’ARN fourni et la clé privée associée. L’applet de commande vous invite à confirmer avant de poursuivre ; ajoutez le commutateur -Force pour supprimer la confirmation.**
```
Remove-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteCertificate](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : supprime le certificat identifié par l’ARN fourni et la clé privée associée. L’applet de commande vous invite à confirmer avant de poursuivre ; ajoutez le commutateur -Force pour supprimer la confirmation.**
```
Remove-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteCertificate](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def remove(self, certificate_arn):
"""
Removes a certificate.
:param certificate_arn: The ARN of the certificate to remove.
"""
try:
self.acm_client.delete_certificate(CertificateArn=certificate_arn)
logger.info("Removed certificate %s.", certificate_arn)
except ClientError:
logger.exception("Couldn't remove certificate %s.", certificate_arn)
raise
```
+ Pour plus de détails sur l'API, consultez [DeleteCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/DeleteCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
lo_acm->deletecertificate( iv_certificatearn = iv_certificate_arn ).
MESSAGE 'Certificate deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
CATCH /aws1/cx_acmresourceinuseex.
MESSAGE 'Certificate is in use and cannot be deleted.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `DescribeCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ .NET ]
**SDK pour .NET**
Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/ACM#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon;
using Amazon.CertificateManager;
using Amazon.CertificateManager.Model;
namespace DescribeCertificate
{
class DescribeCertificate
{
// The following example retrieves and displays the metadata for a
// certificate using the AWS Certificate Manager (ACM) service.
// Specify your AWS Region (an example Region is shown).
private static readonly RegionEndpoint ACMRegion = RegionEndpoint.USEast1;
private static AmazonCertificateManagerClient _client;
static void Main(string[] args)
{
_client = new Amazon.CertificateManager.AmazonCertificateManagerClient(ACMRegion);
var describeCertificateReq = new DescribeCertificateRequest();
// The ARN used here is just an example. Replace it with the ARN of
// a certificate that exists on your account.
describeCertificateReq.CertificateArn =
"arn:aws:acm:us-east-1:123456789012:certificate/8cfd7dae-9b6a-2d07-92bc-1c309EXAMPLE";
var certificateDetailResp =
DescribeCertificateResponseAsync(client: _client, request: describeCertificateReq);
var certificateDetail = certificateDetailResp.Result.Certificate;
if (certificateDetail is not null)
{
DisplayCertificateDetails(certificateDetail);
}
}
///
/// Displays detailed metadata about a certificate retrieved
/// using the ACM service.
///
/// The object that contains details
/// returned from the call to DescribeCertificateAsync.
static void DisplayCertificateDetails(CertificateDetail certificateDetail)
{
Console.WriteLine("\nCertificate Details: ");
Console.WriteLine($"Certificate Domain: {certificateDetail.DomainName}");
Console.WriteLine($"Certificate Arn: {certificateDetail.CertificateArn}");
Console.WriteLine($"Certificate Subject: {certificateDetail.Subject}");
Console.WriteLine($"Certificate Status: {certificateDetail.Status}");
foreach (var san in certificateDetail.SubjectAlternativeNames)
{
Console.WriteLine($"Certificate SubjectAlternativeName: {san}");
}
}
///
/// Retrieves the metadata associated with the ACM service certificate.
///
/// An AmazonCertificateManagerClient object
/// used to call DescribeCertificateResponse.
/// The DescribeCertificateRequest object that
/// will be passed to the method call.
///
static async Task DescribeCertificateResponseAsync(
AmazonCertificateManagerClient client, DescribeCertificateRequest request)
{
var response = new DescribeCertificateResponse();
try
{
response = await client.DescribeCertificateAsync(request);
}
catch (InvalidArnException)
{
Console.WriteLine($"Error: The ARN specified is invalid.");
}
catch (ResourceNotFoundException)
{
Console.WriteLine($"Error: The specified certificate could not be found.");
}
return response;
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://docs.aws.amazon.com/goto/DotNetSDKV3/acm-2015-12-08/DescribeCertificate)à la section *Référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Describe an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::describeCertificate(const Aws::String &certificateArn,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acm_client(clientConfiguration);
Aws::ACM::Model::DescribeCertificateRequest request;
request.WithCertificateArn(certificateArn);
Aws::ACM::Model::DescribeCertificateOutcome outcome =
acm_client.DescribeCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: DescribeCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
}
else {
Aws::ACM::Model::CertificateDetail certificate =
outcome.GetResult().GetCertificate();
std::cout << "Success: Information about certificate "
"with ARN '" << certificateArn << "':" << std::endl << std::endl;
std::cout << "ARN: " << certificate.GetCertificateArn()
<< std::endl;
std::cout << "Authority ARN: " <<
certificate.GetCertificateAuthorityArn() << std::endl;
std::cout << "Created at (GMT): " <<
certificate.GetCreatedAt().ToGmtString(
Aws::Utils::DateFormat::ISO_8601)
<< std::endl;
std::cout << "Domain name: " << certificate.GetDomainName()
<< std::endl;
Aws::Vector options =
certificate.GetDomainValidationOptions();
if (!options.empty()) {
std::cout << std::endl << "Domain validation information: "
<< std::endl << std::endl;
for (auto &validation: options) {
std::cout << " Domain name: " <<
validation.GetDomainName() << std::endl;
const Aws::ACM::Model::ResourceRecord &record =
validation.GetResourceRecord();
std::cout << " Resource record name: " <<
record.GetName() << std::endl;
Aws::ACM::Model::RecordType recordType = record.GetType();
Aws::String type;
switch (recordType) {
case Aws::ACM::Model::RecordType::CNAME:
type = "CNAME";
break;
case Aws::ACM::Model::RecordType::NOT_SET:
type = "Not set";
break;
default:
type = "Cannot determine.";
break;
}
std::cout << " Resource record type: " << type <<
std::endl;
std::cout << " Resource record value: " <<
record.GetValue() << std::endl;
std::cout << " Validation domain: " <<
validation.GetValidationDomain() << std::endl;
Aws::Vector emails =
validation.GetValidationEmails();
if (!emails.empty()) {
std::cout << " Validation emails:" << std::endl <<
std::endl;
for (auto &email: emails) {
std::cout << " " << email << std::endl;
}
std::cout << std::endl;
}
Aws::ACM::Model::ValidationMethod validationMethod =
validation.GetValidationMethod();
Aws::String method;
switch (validationMethod) {
case Aws::ACM::Model::ValidationMethod::DNS:
method = "DNS";
break;
case Aws::ACM::Model::ValidationMethod::EMAIL:
method = "Email";
break;
case Aws::ACM::Model::ValidationMethod::NOT_SET:
method = "Not set";
break;
default:
method = "Cannot determine";
}
std::cout << " Validation method: " <<
method << std::endl;
Aws::ACM::Model::DomainStatus domainStatus =
validation.GetValidationStatus();
Aws::String status;
switch (domainStatus) {
case Aws::ACM::Model::DomainStatus::FAILED:
status = "Failed";
break;
case Aws::ACM::Model::DomainStatus::NOT_SET:
status = "Not set";
break;
case Aws::ACM::Model::DomainStatus::PENDING_VALIDATION:
status = "Pending validation";
break;
case Aws::ACM::Model::DomainStatus::SUCCESS:
status = "Success";
break;
default:
status = "Cannot determine";
}
std::cout << " Domain validation status: " << status <<
std::endl << std::endl;
}
}
Aws::Vector usages =
certificate.GetExtendedKeyUsages();
if (!usages.empty()) {
std::cout << std::endl << "Extended key usages:" <<
std::endl << std::endl;
for (auto &usage: usages) {
Aws::ACM::Model::ExtendedKeyUsageName usageName =
usage.GetName();
Aws::String name;
switch (usageName) {
case Aws::ACM::Model::ExtendedKeyUsageName::ANY:
name = "Any";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::CODE_SIGNING:
name = "Code signing";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::CUSTOM:
name = "Custom";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::EMAIL_PROTECTION:
name = "Email protection";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::IPSEC_END_SYSTEM:
name = "IPSEC end system";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::IPSEC_TUNNEL:
name = "IPSEC tunnel";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::IPSEC_USER:
name = "IPSEC user";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::NONE:
name = "None";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::NOT_SET:
name = "Not set";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::OCSP_SIGNING:
name = "OCSP signing";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::TIME_STAMPING:
name = "Time stamping";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::TLS_WEB_CLIENT_AUTHENTICATION:
name = "TLS web client authentication";
break;
case Aws::ACM::Model::ExtendedKeyUsageName::TLS_WEB_SERVER_AUTHENTICATION:
name = "TLS web server authentication";
break;
default:
name = "Cannot determine";
}
std::cout << " Name: " << name << std::endl;
std::cout << " OID: " << usage.GetOID() <<
std::endl << std::endl;
}
std::cout << std::endl;
}
Aws::ACM::Model::CertificateStatus certificateStatus =
certificate.GetStatus();
Aws::String status;
switch (certificateStatus) {
case Aws::ACM::Model::CertificateStatus::EXPIRED:
status = "Expired";
break;
case Aws::ACM::Model::CertificateStatus::FAILED:
status = "Failed";
break;
case Aws::ACM::Model::CertificateStatus::INACTIVE:
status = "Inactive";
break;
case Aws::ACM::Model::CertificateStatus::ISSUED:
status = "Issued";
break;
case Aws::ACM::Model::CertificateStatus::NOT_SET:
status = "Not set";
break;
case Aws::ACM::Model::CertificateStatus::PENDING_VALIDATION:
status = "Pending validation";
break;
case Aws::ACM::Model::CertificateStatus::REVOKED:
status = "Revoked";
break;
case Aws::ACM::Model::CertificateStatus::VALIDATION_TIMED_OUT:
status = "Validation timed out";
break;
default:
status = "Cannot determine";
}
std::cout << "Status: " << status << std::endl;
if (certificate.GetStatus() ==
Aws::ACM::Model::CertificateStatus::FAILED) {
Aws::ACM::Model::FailureReason failureReason =
certificate.GetFailureReason();
Aws::String reason;
switch (failureReason) {
case Aws::ACM::Model::FailureReason::ADDITIONAL_VERIFICATION_REQUIRED:
reason = "Additional verification required";
break;
case Aws::ACM::Model::FailureReason::CAA_ERROR:
reason = "CAA error";
break;
case Aws::ACM::Model::FailureReason::DOMAIN_NOT_ALLOWED:
reason = "Domain not allowed";
break;
case Aws::ACM::Model::FailureReason::DOMAIN_VALIDATION_DENIED:
reason = "Domain validation denied";
break;
case Aws::ACM::Model::FailureReason::INVALID_PUBLIC_DOMAIN:
reason = "Invalid public domain";
break;
case Aws::ACM::Model::FailureReason::NOT_SET:
reason = "Not set";
break;
case Aws::ACM::Model::FailureReason::NO_AVAILABLE_CONTACTS:
reason = "No available contacts";
break;
case Aws::ACM::Model::FailureReason::OTHER:
reason = "Other";
break;
case Aws::ACM::Model::FailureReason::PCA_ACCESS_DENIED:
reason = "PCA access denied";
break;
case Aws::ACM::Model::FailureReason::PCA_INVALID_ARGS:
reason = "PCA invalid args";
break;
case Aws::ACM::Model::FailureReason::PCA_INVALID_ARN:
reason = "PCA invalid ARN";
break;
case Aws::ACM::Model::FailureReason::PCA_INVALID_DURATION:
reason = "PCA invalid duration";
break;
case Aws::ACM::Model::FailureReason::PCA_INVALID_STATE:
reason = "PCA invalid state";
break;
case Aws::ACM::Model::FailureReason::PCA_LIMIT_EXCEEDED:
reason = "PCA limit exceeded";
break;
case Aws::ACM::Model::FailureReason::PCA_NAME_CONSTRAINTS_VALIDATION:
reason = "PCA name constraints validation";
break;
case Aws::ACM::Model::FailureReason::PCA_REQUEST_FAILED:
reason = "PCA request failed";
break;
case Aws::ACM::Model::FailureReason::PCA_RESOURCE_NOT_FOUND:
reason = "PCA resource not found";
break;
default:
reason = "Cannot determine";
}
std::cout << "Failure reason: " << reason << std::endl;
}
if (certificate.GetStatus() == Aws::ACM::Model::CertificateStatus::REVOKED) {
std::cout << "Revoked at (GMT): " <<
certificate.GetRevokedAt().ToGmtString(
Aws::Utils::DateFormat::ISO_8601)
<< std::endl;
Aws::ACM::Model::RevocationReason revocationReason =
certificate.GetRevocationReason();
Aws::String reason;
switch (revocationReason) {
case Aws::ACM::Model::RevocationReason::AFFILIATION_CHANGED:
reason = "Affiliation changed";
break;
case Aws::ACM::Model::RevocationReason::A_A_COMPROMISE:
reason = "AA compromise";
break;
case Aws::ACM::Model::RevocationReason::CA_COMPROMISE:
reason = "CA compromise";
break;
case Aws::ACM::Model::RevocationReason::CERTIFICATE_HOLD:
reason = "Certificate hold";
break;
case Aws::ACM::Model::RevocationReason::CESSATION_OF_OPERATION:
reason = "Cessation of operation";
break;
case Aws::ACM::Model::RevocationReason::KEY_COMPROMISE:
reason = "Key compromise";
break;
case Aws::ACM::Model::RevocationReason::NOT_SET:
reason = "Not set";
break;
case Aws::ACM::Model::RevocationReason::PRIVILEGE_WITHDRAWN:
reason = "Privilege withdrawn";
break;
case Aws::ACM::Model::RevocationReason::REMOVE_FROM_CRL:
reason = "Revoke from CRL";
break;
case Aws::ACM::Model::RevocationReason::SUPERCEDED:
reason = "Superceded";
break;
case Aws::ACM::Model::RevocationReason::UNSPECIFIED:
reason = "Unspecified";
break;
default:
reason = "Cannot determine";
}
std::cout << "Revocation reason: " << reason << std::endl;
}
if (certificate.GetType() == Aws::ACM::Model::CertificateType::IMPORTED) {
std::cout << "Imported at (GMT): " <<
certificate.GetImportedAt().ToGmtString(
Aws::Utils::DateFormat::ISO_8601)
<< std::endl;
}
Aws::Vector inUseBys = certificate.GetInUseBy();
if (!inUseBys.empty()) {
std::cout << std::endl << "In use by:" << std::endl << std::endl;
for (auto &in_use_by: inUseBys) {
std::cout << " " << in_use_by << std::endl;
}
std::cout << std::endl;
}
if (certificate.GetType() == Aws::ACM::Model::CertificateType::AMAZON_ISSUED &&
certificate.GetStatus() == Aws::ACM::Model::CertificateStatus::ISSUED) {
std::cout << "Issued at (GMT): " <<
certificate.GetIssuedAt().ToGmtString(
Aws::Utils::DateFormat::ISO_8601)
<< std::endl;
}
std::cout << "Issuer: " << certificate.GetIssuer() <<
std::endl;
Aws::ACM::Model::KeyAlgorithm keyAlgorithm =
certificate.GetKeyAlgorithm();
Aws::String algorithm;
switch (keyAlgorithm) {
case Aws::ACM::Model::KeyAlgorithm::EC_prime256v1:
algorithm = "P-256 (secp256r1, prime256v1)";
break;
case Aws::ACM::Model::KeyAlgorithm::EC_secp384r1:
algorithm = "P-384 (secp384r1)";
break;
case Aws::ACM::Model::KeyAlgorithm::EC_secp521r1:
algorithm = "P-521 (secp521r1)";
break;
case Aws::ACM::Model::KeyAlgorithm::NOT_SET:
algorithm = "Not set";
break;
case Aws::ACM::Model::KeyAlgorithm::RSA_1024:
algorithm = "RSA 1024";
break;
case Aws::ACM::Model::KeyAlgorithm::RSA_2048:
algorithm = "RSA 2048";
break;
case Aws::ACM::Model::KeyAlgorithm::RSA_4096:
algorithm = "RSA 4096";
break;
default:
algorithm = "Cannot determine";
}
std::cout << "Key algorithm: " << algorithm << std::endl;
if (certificate.GetStatus() == Aws::ACM::Model::CertificateStatus::ISSUED) {
std::cout << "Not valid after (GMT): " <<
certificate.GetNotAfter().ToGmtString(
Aws::Utils::DateFormat::ISO_8601)
<< std::endl;
std::cout << "Not valid before (GMT): " <<
certificate.GetNotBefore().ToGmtString(
Aws::Utils::DateFormat::ISO_8601)
<< std::endl;
}
Aws::ACM::Model::CertificateTransparencyLoggingPreference loggingPreference =
certificate.GetOptions().GetCertificateTransparencyLoggingPreference();
Aws::String preference;
switch (loggingPreference) {
case Aws::ACM::Model::CertificateTransparencyLoggingPreference::DISABLED:
preference = "Disabled";
break;
case Aws::ACM::Model::CertificateTransparencyLoggingPreference::ENABLED:
preference = "Enabled";
break;
case Aws::ACM::Model::CertificateTransparencyLoggingPreference::NOT_SET:
preference = "Not set";
break;
default:
preference = "Cannot determine";
}
std::cout << "Logging preference: " << preference << std::endl;
std::cout << "Serial: " << certificate.GetSerial() <<
std::endl;
std::cout << "Signature algorithm: "
<< certificate.GetSignatureAlgorithm() << std::endl;
std::cout << "Subject: " << certificate.GetSubject() <<
std::endl;
Aws::ACM::Model::CertificateType certificateType = certificate.GetType();
Aws::String type;
switch (certificateType) {
case Aws::ACM::Model::CertificateType::AMAZON_ISSUED:
type = "Amazon issued";
break;
case Aws::ACM::Model::CertificateType::IMPORTED:
type = "Imported";
break;
case Aws::ACM::Model::CertificateType::NOT_SET:
type = "Not set";
break;
case Aws::ACM::Model::CertificateType::PRIVATE_:
type = "Private";
break;
default:
type = "Cannot determine";
}
std::cout << "Type: " << type << std::endl;
Aws::Vector altNames =
certificate.GetSubjectAlternativeNames();
if (!altNames.empty()) {
std::cout << std::endl << "Alternative names:" <<
std::endl << std::endl;
for (auto &alt_name: altNames) {
std::cout << " " << alt_name << std::endl;
}
std::cout << std::endl;
}
}
return outcome.IsSuccess();
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/DescribeCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour extraire les champs contenus dans un certificat ACM**
La commande `describe-certificate` suivante extrait tous les champs du certificat avec l’ARN spécifié :
```
aws acm describe-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
```
Une sortie similaire à celle-ci s’affiche :
```
{
"Certificate": {
"CertificateArn": "arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012",
"CreatedAt": 1446835267.0,
"DomainName": "www.example.com",
"DomainValidationOptions": [
{
"DomainName": "www.example.com",
"ValidationDomain": "www.example.com",
"ValidationEmails": [
"hostmaster@example.com",
"admin@example.com",
"owner@example.com.whoisprivacyservice.org",
"tech@example.com.whoisprivacyservice.org",
"admin@example.com.whoisprivacyservice.org",
"postmaster@example.com",
"webmaster@example.com",
"administrator@example.com"
]
},
{
"DomainName": "www.example.net",
"ValidationDomain": "www.example.net",
"ValidationEmails": [
"postmaster@example.net",
"admin@example.net",
"owner@example.net.whoisprivacyservice.org",
"tech@example.net.whoisprivacyservice.org",
"admin@example.net.whoisprivacyservice.org",
"hostmaster@example.net",
"administrator@example.net",
"webmaster@example.net"
]
}
],
"InUseBy": [],
"IssuedAt": 1446835815.0,
"Issuer": "Amazon",
"KeyAlgorithm": "RSA-2048",
"NotAfter": 1478433600.0,
"NotBefore": 1446768000.0,
"Serial": "0f:ac:b0:a3:8d:ea:65:52:2d:7d:01:3a:39:36:db:d6",
"SignatureAlgorithm": "SHA256WITHRSA",
"Status": "ISSUED",
"Subject": "CN=www.example.com",
"SubjectAlternativeNames": [
"www.example.com",
"www.example.net"
]
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/describe-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class DescribeCert {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
describeCertificate(certArn);
}
/**
* Describes the details of an SSL/TLS certificate.
*
* @param certArn the Amazon Resource Name (ARN) of the certificate to describe
* @throws AcmException if an error occurs while describing the certificate
*/
public static void describeCertificate(String certArn) {
AcmClient acmClient = AcmClient.create();
DescribeCertificateRequest req = DescribeCertificateRequest.builder()
.certificateArn(certArn)
.build();
try {
DescribeCertificateResponse response = acmClient.describeCertificate(req);
// Print the certificate details.
System.out.println("Certificate ARN: " + response.certificate().certificateArn());
System.out.println("Domain Name: " + response.certificate().domainName());
System.out.println("Issued By: " + response.certificate().issuer());
System.out.println("Issued On: " + response.certificate().issuedAt());
System.out.println("Status: " + response.certificate().status());
} catch (AcmException e) {
System.out.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/DescribeCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : renvoie les détails du certificat spécifié.**
```
Get-ACMCertificateDetail -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
**Sortie** :
```
CertificateArn : arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
CreatedAt : 1/21/2016 5:55:59 PM
DomainName : www.example.com
DomainValidationOptions : {www.example.com}
InUseBy : {}
IssuedAt : 1/1/0001 12:00:00 AM
Issuer :
KeyAlgorithm : RSA-2048
NotAfter : 1/1/0001 12:00:00 AM
NotBefore : 1/1/0001 12:00:00 AM
RevocationReason :
RevokedAt : 1/1/0001 12:00:00 AM
Serial :
SignatureAlgorithm : SHA256WITHRSA
Status : PENDING_VALIDATION
Subject : CN=www.example.com
SubjectAlternativeNames : {www.example.net}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : renvoie les détails du certificat spécifié.**
```
Get-ACMCertificateDetail -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
**Sortie** :
```
CertificateArn : arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
CreatedAt : 1/21/2016 5:55:59 PM
DomainName : www.example.com
DomainValidationOptions : {www.example.com}
InUseBy : {}
IssuedAt : 1/1/0001 12:00:00 AM
Issuer :
KeyAlgorithm : RSA-2048
NotAfter : 1/1/0001 12:00:00 AM
NotBefore : 1/1/0001 12:00:00 AM
RevocationReason :
RevokedAt : 1/1/0001 12:00:00 AM
Serial :
SignatureAlgorithm : SHA256WITHRSA
Status : PENDING_VALIDATION
Subject : CN=www.example.com
SubjectAlternativeNames : {www.example.net}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def describe(self, certificate_arn):
"""
Gets certificate metadata.
:param certificate_arn: The Amazon Resource Name (ARN) of the certificate.
:return: Metadata about the certificate.
"""
try:
response = self.acm_client.describe_certificate(
CertificateArn=certificate_arn
)
certificate = response["Certificate"]
logger.info(
"Got metadata for certificate for domain %s.", certificate["DomainName"]
)
except ClientError:
logger.exception("Couldn't get data for certificate %s.", certificate_arn)
raise
else:
return certificate
```
+ Pour plus de détails sur l'API, consultez [DescribeCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/DescribeCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
oo_result = lo_acm->describecertificate( iv_certificatearn = iv_certificate_arn ).
MESSAGE 'Certificate details retrieved.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `ExportCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `ExportCertificate`.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Export an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param passphrase: A passphrase to decrypt the exported certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::exportCertificate(const Aws::String &certificateArn,
const Aws::String &passphrase,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acm_client(clientConfiguration);
Aws::ACM::Model::ExportCertificateRequest request;
Aws::Utils::CryptoBuffer cryptoBuffer(
reinterpret_cast(passphrase.c_str()),
passphrase.length());
request.WithCertificateArn(certificateArn).WithPassphrase(cryptoBuffer);
Aws::ACM::Model::ExportCertificateOutcome outcome =
acm_client.ExportCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: ExportCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
}
else {
std::cout << "Success: Information about certificate with ARN '"
<< certificateArn << "':" << std::endl << std::endl;
auto result = outcome.GetResult();
std::cout << "Certificate: " << std::endl << std::endl <<
result.GetCertificate() << std::endl << std::endl;
std::cout << "Certificate chain: " << std::endl << std::endl <<
result.GetCertificateChain() << std::endl << std::endl;
std::cout << "Private key: " << std::endl << std::endl <<
result.GetPrivateKey() << std::endl;
}
return outcome.IsSuccess();
}
```
+ Pour plus de détails sur l'API, reportez-vous [ExportCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/ExportCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour exporter un certificat privé. émis par une autorité de certification privée**
La commande `export-certificate` suivante exporte un certificat privé, une chaîne de certificats et une clé privée sur votre écran :
```
aws acm export-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --passphrase file://path-to-passphrase-file
```
Pour exporter le certificat, la chaîne et la clé privée vers un fichier local, utilisez la commande suivante :
```
aws acm export-certificate --certificate-arn arn:aws:acm:region:sccount:certificate/12345678-1234-1234-1234-123456789012 --passphrase file://path-to-passphrase-file > c:\temp\export.txt
```
+ Pour plus de détails sur l'API, reportez-vous [ExportCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/export-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class ExportCertificate {
public static void main(String[] args) throws Exception {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
exportCert(certArn);
}
/**
* Exports an SSL/TLS certificate and its associated private key and certificate chain from AWS Certificate Manager (ACM).
*
* @param certArn The Amazon Resource Name (ARN) of the certificate that you want to export.
* @throws IOException If an I/O error occurs while reading the private key passphrase file or exporting the certificate.
*/
public static void exportCert(String certArn) throws IOException {
AcmClient acmClient = AcmClient.create();
// Initialize a file descriptor for the passphrase file.
RandomAccessFile filePassphrase = null;
ByteBuffer bufPassphrase = null;
// Create a file stream for reading the private key passphrase.
try {
filePassphrase = new RandomAccessFile("C:\\AWS\\password.txt", "r");
} catch (IllegalArgumentException | SecurityException | FileNotFoundException ex) {
throw ex;
}
// Create a channel to map the file.
FileChannel channelPassphrase = filePassphrase.getChannel();
// Map the file to the buffer.
try {
bufPassphrase = channelPassphrase.map(FileChannel.MapMode.READ_ONLY, 0, channelPassphrase.size());
channelPassphrase.close();
filePassphrase.close();
} catch (IOException ex) {
throw ex;
}
// Create a request object.
ExportCertificateRequest req = ExportCertificateRequest.builder()
.certificateArn(certArn)
.passphrase(SdkBytes.fromByteBuffer(bufPassphrase))
.build();
// Export the certificate.
ExportCertificateResponse result = null;
try {
result = acmClient.exportCertificate(req);
} catch (InvalidArnException | InvalidTagException | ResourceNotFoundException ex) {
throw ex;
}
// Clear the buffer.
bufPassphrase.clear();
// Display the certificate and certificate chain.
String certificate = result.certificate();
System.out.println(certificate);
String certificateChain = result.certificateChain();
System.out.println(certificateChain);
// This example retrieves but does not display the private key.
String privateKey = result.privateKey();
System.out.println("The example is complete");
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ExportCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/ExportCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
# Utilisation `GetCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `GetCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Get an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::getCertificate(const Aws::String &certificateArn,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::GetCertificateRequest request;
request.WithCertificateArn(certificateArn);
Aws::ACM::Model::GetCertificateOutcome outcome =
acmClient.GetCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: GetCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
}
else {
std::cout << "Success: Information about certificate with ARN '"
<< certificateArn << "':" << std::endl << std::endl;
auto result = outcome.GetResult();
std::cout << "Certificate: " << std::endl << std::endl <<
result.GetCertificate() << std::endl;
std::cout << "Certificate chain: " << std::endl << std::endl <<
result.GetCertificateChain() << std::endl;
}
return outcome.IsSuccess();
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/GetCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour extraire un certificat ACM**
La commande `get-certificate` suivante extrait le certificat pour l’ARN spécifié et la chaîne de certificats :
```
aws acm get-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
```
Une sortie similaire à celle-ci s’affiche :
```
{
"Certificate": "-----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----",
"CertificateChain": "-----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----",
"-----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----",
"-----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----"
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/get-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple montre comment renvoyer un certificat et sa chaîne à l’aide de l’ARN du certificat.**
```
Get-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Pour plus de détails sur l'API, reportez-vous [GetCertificate](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple montre comment renvoyer un certificat et sa chaîne à l’aide de l’ARN du certificat.**
```
Get-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Pour plus de détails sur l'API, reportez-vous [GetCertificate](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def get(self, certificate_arn):
"""
Gets the body and certificate chain of a certificate.
:param certificate_arn: The ARN of the certificate.
:return: The body and chain of a certificate.
"""
try:
response = self.acm_client.get_certificate(CertificateArn=certificate_arn)
logger.info("Got certificate %s and its chain.", certificate_arn)
except ClientError:
logger.exception("Couldn't get certificate %s.", certificate_arn)
raise
else:
return response
```
+ Pour plus de détails sur l'API, consultez [GetCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/GetCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
oo_result = lo_acm->getcertificate( iv_certificatearn = iv_certificate_arn ).
MESSAGE 'Certificate body and chain retrieved.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
CATCH /aws1/cx_acmrequestinprgssex.
MESSAGE 'Certificate request is in progress.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [GetCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `ImportCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `ImportCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Import an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateFile: Path to certificate to import.
\param privateKeyFile: Path to file containing a private key.
\param certificateChainFile: Path to file containing a PEM encoded certificate chain.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::importCertificate(const Aws::String &certificateFile,
const Aws::String &privateKeyFile,
const Aws::String &certificateChainFile,
const Aws::Client::ClientConfiguration &clientConfiguration) {
std::ifstream certificateInStream(certificateFile.c_str());
if (!certificateInStream) {
std::cerr << "Error: The certificate file '" << certificateFile <<
"' does not exist." << std::endl;
return false;
}
std::ifstream privateKeyInstream(privateKeyFile.c_str());
if (!privateKeyInstream) {
std::cerr << "Error: The private key file '" << privateKeyFile <<
"' does not exist." << std::endl;
return false;
}
std::ifstream certificateChainInStream(certificateChainFile.c_str());
if (!certificateChainInStream) {
std::cerr << "Error: The certificate chain file '"
<< certificateChainFile << "' does not exist." << std::endl;
return false;
}
Aws::String certificate;
certificate.assign(std::istreambuf_iterator(certificateInStream),
std::istreambuf_iterator());
Aws::String privateKey;
privateKey.assign(std::istreambuf_iterator(privateKeyInstream),
std::istreambuf_iterator());
Aws::String certificateChain;
certificateChain.assign(std::istreambuf_iterator(certificateChainInStream),
std::istreambuf_iterator());
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::ImportCertificateRequest request;
request.WithCertificate(Aws::Utils::ByteBuffer((unsigned char *)
certificate.c_str(),
certificate.size()))
.WithPrivateKey(Aws::Utils::ByteBuffer((unsigned char *)
privateKey.c_str(),
privateKey.size()))
.WithCertificateChain(Aws::Utils::ByteBuffer((unsigned char *)
certificateChain.c_str(),
certificateChain.size()));
Aws::ACM::Model::ImportCertificateOutcome outcome =
acmClient.ImportCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: ImportCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: Certificate associated with ARN '" <<
outcome.GetResult().GetCertificateArn() << "' imported."
<< std::endl;
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ImportCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/ImportCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour importer un certificat dans ACM.**
La commande `import-certificate` suivante importe un certificat dans ACM. Remplacez les noms des fichiers par les vôtres :
```
aws acm import-certificate --certificate file://Certificate.pem --certificate-chain file://CertificateChain.pem --private-key file://PrivateKey.pem
```
+ Pour plus de détails sur l'API, reportez-vous [ImportCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/import-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class ImportCert {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The name of the S3 bucket containing the certificate and private key.
certificateKey - The object key for the SSL/TLS certificate file in S3.
privateKeyKey - The object key for the private key file in S3.
""";
if (args.length != 3) {
System.out.println(usage);
return;
}
String bucketName = args[0];
String certificateKey = args[1];
String privateKeyKey = args[2];
String certificateArn = importCertificate(bucketName, certificateKey, privateKeyKey);
System.out.println("Certificate imported with ARN: " + certificateArn);
}
/**
* Imports an SSL/TLS certificate and private key from S3 into AWS Certificate Manager (ACM).
*
* @param bucketName The name of the S3 bucket.
* @param certificateKey The key for the SSL/TLS certificate file in S3.
* @param privateKeyKey The key for the private key file in S3.
* @return The ARN of the imported certificate.
*/
public static String importCertificate(String bucketName, String certificateKey, String privateKeyKey) {
AcmClient acmClient = AcmClient.create();
S3Client s3Client = S3Client.create();
try {
byte[] certificateBytes = downloadFileFromS3(s3Client, bucketName, certificateKey);
byte[] privateKeyBytes = downloadFileFromS3(s3Client, bucketName, privateKeyKey);
ImportCertificateRequest request = ImportCertificateRequest.builder()
.certificate(SdkBytes.fromByteBuffer(ByteBuffer.wrap(certificateBytes)))
.privateKey(SdkBytes.fromByteBuffer(ByteBuffer.wrap(privateKeyBytes)))
.build();
ImportCertificateResponse response = acmClient.importCertificate(request);
return response.certificateArn();
} catch (IOException e) {
System.err.println("Error downloading certificate or private key from S3: " + e.getMessage());
} catch (S3Exception e) {
System.err.println("S3 error: " + e.awsErrorDetails().errorMessage());
}
return "";
}
/**
* Downloads a file from Amazon S3 and returns its contents as a byte array.
*
* @param s3Client The S3 client.
* @param bucketName The name of the S3 bucket.
* @param objectKey The key of the object in S3.
* @return The file contents as a byte array.
* @throws IOException If an I/O error occurs.
*/
private static byte[] downloadFileFromS3(S3Client s3Client, String bucketName, String objectKey) throws IOException {
GetObjectRequest getObjectRequest = GetObjectRequest.builder()
.bucket(bucketName)
.key(objectKey)
.build();
try (ResponseInputStream s3Object = s3Client.getObject(getObjectRequest);
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
IoUtils.copy(s3Object, byteArrayOutputStream);
return byteArrayOutputStream.toByteArray();
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ImportCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/ImportCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def import_certificate(self, certificate_body, private_key):
"""
Imports a self-signed certificate to ACM.
:param certificate_body: The body of the certificate, in PEM format.
:param private_key: The unencrypted private key of the certificate, in PEM
format.
:return: The ARN of the imported certificate.
"""
try:
response = self.acm_client.import_certificate(
Certificate=certificate_body, PrivateKey=private_key
)
certificate_arn = response["CertificateArn"]
logger.info("Imported certificate.")
except ClientError:
logger.exception("Couldn't import certificate.")
raise
else:
return certificate_arn
```
+ Pour plus de détails sur l'API, consultez [ImportCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/ImportCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" Only pass certificate chain if it's provided (it's optional)
IF iv_certificate_chain IS NOT INITIAL.
DATA(lo_result) = lo_acm->importcertificate(
iv_certificate = iv_certificate
iv_privatekey = iv_private_key
iv_certificatechain = iv_certificate_chain
).
ELSE.
lo_result = lo_acm->importcertificate(
iv_certificate = iv_certificate
iv_privatekey = iv_private_key
).
ENDIF.
ov_certificate_arn = lo_result->get_certificatearn( ).
MESSAGE 'Certificate imported successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidparameterex.
MESSAGE 'Invalid parameter provided.' TYPE 'I'.
CATCH /aws1/cx_acmlimitexceededex.
MESSAGE 'Certificate limit exceeded.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [ImportCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `ListCertificates` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `ListCertificates`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ .NET ]
**SDK pour .NET**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/ACM#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon;
using Amazon.CertificateManager;
using Amazon.CertificateManager.Model;
namespace ListCertificates
{
// The following example retrieves and displays a list of the
// certificates defined for the default account using the AWS
// Certificate Manager (ACM) service.
class ListCertificates
{
// Specify your AWS Region (an example Region is shown).
private static readonly RegionEndpoint ACMRegion = RegionEndpoint.USEast1;
private static AmazonCertificateManagerClient _client;
static void Main(string[] args)
{
_client = new AmazonCertificateManagerClient(ACMRegion);
var certificateList = ListCertificatesResponseAsync(client: _client);
Console.WriteLine("Certificate Summary List\n");
foreach (var certificate in certificateList.Result.CertificateSummaryList)
{
Console.WriteLine($"Certificate Domain: {certificate.DomainName}");
Console.WriteLine($"Certificate ARN: {certificate.CertificateArn}\n");
}
}
///
/// Retrieves a list of the certificates defined in this Region.
///
/// The ACM client object passed to the
/// ListCertificateResAsync method call.
///
/// The ListCertificatesResponse.
static async Task ListCertificatesResponseAsync(
AmazonCertificateManagerClient client)
{
var request = new ListCertificatesRequest();
var response = await client.ListCertificatesAsync(request);
return response;
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://docs.aws.amazon.com/goto/DotNetSDKV3/acm-2015-12-08/ListCertificates)à la section *Référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! List the AWS Certificate Manager (ACM) certificates in an account.
/*!
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::listCertificates(
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::ListCertificatesRequest request;
Aws::Vector allCertificates;
Aws::String nextToken;
do {
if (!nextToken.empty()) {
request.SetNextToken(nextToken);
}
Aws::ACM::Model::ListCertificatesOutcome outcome =
acmClient.ListCertificates(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: ListCertificates: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
const Aws::ACM::Model::ListCertificatesResult &result = outcome.GetResult();
const Aws::Vector &certificates =
result.GetCertificateSummaryList();
allCertificates.insert(allCertificates.end(), certificates.begin(),
certificates.end());
nextToken = result.GetNextToken();
}
} while (!nextToken.empty());
if (!allCertificates.empty()) {
for (const Aws::ACM::Model::CertificateSummary &certificate: allCertificates) {
std::cout << "Certificate ARN: " <<
certificate.GetCertificateArn() << std::endl;
std::cout << "Domain name: " <<
certificate.GetDomainName() << std::endl << std::endl;
}
}
else {
std::cout << "No available certificates found in account."
<< std::endl;
}
return true;
}
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/ListCertificates)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour répertorier les certificats ACM d'un AWS compte**
La `list-certificates` commande suivante répertorie les certificats ARNs de votre compte :
```
aws acm list-certificates
```
La commande précédente génère une sortie similaire à la sortie suivante :
```
{
"CertificateSummaryList": [
{
"CertificateArn": "arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012",
"DomainName": "www.example.com"
},
{
"CertificateArn": "arn:aws:acm:region:account:certificate/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"DomainName": "www.example.net"
}
]
}
```
Vous pouvez décider du nombre de certificats que vous souhaitez afficher à chaque fois que vous appelez `list-certificates`. Par exemple, si vous avez quatre certificats et que vous ne souhaitez pas en afficher plus de deux à la fois, définissez l’argument `max-items` sur 2 comme dans l’exemple suivant :
```
aws acm list-certificates --max-items 2
```
Deux certificats ARNs et une `NextToken` valeur seront affichés :
```
"CertificateSummaryList": [
{
"CertificateArn": "arn:aws:acm:region:account: \
certificate/12345678-1234-1234-1234-123456789012",
"DomainName": "www.example.com"
},
{
"CertificateArn": "arn:aws:acm:region:account: \
certificate/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"DomainName": "www.example.net"
}
],
"NextToken": "9f4d9f69-275a-41fe-b58e-2b837bd9ba48"
```
Pour afficher les deux certificats suivants dans votre compte, définissez la valeur `NextToken` lors de votre prochain appel :
```
aws acm list-certificates --max-items 2 --next-token 9f4d9f69-275a-41fe-b58e-2b837bd9ba48
```
Vous pouvez filtrer votre sortie à l’aide de l’argument `certificate-statuses`. La commande suivante affiche les certificats dont le statut est PENDING\$1VALIDATION :
```
aws acm list-certificates --certificate-statuses PENDING_VALIDATION
```
Vous pouvez également filtrer votre sortie en utilisant l’argument `includes`. La commande suivante affiche les certificats filtrés selon les propriétés suivantes. Certificats à afficher :
```
- Specify that the RSA algorithm and a 2048 bit key are used to generate key pairs.
- Contain a Key Usage extension that specifies that the certificates can be used to create digital signatures.
- Contain an Extended Key Usage extension that specifies that the certificates can be used for code signing.
aws acm list-certificates --max-items 10 --includes extendedKeyUsage=CODE_SIGNING,keyUsage=DIGITAL_SIGNATURE,keyTypes=RSA_2048
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/list-certificates.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class ListCerts {
public static void main(String[] args) {
listCertificates();
}
/**
* Lists all the certificates managed by AWS Certificate Manager (ACM) that have a status of "ISSUED".
*/
public static void listCertificates() {
AcmClient acmClient = AcmClient.create();
try {
ListCertificatesRequest listRequest = ListCertificatesRequest.builder()
.certificateStatuses(CertificateStatus.ISSUED)
.maxItems(100)
.build();
ListCertificatesIterable listResponse = acmClient.listCertificatesPaginator(listRequest);
// Print the certificate details using streams
listResponse.certificateSummaryList().stream()
.forEach(certificate -> {
System.out.println("Certificate ARN: " + certificate.certificateArn());
System.out.println("Certificate Domain Name: " + certificate.domainName());
System.out.println("Certificate Status: " + certificate.statusAsString());
System.out.println("---");
});
} catch (AcmException e) {
System.err.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/ListCertificates)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : récupère la liste de tous vos certificats ARNs et le nom de domaine de chacun d'entre eux. L'applet de commande pagine automatiquement pour récupérer tous les. ARNs Pour contrôler manuellement la pagination, utilisez le MaxItem paramètre - pour contrôler le nombre de certificats ARNs renvoyés pour chaque appel de service et le NextToken paramètre - pour indiquer le point de départ de chaque appel.**
```
Get-ACMCertificateList
```
**Sortie** :
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 www.example.com
```
**Exemple 2 : récupère une liste de tous vos certificats ARNs dont le statut correspond aux états fournis.**
```
Get-ACMCertificateList -CertificateStatus "VALIDATION_TIMED_OUT","FAILED"
```
**Exemple 3 : cet exemple renvoie une liste de tous les certificats de la région us-east-1 dont le type de clé est RSA\$12048 et dont l’utilisation ou l’objectif étendu de la clé est CODE\$1SIGNING. Vous trouverez les valeurs de ces paramètres de filtrage dans la rubrique de référence de l'API ListCertificates Filters : https://docs.aws.amazon.com/acm/ latest/APIReference/API \$1Filters.html.**
```
Get-ACMCertificateList -Region us-east-1 -Includes_KeyType RSA_2048 -Includes_ExtendedKeyUsage CODE_SIGNING
```
**Sortie** :
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-d7c0-48c1-af8d-2133d8f30zzz *.route53docs.com
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-98a5-443d-a734-800430c80zzz nerdzizm.net
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-2be6-4376-8fa7-bad559525zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-e7ca-44c5-803e-24d9f2f36zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-1241-4b71-80b1-090305a62zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-8709-4568-8c64-f94617c99zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-a8fa-4a61-98cf-e08ccc0eezzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-fa47-40fe-a714-2d277d3eezzz *.route53docs.com
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : récupère la liste de tous vos certificats ARNs et le nom de domaine de chacun d'entre eux. L'applet de commande pagine automatiquement pour récupérer tous les. ARNs Pour contrôler manuellement la pagination, utilisez le MaxItem paramètre - pour contrôler le nombre de certificats ARNs renvoyés pour chaque appel de service et le NextToken paramètre - pour indiquer le point de départ de chaque appel.**
```
Get-ACMCertificateList
```
**Sortie** :
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 www.example.com
```
**Exemple 2 : récupère une liste de tous vos certificats ARNs dont le statut correspond aux états fournis.**
```
Get-ACMCertificateList -CertificateStatus "VALIDATION_TIMED_OUT","FAILED"
```
**Exemple 3 : cet exemple renvoie une liste de tous les certificats de la région us-east-1 dont le type de clé est RSA\$12048 et dont l’utilisation ou l’objectif étendu de la clé est CODE\$1SIGNING. Vous trouverez les valeurs de ces paramètres de filtrage dans la rubrique de référence de l'API ListCertificates Filters : https://docs.aws.amazon.com/acm/ latest/APIReference/API \$1Filters.html.**
```
Get-ACMCertificateList -Region us-east-1 -Includes_KeyType RSA_2048 -Includes_ExtendedKeyUsage CODE_SIGNING
```
**Sortie** :
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-d7c0-48c1-af8d-2133d8f30zzz *.route53docs.com
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-98a5-443d-a734-800430c80zzz nerdzizm.net
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-2be6-4376-8fa7-bad559525zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-e7ca-44c5-803e-24d9f2f36zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-1241-4b71-80b1-090305a62zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-8709-4568-8c64-f94617c99zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-a8fa-4a61-98cf-e08ccc0eezzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-fa47-40fe-a714-2d277d3eezzz *.route53docs.com
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def list(
self,
max_items,
statuses=None,
key_usage=None,
extended_key_usage=None,
key_types=None,
):
"""
Lists the certificates for the current account.
:param max_items: The maximum number of certificates to list.
:param statuses: Filters the results to the specified statuses. If None, all
certificates are included.
:param key_usage: Filters the results to the specified key usages. If None,
all key usages are included.
:param extended_key_usage: Filters the results to the specified extended key
usages. If None, all extended key usages are
included.
:param key_types: Filters the results to the specified key types. If None, all
key types are included.
:return: The list of certificates.
"""
try:
kwargs = {"MaxItems": max_items}
if statuses is not None:
kwargs["CertificateStatuses"] = statuses
includes = {}
if key_usage is not None:
includes["keyUsage"] = key_usage
if extended_key_usage is not None:
includes["extendedKeyUsage"] = extended_key_usage
if key_types is not None:
includes["keyTypes"] = key_types
if includes:
kwargs["Includes"] = includes
response = self.acm_client.list_certificates(**kwargs)
certificates = response["CertificateSummaryList"]
logger.info("Got %s certificates.", len(certificates))
except ClientError:
logger.exception("Couldn't get certificates.")
raise
else:
return certificates
```
+ Pour plus de détails sur l'API, consultez [ListCertificates](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/ListCertificates)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
oo_result = lo_acm->listcertificates(
iv_maxitems = iv_max_items
it_certificatestatuses = it_statuses
io_includes = io_includes
).
MESSAGE 'Certificates listed successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidargsex.
MESSAGE 'Invalid arguments provided.' TYPE 'I'.
CATCH /aws1/cx_acmvalidationex.
MESSAGE 'Validation error occurred.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [ListCertificates](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `ListTagsForCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `ListTagsForCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! List the tags for an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::listTagsForCertificate(const Aws::String &certificateArn,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acm_client(clientConfiguration);
Aws::ACM::Model::ListTagsForCertificateRequest request;
request.WithCertificateArn(certificateArn);
Aws::ACM::Model::ListTagsForCertificateOutcome outcome =
acm_client.ListTagsForCertificate(request);
if (!outcome.IsSuccess()) {
std::cout << "Error: ListTagsForCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: Information about tags for "
"certificate with ARN '"
<< certificateArn << "':" << std::endl << std::endl;
auto result = outcome.GetResult();
Aws::Vector tags =
result.GetTags();
if (tags.size() > 0) {
for (const Aws::ACM::Model::Tag &tag: tags) {
std::cout << "Key: " << tag.GetKey() << std::endl;
std::cout << "Value: " << tag.GetValue()
<< std::endl << std::endl;
}
}
else {
std::cout << "No tags found." << std::endl;
}
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ListTagsForCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/ListTagsForCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour répertorier les balises appliquées à un certificat ACM**
La commande `list-tags-for-certificate` suivante répertorie les balises appliquées à un certificat dans votre compte :
```
aws acm list-tags-for-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
```
La commande précédente génère une sortie similaire à la sortie suivante :
```
{
"Tags": [
{
"Value": "Website",
"Key": "Purpose"
},
{
"Value": "Alice",
"Key": "Admin"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [ListTagsForCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/list-tags-for-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class ListCertTags {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
listCertTags(certArn);
}
/**
* Lists the tags associated with an AWS Certificate Manager (ACM) certificate.
*
* @param certArn the Amazon Resource Name (ARN) of the ACM certificate
*/
public static void listCertTags(String certArn) {
AcmClient acmClient = AcmClient.create();
ListTagsForCertificateRequest request = ListTagsForCertificateRequest.builder()
.certificateArn(certArn)
.build();
ListTagsForCertificateResponse response = acmClient.listTagsForCertificate(request);
List tagList = response.tags();
tagList.forEach(tag -> {
System.out.println("Key: " + tag.key());
System.out.println("Value: " + tag.value());
});
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ListTagsForCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/ListTagsForCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def list_tags(self, certificate_arn):
"""
Lists the tags attached to a certificate.
:param certificate_arn: The ARN of the certificate.
:return: The dictionary of certificate tags.
"""
try:
response = self.acm_client.list_tags_for_certificate(
CertificateArn=certificate_arn
)
tags = {tag["Key"]: tag["Value"] for tag in response["Tags"]}
logger.info("Got %s tags for certificates %s.", len(tags), certificate_arn)
except ClientError:
logger.exception("Couldn't get tags for certificate %s.", certificate_arn)
raise
else:
return tags
```
+ Pour plus de détails sur l'API, consultez [ListTagsForCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/ListTagsForCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
DATA(lo_result) = lo_acm->listtagsforcertificate(
iv_certificatearn = iv_certificate_arn
).
ot_tags = lo_result->get_tags( ).
MESSAGE 'Certificate tags retrieved successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [ListTagsForCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `RemoveTagsFromCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `RemoveTagsFromCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Remove a tag from an ACM certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param tagKey: The key for the tag.
\param tagValue: The value for the tag.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::removeTagsFromCertificate(const Aws::String &certificateArn,
const Aws::String &tagKey,
const Aws::String &tagValue,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::Vector tags;
Aws::ACM::Model::Tag tag;
tag.SetKey(tagKey);
tags.push_back(tag);
Aws::ACM::Model::RemoveTagsFromCertificateRequest request;
request.WithCertificateArn(certificateArn)
.WithTags(tags);
Aws::ACM::Model::RemoveTagsFromCertificateOutcome outcome =
acmClient.RemoveTagsFromCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: RemoveTagFromCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: Tag with key '" << tagKey << "' removed from "
<< "certificate with ARN '" << certificateArn << "'." << std::endl;
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RemoveTagsFromCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/RemoveTagsFromCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer une balise d’un certificat ACM**
La commande `remove-tags-from-certificate` suivante supprime deux balises du certificat spécifié. Utilisez un espace pour séparer plusieurs balises :
```
aws acm remove-tags-from-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice Key=Purpose,Value=Website
```
+ Pour plus de détails sur l'API, reportez-vous [RemoveTagsFromCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/remove-tags-from-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class RemoveTagsFromCert {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
removeTags(certArn);
}
/**
* Removes tags from an AWS Certificate Manager (ACM) certificate.
*
* @param certArn the Amazon Resource Name (ARN) of the certificate from which to remove tags
*/
public static void removeTags(String certArn) {
AcmClient acmClient = AcmClient.create();
List expectedTags = List.of(Tag.builder().key("key").value("value").build());
RemoveTagsFromCertificateRequest req = RemoveTagsFromCertificateRequest.builder()
.certificateArn(certArn)
.tags(expectedTags)
.build();
try {
acmClient.removeTagsFromCertificate(req);
System.out.println("Successfully removed tags from the certificate");
} catch (AcmException e) {
System.err.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RemoveTagsFromCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/RemoveTagsFromCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def remove_tags(self, certificate_arn, tags):
"""
Removes tags from a certificate. If the value of a tag is specified, the tag is
removed only when the value matches the value of the certificate's tag.
Otherwise, the tag is removed regardless of its value.
:param certificate_arn: The ARN of the certificate.
:param tags: The dictionary of tags to remove.
"""
try:
cert_tags = []
for key, value in tags.items():
tag = {"Key": key}
if value is not None:
tag["Value"] = value
cert_tags.append(tag)
self.acm_client.remove_tags_from_certificate(
CertificateArn=certificate_arn, Tags=cert_tags
)
logger.info(
"Removed %s tags from certificate %s.", len(tags), certificate_arn
)
except ClientError:
logger.exception(
"Couldn't remove tags from certificate %s.", certificate_arn
)
raise
```
+ Pour plus de détails sur l'API, consultez [RemoveTagsFromCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/RemoveTagsFromCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
lo_acm->removetagsfromcertificate(
iv_certificatearn = iv_certificate_arn
it_tags = it_tags
).
MESSAGE 'Tags removed from certificate successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
CATCH /aws1/cx_acminvalidtagex.
MESSAGE 'Invalid tag provided.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [RemoveTagsFromCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `RenewCertificate` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `RenewCertificate`.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Renew an AWS Certificate Manager (ACM) certificate.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::renewCertificate(const Aws::String &certificateArn,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::RenewCertificateRequest request;
request.SetCertificateArn(certificateArn);
Aws::ACM::Model::RenewCertificateOutcome outcome =
acmClient.RenewCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: RenewCertificate: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: Renewed certificate with ARN '"
<< certificateArn << "'." << std::endl;
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RenewCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/RenewCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class RenewCert {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
certArn - the ARN of the certificate.
""";
if (args.length != 1) {
System.out.println(usage);
return;
}
String certArn = args[0];
renewCertificate(certArn);
}
/**
* Renews an existing SSL/TLS certificate in AWS Certificate Manager (ACM).
*
* @param certArn The Amazon Resource Name (ARN) of the certificate to be renewed.
* @throws AcmException If there is an error renewing the certificate.
*/
public static void renewCertificate(String certArn) {
AcmClient acmClient = AcmClient.create();
RenewCertificateRequest certificateRequest = RenewCertificateRequest.builder()
.certificateArn(certArn)
.build();
try {
acmClient.renewCertificate(certificateRequest);
System.out.println("The certificate was renewed");
} catch(AcmException e){
System.out.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RenewCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/RenewCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
# Utilisation `RequestCertificate` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `RequestCertificate`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Request an AWS Certificate Manager (ACM) certificate.
/*!
\param domainName: A fully qualified domain name.
\param idempotencyToken: Customer chosen string for idempotency.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::requestCertificate(const Aws::String &domainName,
const Aws::String &idempotencyToken,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::RequestCertificateRequest request;
request.WithDomainName(domainName)
.WithIdempotencyToken(idempotencyToken);
Aws::ACM::Model::RequestCertificateOutcome outcome =
acmClient.RequestCertificate(request);
if (!outcome.IsSuccess()) {
std::cerr << "RequestCertificate error: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: The newly requested certificate's "
"ARN is '" <<
outcome.GetResult().GetCertificateArn() <<
"'." << std::endl;
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RequestCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/RequestCertificate)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour demander un nouveau certificat ACM**
La commande `request-certificate` suivante demande un nouveau certificat pour le domaine www.example.com à l’aide de la validation DNS :
```
aws acm request-certificate --domain-name www.example.com --validation-method DNS
```
Vous pouvez saisir un jeton d’idempotence pour distinguer les appels à `request-certificate` :
```
aws acm request-certificate --domain-name www.example.com --validation-method DNS --idempotency-token 91adc45q
```
Vous pouvez saisir un ou plusieurs noms de sujet alternatifs pour demander un certificat qui protégera plusieurs domaines apex :
```
aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.net
```
Vous pouvez saisir un autre nom qui peut également être utilisé pour accéder à votre site Web :
```
aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.com
```
Vous pouvez utiliser un astérisque (\$1) comme caractère générique pour créer un certificat pour plusieurs sous-domaine dans le même domaine :
```
aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names *.example.com
```
Vous pouvez également saisir plusieurs autres noms :
```
aws acm request-certificate --domain-name example.com --validation-method DNS --subject-alternative-names b.example.com c.example.com d.example.com
```
Si vous utilisez la validation par courriel, vous pouvez saisir des options de validation de domaine pour spécifier le domaine auquel l’e-mail de validation sera envoyé :
```
aws acm request-certificate --domain-name example.com --validation-method EMAIL --subject-alternative-names www.example.com --domain-validation-options DomainName=example.com,ValidationDomain=example.com
```
La commande suivante permet de désactiver la journalisation transparente des certificats lorsque vous demandez un nouveau certificat :
```
aws acm request-certificate --domain-name www.example.com --validation-method DNS --options CertificateTransparencyLoggingPreference=DISABLED --idempotency-token 184627
```
+ Pour plus de détails sur l'API, reportez-vous [RequestCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/request-certificate.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/acm#code-examples).
```
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class RequestCert {
public static void main(String[] args) {
requestCertificate();
}
/**
* Requests a certificate from the AWS Certificate Manager (ACM) service.
*/
public static void requestCertificate() {
AcmClient acmClient = AcmClient.create();
ArrayList san = new ArrayList<>();
san.add("www.example.com");
RequestCertificateRequest req = RequestCertificateRequest.builder()
.domainName("example.com")
.idempotencyToken("1Aq25pTy")
.subjectAlternativeNames(san)
.build();
try {
RequestCertificateResponse response = acmClient.requestCertificate(req);
System.out.println("Cert ARN IS " + response.certificateArn());
} catch (AcmException e) {
System.err.println(e.getMessage());
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RequestCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/acm-2015-12-08/RequestCertificate)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : crée un nouveau certificat. Le service renvoie l’ARN du nouveau certificat.**
```
New-ACMCertificate -DomainName "www.example.com"
```
**Sortie** :
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
**Exemple 2 : crée un nouveau certificat. Le service renvoie l’ARN du nouveau certificat.**
```
New-ACMCertificate -DomainName "www.example.com" -SubjectAlternativeName "example.com","www.example.net"
```
**Sortie** :
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
+ Pour plus de détails sur l'API, reportez-vous [RequestCertificate](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : crée un nouveau certificat. Le service renvoie l’ARN du nouveau certificat.**
```
New-ACMCertificate -DomainName "www.example.com"
```
**Sortie** :
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
**Exemple 2 : crée un nouveau certificat. Le service renvoie l’ARN du nouveau certificat.**
```
New-ACMCertificate -DomainName "www.example.com" -SubjectAlternativeName "example.com","www.example.net"
```
**Sortie** :
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
+ Pour plus de détails sur l'API, reportez-vous [RequestCertificate](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def request_validation(
self, domain, alternate_domains, method, validation_domains=None
):
"""
Starts a validation request that results in a new certificate being issued
by ACM. DNS validation requires that you add CNAME records to your DNS
provider. Email validation sends email to a list of email addresses that
are associated with the domain.
For more information, see _Issuing and managing certificates_ in the ACM
user guide.
https://docs.aws.amazon.com/acm/latest/userguide/gs.html
:param domain: The primary domain to associate with the certificate.
:param alternate_domains: Subject Alternate Names (SANs) for the certificate.
:param method: The validation method, either DNS or EMAIL.
:param validation_domains: Alternate domains to use for email validation, when
the email domain differs from the primary domain of
the certificate.
:return: The ARN of the requested certificate.
"""
try:
kwargs = {
"DomainName": domain,
"ValidationMethod": method,
"SubjectAlternativeNames": alternate_domains,
}
if validation_domains is not None:
kwargs["DomainValidationOptions"] = [
{"DomainName": key, "ValidationDomain": value}
for key, value in validation_domains.items()
]
response = self.acm_client.request_certificate(**kwargs)
certificate_arn = response["CertificateArn"]
logger.info(
"Requested %s validation for domain %s. Certificate ARN is %s.",
method,
domain,
certificate_arn,
)
except ClientError:
logger.exception(
"Request for %s validation of domain %s failed.", method, domain
)
raise
else:
return certificate_arn
```
+ Pour plus de détails sur l'API, consultez [RequestCertificate](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/RequestCertificate)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_domain_name = 'example.com'
" iv_validation_method = 'DNS' or 'EMAIL'
DATA(lo_result) = lo_acm->requestcertificate(
iv_domainname = iv_domain_name
it_subjectalternativenames = COND #( WHEN it_alternate_domains IS NOT INITIAL
THEN it_alternate_domains )
iv_validationmethod = iv_validation_method
).
ov_certificate_arn = lo_result->get_certificatearn( ).
MESSAGE 'Certificate requested successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidparameterex.
MESSAGE 'Invalid parameter provided.' TYPE 'I'.
CATCH /aws1/cx_acmlimitexceededex.
MESSAGE 'Certificate limit exceeded.' TYPE 'I'.
CATCH /aws1/cx_acminvdomvationoptsex.
MESSAGE 'Invalid domain validation options.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [RequestCertificate](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `ResendValidationEmail` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `ResendValidationEmail`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](acm_example_acm_Usage_ImportListRemove_section.md)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Resend the email that requests domain ownership validation.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param domainName: A fully qualified domain name.
\param validationDomain: The base validation domain that will act as the suffix
of the email addresses.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::resendValidationEmail(const Aws::String &certificateArn,
const Aws::String &domainName,
const Aws::String &validationDomain,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::ResendValidationEmailRequest request;
request.WithCertificateArn(certificateArn)
.WithDomain(domainName)
.WithValidationDomain(validationDomain);
Aws::ACM::Model::ResendValidationEmailOutcome outcome =
acmClient.ResendValidationEmail(request);
if (!outcome.IsSuccess()) {
std::cerr << "ResendValidationEmail error: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: The validation email has been resent."
<< std::endl;
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [ResendValidationEmail](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/ResendValidationEmail)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour renvoyer un e-mail de validation pour votre demande de certificat ACM**
La commande `resend-validation-email` suivante indique à l’autorité de certification Amazon d’envoyer un e-mail de validation aux adresses appropriées :
```
aws acm resend-validation-email --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --domain www.example.com --validation-domain example.com
```
+ Pour plus de détails sur l'API, reportez-vous [ResendValidationEmail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/resend-validation-email.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : demande que l’e-mail de validation de la propriété du domaine pour « www.exemple.com » soit envoyé. Si le \$1 de votre shell ConfirmPreference est défini sur « Moyen » ou inférieur, l'applet de commande vous demandera une confirmation avant de continuer. Ajoutez le commutateur -Force pour supprimer les invites de confirmation.**
```
$params = @{
CertificateArn="arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
Domain="www.example.com"
ValidationDomain="example.com"
}
Send-ACMValidationEmail @params
```
+ Pour plus de détails sur l'API, reportez-vous [ResendValidationEmail](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : demande que l’e-mail de validation de la propriété du domaine pour « www.exemple.com » soit envoyé. Si le \$1 de votre shell ConfirmPreference est défini sur « Moyen » ou inférieur, l'applet de commande vous demandera une confirmation avant de continuer. Ajoutez le commutateur -Force pour supprimer les invites de confirmation.**
```
$params = @{
CertificateArn="arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
Domain="www.example.com"
ValidationDomain="example.com"
}
Send-ACMValidationEmail @params
```
+ Pour plus de détails sur l'API, reportez-vous [ResendValidationEmail](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/acm#code-examples).
```
class AcmCertificate:
"""
Encapsulates ACM functions.
"""
def __init__(self, acm_client):
"""
:param acm_client: A Boto3 ACM client.
"""
self.acm_client = acm_client
def resend_validation_email(self, certificate_arn, domain, validation_domain):
"""
Request that validation email is sent again, for a certificate that was
previously requested with email validation.
:param certificate_arn: The ARN of the certificate.
:param domain: The primary domain of the certificate.
:param validation_domain: Alternate domain to use for determining email
addresses to use for validation.
"""
try:
self.acm_client.resend_validation_email(
CertificateArn=certificate_arn,
Domain=domain,
ValidationDomain=validation_domain,
)
logger.info(
"Validation email resent to validation domain %s.", validation_domain
)
except ClientError:
logger.exception(
"Couldn't resend validation email to %s.", validation_domain
)
raise
```
+ Pour plus de détails sur l'API, consultez [ResendValidationEmail](https://docs.aws.amazon.com/goto/boto3/acm-2015-12-08/ResendValidationEmail)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/acm#code-examples).
```
TRY.
" iv_certificate_arn = 'arn:aws:acm:region:123456789012:certificate/certificate-id'
" iv_domain = 'example.com'
" iv_validation_domain = 'example.com'
lo_acm->resendvalidationemail(
iv_certificatearn = iv_certificate_arn
iv_domain = iv_domain
iv_validationdomain = iv_validation_domain
).
MESSAGE 'Validation email resent successfully.' TYPE 'I'.
CATCH /aws1/cx_acminvalidarnex.
MESSAGE 'The certificate ARN is not valid.' TYPE 'I'.
CATCH /aws1/cx_acmresourcenotfoundex.
MESSAGE 'Certificate not found.' TYPE 'I'.
CATCH /aws1/cx_acminvalidstateex.
MESSAGE 'Certificate is not in a valid state.' TYPE 'I'.
CATCH /aws1/cx_acminvdomvationoptsex.
MESSAGE 'Invalid domain validation options.' TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [ResendValidationEmail](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `UpdateCertificateOptions` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `UpdateCertificateOptions`.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/acm#code-examples).
```
//! Update an AWS Certificate Manager (ACM) certificate option.
/*!
\param certificateArn: The Amazon Resource Name (ARN) of a certificate.
\param loggingEnabled: Boolean specifying logging enabled.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::ACM::updateCertificateOption(const Aws::String &certificateArn,
bool loggingEnabled,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::ACM::ACMClient acmClient(clientConfiguration);
Aws::ACM::Model::UpdateCertificateOptionsRequest request;
request.SetCertificateArn(certificateArn);
Aws::ACM::Model::CertificateOptions options;
if (loggingEnabled) {
options.SetCertificateTransparencyLoggingPreference(
Aws::ACM::Model::CertificateTransparencyLoggingPreference::ENABLED);
}
else {
options.SetCertificateTransparencyLoggingPreference(
Aws::ACM::Model::CertificateTransparencyLoggingPreference::DISABLED);
}
request.SetOptions(options);
Aws::ACM::Model::UpdateCertificateOptionsOutcome outcome =
acmClient.UpdateCertificateOptions(request);
if (!outcome.IsSuccess()) {
std::cerr << "UpdateCertificateOption error: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
else {
std::cout << "Success: The option '"
<< (loggingEnabled ? "enabled" : "disabled") << "' has been set for "
"the certificate with the ARN '"
<< certificateArn << "'."
<< std::endl;
return true;
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [UpdateCertificateOptions](https://docs.aws.amazon.com/goto/SdkForCpp/acm-2015-12-08/UpdateCertificateOptions)à la section *Référence des AWS SDK pour C\$1\$1 API*.
------
#### [ CLI ]
**AWS CLI**
**Pour mettre à jour les options de certificat**
La commande `update-certificate-options` suivante permet de désactiver la journalisation de transparence des certificats :
```
aws acm update-certificate-options --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --options CertificateTransparencyLoggingPreference=DISABLED
```
+ Pour plus de détails sur l'API, voir [UpdateCertificateOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/update-certificate-options.html)la section *Référence des AWS CLI commandes*.
------
# Exemples de code pour API Gateway utilisant AWS SDKs
Les exemples de code suivants vous montrent comment utiliser Amazon API Gateway avec un kit de développement AWS logiciel (SDK).
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Les *scénarios* sont des exemples de code qui vous montrent comment accomplir des tâches spécifiques en appelant plusieurs fonctions au sein d’un même service ou combinés à d’autres Services AWS.
AWS les *contributions communautaires* sont des exemples qui ont été créés et sont maintenus par plusieurs équipes AWS. Pour faire un commentaire, utilisez le mécanisme fourni dans les référentiels liés.
**Ressources supplémentaires**
+ **[Guide du développeur API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)** : plus d’informations sur API Gateway.
+ **[Référence des API d’API Gateway](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html)** : détails sur toutes les actions API Gateway disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23api-gateway)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](api-gateway_code_examples_basics.md)
+ [Actions](api-gateway_code_examples_actions.md)
+ [`CreateDeployment`](api-gateway_example_api-gateway_CreateDeployment_section.md)
+ [`CreateResource`](api-gateway_example_api-gateway_CreateResource_section.md)
+ [`CreateRestApi`](api-gateway_example_api-gateway_CreateRestApi_section.md)
+ [`DeleteDeployment`](api-gateway_example_api-gateway_DeleteDeployment_section.md)
+ [`DeleteRestApi`](api-gateway_example_api-gateway_DeleteRestApi_section.md)
+ [`GetBasePathMapping`](api-gateway_example_api-gateway_GetBasePathMapping_section.md)
+ [`GetResources`](api-gateway_example_api-gateway_GetResources_section.md)
+ [`GetRestApis`](api-gateway_example_api-gateway_GetRestApis_section.md)
+ [`ListBasePathMappings`](api-gateway_example_api-gateway_ListBasePathMappings_section.md)
+ [`PutIntegration`](api-gateway_example_api-gateway_PutIntegration_section.md)
+ [`PutIntegrationResponse`](api-gateway_example_api-gateway_PutIntegrationResponse_section.md)
+ [`PutMethod`](api-gateway_example_api-gateway_PutMethod_section.md)
+ [`PutMethodResponse`](api-gateway_example_api-gateway_PutMethodResponse_section.md)
+ [`UpdateBasePathMapping`](api-gateway_example_api-gateway_UpdateBasePathMapping_section.md)
+ [Scénarios](api-gateway_code_examples_scenarios.md)
+ [Créer une API REST pour suivre les données de la COVID-19](api-gateway_example_cross_ApiGatewayDataTracker_section.md)
+ [Créer une API REST de bibliothèque de prêt](api-gateway_example_cross_AuroraRestLendingLibrary_section.md)
+ [Création d’une application sans serveur pour gérer des photos](api-gateway_example_cross_PAM_section.md)
+ [Créer une application de chat WebSocket](api-gateway_example_cross_ApiGatewayWebsocketChat_section.md)
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
+ [Utiliser API Gateway pour invoquer une fonction Lambda](api-gateway_example_cross_LambdaAPIGateway_section.md)
+ [AWS contributions communautaires](api-gateway_code_examples_aws_community_contributions.md)
+ [Création et test d’une application sans serveur](api-gateway_example_tributary-lite_serverless-application_section.md)
# Exemples de base pour l'utilisation d'API Gateway AWS SDKs
Les exemples de code suivants montrent comment utiliser les bases d'Amazon API Gateway avec AWS SDKs.
**Contents**
+ [Actions](api-gateway_code_examples_actions.md)
+ [`CreateDeployment`](api-gateway_example_api-gateway_CreateDeployment_section.md)
+ [`CreateResource`](api-gateway_example_api-gateway_CreateResource_section.md)
+ [`CreateRestApi`](api-gateway_example_api-gateway_CreateRestApi_section.md)
+ [`DeleteDeployment`](api-gateway_example_api-gateway_DeleteDeployment_section.md)
+ [`DeleteRestApi`](api-gateway_example_api-gateway_DeleteRestApi_section.md)
+ [`GetBasePathMapping`](api-gateway_example_api-gateway_GetBasePathMapping_section.md)
+ [`GetResources`](api-gateway_example_api-gateway_GetResources_section.md)
+ [`GetRestApis`](api-gateway_example_api-gateway_GetRestApis_section.md)
+ [`ListBasePathMappings`](api-gateway_example_api-gateway_ListBasePathMappings_section.md)
+ [`PutIntegration`](api-gateway_example_api-gateway_PutIntegration_section.md)
+ [`PutIntegrationResponse`](api-gateway_example_api-gateway_PutIntegrationResponse_section.md)
+ [`PutMethod`](api-gateway_example_api-gateway_PutMethod_section.md)
+ [`PutMethodResponse`](api-gateway_example_api-gateway_PutMethodResponse_section.md)
+ [`UpdateBasePathMapping`](api-gateway_example_api-gateway_UpdateBasePathMapping_section.md)
# Actions pour API Gateway utilisant AWS SDKs
Les exemples de code suivants montrent comment effectuer des actions API Gateway individuelles avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Ces extraits appellent l’API API Gateway et sont des extraits de code de programmes plus volumineux qui doivent être exécutés en contexte. Vous pouvez voir les actions dans leur contexte dans [Scénarios d'utilisation d'API Gateway AWS SDKs](api-gateway_code_examples_scenarios.md).
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez la [Référence des API Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html).
**Topics**
+ [`CreateDeployment`](api-gateway_example_api-gateway_CreateDeployment_section.md)
+ [`CreateResource`](api-gateway_example_api-gateway_CreateResource_section.md)
+ [`CreateRestApi`](api-gateway_example_api-gateway_CreateRestApi_section.md)
+ [`DeleteDeployment`](api-gateway_example_api-gateway_DeleteDeployment_section.md)
+ [`DeleteRestApi`](api-gateway_example_api-gateway_DeleteRestApi_section.md)
+ [`GetBasePathMapping`](api-gateway_example_api-gateway_GetBasePathMapping_section.md)
+ [`GetResources`](api-gateway_example_api-gateway_GetResources_section.md)
+ [`GetRestApis`](api-gateway_example_api-gateway_GetRestApis_section.md)
+ [`ListBasePathMappings`](api-gateway_example_api-gateway_ListBasePathMappings_section.md)
+ [`PutIntegration`](api-gateway_example_api-gateway_PutIntegration_section.md)
+ [`PutIntegrationResponse`](api-gateway_example_api-gateway_PutIntegrationResponse_section.md)
+ [`PutMethod`](api-gateway_example_api-gateway_PutMethod_section.md)
+ [`PutMethodResponse`](api-gateway_example_api-gateway_PutMethodResponse_section.md)
+ [`UpdateBasePathMapping`](api-gateway_example_api-gateway_UpdateBasePathMapping_section.md)
# Utilisation `CreateDeployment` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `CreateDeployment`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour déployer les ressources configurées pour une API vers une nouvelle étape**
Commande :
```
aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage'
```
**Pour déployer les ressources configurées pour une API vers une étape existante**
Commande :
```
aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage'
```
**Pour déployer les ressources configurées pour une API vers une étape existante avec les variables d’étape**
aws apigateway create-deployment -- rest-api-id 1234123412 --stage-name dev --description 'Troisième déploiement vers la phase de développement' --variables key='value', otherKey='othervalue'
+ Pour plus de détails sur l'API, voir [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-deployment.html)la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples).
```
public static String createNewDeployment(ApiGatewayClient apiGateway, String restApiId, String stageName) {
try {
CreateDeploymentRequest request = CreateDeploymentRequest.builder()
.restApiId(restApiId)
.description("Created using the AWS API Gateway Java API")
.stageName(stageName)
.build();
CreateDeploymentResponse response = apiGateway.createDeployment(request);
System.out.println("The id of the deployment is " + response.id());
return response.id();
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
```
+ Pour plus de détails sur l'API, reportez-vous [CreateDeployment](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDeployment)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def deploy_api(self, stage_name):
"""
Deploys a REST API. After a REST API is deployed, it can be called from any
REST client, such as the Python Requests package or Postman.
:param stage_name: The stage of the API to deploy, such as 'test'.
:return: The base URL of the deployed REST API.
"""
try:
self.apig_client.create_deployment(
restApiId=self.api_id, stageName=stage_name
)
self.stage = stage_name
logger.info("Deployed stage %s.", stage_name)
except ClientError:
logger.exception("Couldn't deploy stage %s.", stage_name)
raise
else:
return self.api_url()
def api_url(self, resource=None):
"""
Builds the REST API URL from its parts.
:param resource: The resource path to append to the base URL.
:return: The REST URL to the specified resource.
"""
url = (
f"https://{self.api_id}.execute-api.{self.apig_client.meta.region_name}"
f".amazonaws.com/{self.stage}"
)
if resource is not None:
url = f"{url}/{resource}"
return url
```
+ Pour plus de détails sur l'API, consultez [CreateDeployment](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDeployment)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->createdeployment(
iv_restapiid = iv_rest_api_id
iv_stagename = iv_stage_name
iv_description = 'Deployment created by ABAP SDK' ).
DATA(lv_deployment_id) = oo_result->get_id( ).
MESSAGE 'Deployment created with ID: ' && lv_deployment_id TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [CreateDeployment](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `CreateResource` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `CreateResource`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour créer une ressource dans une API**
Commande :
```
aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource'
```
+ Pour plus de détails sur l'API, voir [CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-resource.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_rest_resource(self, parent_id, resource_path):
"""
Adds a resource to a REST API.
:param parent_id: The ID of the parent resource.
:param resource_path: The path of the new resource, relative to the parent.
:return: The ID of the new resource.
"""
try:
result = self.apig_client.create_resource(
restApiId=self.api_id, parentId=parent_id, pathPart=resource_path
)
resource_id = result["id"]
logger.info("Created resource %s.", resource_path)
except ClientError:
logger.exception("Couldn't create resource %s.", resource_path)
raise
else:
return resource_id
```
+ Pour plus de détails sur l'API, consultez [CreateResource](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateResource)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->createresource(
iv_restapiid = iv_rest_api_id
iv_parentid = iv_parent_id
iv_pathpart = iv_resource_path ).
DATA(lv_resource_id) = oo_result->get_id( ).
MESSAGE 'Resource created with ID: ' && lv_resource_id TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [CreateResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `CreateRestApi` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `CreateRestApi`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour créer une API**
Commande :
```
aws apigateway create-rest-api --name 'My First API' --description 'This is my first API'
```
**Pour créer une API dupliquée à partir d’une API existante**
Commande :
```
aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412
```
+ Pour plus de détails sur l'API, voir [CreateRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-rest-api.html)la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples).
```
public static String createAPI(ApiGatewayClient apiGateway, String restApiId, String restApiName) {
try {
CreateRestApiRequest request = CreateRestApiRequest.builder()
.cloneFrom(restApiId)
.description("Created using the Gateway Java API")
.name(restApiName)
.build();
CreateRestApiResponse response = apiGateway.createRestApi(request);
System.out.println("The id of the new api is " + response.id());
return response.id();
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
```
+ Pour plus de détails sur l'API, reportez-vous [CreateRestApi](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateRestApi)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def create_rest_api(self, api_name):
"""
Creates a REST API on API Gateway. The default API has only a root resource
and no HTTP methods.
:param api_name: The name of the API. This descriptive name is not used in
the API path.
:return: The ID of the newly created API.
"""
try:
result = self.apig_client.create_rest_api(name=api_name)
self.api_id = result["id"]
logger.info("Created REST API %s with ID %s.", api_name, self.api_id)
except ClientError:
logger.exception("Couldn't create REST API %s.", api_name)
raise
try:
result = self.apig_client.get_resources(restApiId=self.api_id)
self.root_id = next(
item for item in result["items"] if item["path"] == "/"
)["id"]
except ClientError:
logger.exception("Couldn't get resources for API %s.", self.api_id)
raise
except StopIteration as err:
logger.exception("No root resource found in API %s.", self.api_id)
raise ValueError from err
return self.api_id
```
+ Pour plus de détails sur l'API, consultez [CreateRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateRestApi)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->createrestapi(
iv_name = iv_api_name
iv_description = 'Sample REST API created by ABAP SDK' ).
DATA(lv_api_id) = oo_result->get_id( ).
MESSAGE 'REST API created with ID: ' && lv_api_id TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
CATCH /aws1/cx_agwunauthorizedex INTO DATA(lo_unauthorized).
MESSAGE lo_unauthorized->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_unauthorized.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [CreateRestApi](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `DeleteDeployment` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteDeployment`.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer un déploiement dans une API**
Commande :
```
aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3
```
+ Pour plus de détails sur l'API, voir [DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-deployment.html)la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples).
```
public static void deleteSpecificDeployment(ApiGatewayClient apiGateway, String restApiId, String deploymentId) {
try {
DeleteDeploymentRequest request = DeleteDeploymentRequest.builder()
.restApiId(restApiId)
.deploymentId(deploymentId)
.build();
apiGateway.deleteDeployment(request);
System.out.println("Deployment was deleted");
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteDeployment](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDeployment)à la section *Référence des AWS SDK for Java 2.x API*.
------
# Utilisation `DeleteRestApi` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteRestApi`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer une API**
Commande :
```
aws apigateway delete-rest-api --rest-api-id 1234123412
```
+ Pour plus de détails sur l'API, voir [DeleteRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-rest-api.html)la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples).
```
public static void deleteAPI(ApiGatewayClient apiGateway, String restApiId) {
try {
DeleteRestApiRequest request = DeleteRestApiRequest.builder()
.restApiId(restApiId)
.build();
apiGateway.deleteRestApi(request);
System.out.println("The API was successfully deleted");
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteRestApi](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteRestApi)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def delete_rest_api(self):
"""
Deletes a REST API, including all of its resources and configuration.
"""
try:
self.apig_client.delete_rest_api(restApiId=self.api_id)
logger.info("Deleted REST API %s.", self.api_id)
self.api_id = None
except ClientError:
logger.exception("Couldn't delete REST API %s.", self.api_id)
raise
```
+ Pour plus de détails sur l'API, consultez [DeleteRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteRestApi)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
lo_agw->deleterestapi(
iv_restapiid = iv_rest_api_id ).
MESSAGE 'REST API deleted successfully' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteRestApi](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `GetBasePathMapping` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `GetBasePathMapping`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir le mappage du chemin de base pour un nom de domaine personnalisé**
Commande :
```
aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1
```
Sortie :
```
{
"basePath": "v1",
"restApiId": "1234w4321e",
"stage": "api"
}
```
+ Pour plus de détails sur l'API, voir [GetBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-base-path-mapping.html)la section *Référence des AWS CLI commandes*.
------
#### [ PHP ]
**Kit SDK pour PHP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/apigateway#code-examples).
```
require 'vendor/autoload.php';
use Aws\ApiGateway\ApiGatewayClient;
use Aws\Exception\AwsException;
/* ////////////////////////////////////////////////////////////////////////////
* Purpose: Gets the base path mapping for a custom domain name in
* Amazon API Gateway.
*
* Prerequisites: A custom domain name in API Gateway. For more information,
* see "Custom Domain Names" in the Amazon API Gateway Developer Guide.
*
* Inputs:
* - $apiGatewayClient: An initialized AWS SDK for PHP API client for
* API Gateway.
* - $basePath: The base path name that callers must provide as part of the
* URL after the domain name.
* - $domainName: The custom domain name for the base path mapping.
*
* Returns: The base path mapping, if available; otherwise, the error message.
* ///////////////////////////////////////////////////////////////////////// */
function getBasePathMapping($apiGatewayClient, $basePath, $domainName)
{
try {
$result = $apiGatewayClient->getBasePathMapping([
'basePath' => $basePath,
'domainName' => $domainName,
]);
return 'The base path mapping\'s effective URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e['message'];
}
}
function getsTheBasePathMapping()
{
$apiGatewayClient = new ApiGatewayClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2015-07-09'
]);
echo getBasePathMapping($apiGatewayClient, '(none)', 'example.com');
}
// Uncomment the following line to run this code in an AWS account.
// getsTheBasePathMapping();
```
+ Pour plus de détails sur l'API, reportez-vous [GetBasePathMapping](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetBasePathMapping)à la section *Référence des AWS SDK pour PHP API*.
------
# Utilisation `GetResources` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `GetResources`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir une liste de ressources pour une API REST**
Commande :
```
aws apigateway get-resources --rest-api-id 1234123412
```
Sortie :
```
{
"items": [
{
"path": "/resource/subresource",
"resourceMethods": {
"POST": {}
},
"id": "024ace",
"pathPart": "subresource",
"parentId": "ai5b02"
}
]
}
```
+ Pour plus de détails sur l'API, voir [GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-resources.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def create_rest_api(self, api_name):
"""
Creates a REST API on API Gateway. The default API has only a root resource
and no HTTP methods.
:param api_name: The name of the API. This descriptive name is not used in
the API path.
:return: The ID of the newly created API.
"""
try:
result = self.apig_client.create_rest_api(name=api_name)
self.api_id = result["id"]
logger.info("Created REST API %s with ID %s.", api_name, self.api_id)
except ClientError:
logger.exception("Couldn't create REST API %s.", api_name)
raise
try:
result = self.apig_client.get_resources(restApiId=self.api_id)
self.root_id = next(
item for item in result["items"] if item["path"] == "/"
)["id"]
except ClientError:
logger.exception("Couldn't get resources for API %s.", self.api_id)
raise
except StopIteration as err:
logger.exception("No root resource found in API %s.", self.api_id)
raise ValueError from err
return self.api_id
```
+ Pour plus de détails sur l'API, consultez [GetResources](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetResources)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->getresources(
iv_restapiid = iv_rest_api_id ).
DATA(lt_resources) = oo_result->get_items( ).
DATA(lv_count) = lines( lt_resources ).
MESSAGE 'Found ' && lv_count && ' resources' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [GetResources](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `GetRestApis` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `GetRestApis`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir une liste de REST APIs**
Commande :
```
aws apigateway get-rest-apis
```
Sortie :
```
{
"items": [
{
"createdDate": 1438884790,
"id": "12s44z21rb",
"name": "My First API"
}
]
}
```
+ Pour plus de détails sur l'API, voir [GetRestApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-rest-apis.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def get_rest_api_id(self, api_name):
"""
Gets the ID of a REST API from its name by searching the list of REST APIs
for the current account. Because names need not be unique, this returns only
the first API with the specified name.
:param api_name: The name of the API to look up.
:return: The ID of the specified API.
"""
try:
rest_api = None
paginator = self.apig_client.get_paginator("get_rest_apis")
for page in paginator.paginate():
rest_api = next(
(item for item in page["items"] if item["name"] == api_name), None
)
if rest_api is not None:
break
self.api_id = rest_api["id"]
logger.info("Found ID %s for API %s.", rest_api["id"], api_name)
except ClientError:
logger.exception("Couldn't find ID for API %s.", api_name)
raise
else:
return rest_api["id"]
```
+ Pour plus de détails sur l'API, consultez [GetRestApis](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRestApis)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/apigateway#code-examples).
Affiche le REST Amazon API Gateway APIs dans la région.
```
async fn show_apis(client: &Client) -> Result<(), Error> {
let resp = client.get_rest_apis().send().await?;
for api in resp.items() {
println!("ID: {}", api.id().unwrap_or_default());
println!("Name: {}", api.name().unwrap_or_default());
println!("Description: {}", api.description().unwrap_or_default());
println!("Version: {}", api.version().unwrap_or_default());
println!(
"Created: {}",
api.created_date().unwrap().to_chrono_utc()?
);
println!();
}
Ok(())
}
```
+ Pour plus de détails sur l'API, voir [GetRestApis](https://docs.rs/aws-sdk-apigateway/latest/aws_sdk_apigateway/client/struct.Client.html#method.get_rest_apis)la section de *référence de l'API AWS SDK for Rust*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->getrestapis( ).
DATA(lt_apis) = oo_result->get_items( ).
DATA(lv_count) = lines( lt_apis ).
MESSAGE 'Found ' && lv_count && ' REST APIs' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [GetRestApis](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `ListBasePathMappings` avec un AWS SDK
L'exemple de code suivant montre comment utiliser`ListBasePathMappings`.
------
#### [ PHP ]
**Kit SDK pour PHP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/apigateway#code-examples).
```
require 'vendor/autoload.php';
use Aws\ApiGateway\ApiGatewayClient;
use Aws\Exception\AwsException;
/* ////////////////////////////////////////////////////////////////////////////
* Purpose: Lists the base path mapping for a custom domain name in
* Amazon API Gateway.
*
* Prerequisites: A custom domain name in API Gateway. For more information,
* see "Custom Domain Names" in the Amazon API Gateway Developer Guide.
*
* Inputs:
* - $apiGatewayClient: An initialized AWS SDK for PHP API client for
* API Gateway.
* - $domainName: The custom domain name for the base path mappings.
*
* Returns: Information about the base path mappings, if available;
* otherwise, the error message.
* ///////////////////////////////////////////////////////////////////////// */
function listBasePathMappings($apiGatewayClient, $domainName)
{
try {
$result = $apiGatewayClient->getBasePathMappings([
'domainName' => $domainName
]);
return 'The base path mapping(s) effective URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e['message'];
}
}
function listTheBasePathMappings()
{
$apiGatewayClient = new ApiGatewayClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2015-07-09'
]);
echo listBasePathMappings($apiGatewayClient, 'example.com');
}
// Uncomment the following line to run this code in an AWS account.
// listTheBasePathMappings();
```
+ Pour plus de détails sur l'API, reportez-vous [ListBasePathMappings](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/ListBasePathMappings)à la section *Référence des AWS SDK pour PHP API*.
------
# Utilisation `PutIntegration` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `PutIntegration`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour créer une demande d’intégration MOCK**
Commande :
```
aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }'
```
**Pour créer une demande d’intégration HTTP**
Commande :
```
aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path'
```
**Pour créer une demande d' AWS intégration avec un point de terminaison de fonction Lambda**
Commande :
```
aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations'
```
+ Pour plus de détails sur l'API, voir [PutIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ Pour plus de détails sur l'API, consultez [PutIntegration](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegration)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->putintegration(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_type = 'AWS_PROXY'
iv_integrationhttpmethod = 'POST'
iv_uri = iv_integration_uri ).
MESSAGE 'Integration configured for method' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [PutIntegration](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `PutIntegrationResponse` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `PutIntegrationResponse`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour créer une réponse d’intégration comme réponse par défaut avec un modèle de mappage défini**
Commande :
```
aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}'
```
**Pour créer une réponse d’intégration avec une expression régulière de 400 et une valeur d’en-tête définie statiquement**
Commande :
```
aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}'
```
+ Pour plus de détails sur l'API, voir [PutIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration-response.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ Pour plus de détails sur l'API, consultez [PutIntegrationResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegrationResponse)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->putintegrationresponse(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_statuscode = '200' ).
MESSAGE 'Integration response configured for status 200' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [PutIntegrationResponse](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `PutMethod` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `PutMethod`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour créer une méthode pour une ressource dans une API sans autorisation, sans clé d’API et avec un en-tête de demande de méthode personnalisé**
Commande :
```
aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false"
```
+ Pour plus de détails sur l'API, voir [PutMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ Pour plus de détails sur l'API, consultez [PutMethod](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethod)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->putmethod(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_authorizationtype = 'NONE' ).
MESSAGE 'Method ' && iv_http_method && ' added to resource' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [PutMethod](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `PutMethodResponse` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `PutMethodResponse`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**Pour créer une réponse de méthode sous le code d’état spécifié avec un en-tête de réponse de méthode personnalisé**
Commande :
```
aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false"
```
+ Pour plus de détails sur l'API, voir [PutMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method-response.html)la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ Pour plus de détails sur l'API, consultez [PutMethodResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethodResponse)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples).
```
TRY.
oo_result = lo_agw->putmethodresponse(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_statuscode = '200' ).
MESSAGE 'Method response configured for status 200' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ Pour plus de détails sur l'API, reportez-vous [PutMethodResponse](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `UpdateBasePathMapping` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `UpdateBasePathMapping`.
------
#### [ CLI ]
**AWS CLI**
**Pour modifier le chemin de base d’un nom de domaine personnalisé**
Commande :
```
aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1'
```
Sortie :
```
{
"basePath": "v1",
"restApiId": "1234123412",
"stage": "api"
}
```
+ Pour plus de détails sur l'API, voir [UpdateBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-base-path-mapping.html)la section *Référence des AWS CLI commandes*.
------
#### [ PHP ]
**Kit SDK pour PHP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/apigateway#code-examples).
```
require 'vendor/autoload.php';
use Aws\ApiGateway\ApiGatewayClient;
use Aws\Exception\AwsException;
/* ////////////////////////////////////////////////////////////////////////////
*
* Purpose: Updates the base path mapping for a custom domain name
* in Amazon API Gateway.
*
* Inputs:
* - $apiGatewayClient: An initialized AWS SDK for PHP API client for
* API Gateway.
* - $basePath: The base path name that callers must provide as part of the
* URL after the domain name.
* - $domainName: The custom domain name for the base path mapping.
* - $patchOperations: The base path update operations to apply.
*
* Returns: Information about the updated base path mapping, if available;
* otherwise, the error message.
* ///////////////////////////////////////////////////////////////////////// */
function updateBasePathMapping(
$apiGatewayClient,
$basePath,
$domainName,
$patchOperations
) {
try {
$result = $apiGatewayClient->updateBasePathMapping([
'basePath' => $basePath,
'domainName' => $domainName,
'patchOperations' => $patchOperations
]);
return 'The updated base path\'s URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e['message'];
}
}
function updateTheBasePathMapping()
{
$patchOperations = array([
'op' => 'replace',
'path' => '/stage',
'value' => 'stage2'
]);
$apiGatewayClient = new ApiGatewayClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2015-07-09'
]);
echo updateBasePathMapping(
$apiGatewayClient,
'(none)',
'example.com',
$patchOperations
);
}
// Uncomment the following line to run this code in an AWS account.
// updateTheBasePathMapping();
```
+ Pour plus de détails sur l'API, reportez-vous [UpdateBasePathMapping](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateBasePathMapping)à la section *Référence des AWS SDK pour PHP API*.
------
# Scénarios d'utilisation d'API Gateway AWS SDKs
Les exemples de code suivants vous montrent comment implémenter des scénarios courants dans API Gateway avec AWS SDKs. Ces scénarios vous montrent comment accomplir des tâches spécifiques en appelant plusieurs fonctions dans API Gateway ou en les combinant avec d’autres Services AWS. Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code.
Les scénarios ciblent un niveau d’expérience intermédiaire pour vous aider à comprendre les actions de service dans leur contexte.
**Topics**
+ [Créer une API REST pour suivre les données de la COVID-19](api-gateway_example_cross_ApiGatewayDataTracker_section.md)
+ [Créer une API REST de bibliothèque de prêt](api-gateway_example_cross_AuroraRestLendingLibrary_section.md)
+ [Création d’une application sans serveur pour gérer des photos](api-gateway_example_cross_PAM_section.md)
+ [Créer une application de chat WebSocket](api-gateway_example_cross_ApiGatewayWebsocketChat_section.md)
+ [Création et déploiement d’une API REST](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
+ [Utiliser API Gateway pour invoquer une fonction Lambda](api-gateway_example_cross_LambdaAPIGateway_section.md)
# Créer une API REST API Gateway pour suivre les données de la COVID-19
L’exemple de code suivant montre comment créer une API REST qui simule un système pour suivre les cas quotidiens de COVID-19 aux États-Unis, à l’aide de données fictives.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Montre comment utiliser AWS Chalice avec le AWS SDK pour Python (Boto3) pour créer une API REST sans serveur qui utilise Amazon API Gateway et Amazon DynamoDB. AWS Lambda L’API REST simule un système qui suit les cas quotidiens de COVID-19 aux États-Unis à l’aide de données fictives. Découvrez comment :
+ Utilisez AWS Chalice pour définir des routes dans les fonctions Lambda appelées pour gérer les requêtes REST qui passent par API Gateway.
+ Utilisez les fonctions Lambda pour récupérer et stocker des données dans une table DynamoDB afin de répondre aux demandes REST.
+ Définissez la structure des tables et les ressources des rôles de sécurité dans un AWS CloudFormation modèle.
+ Utilisez AWS Chalice CloudFormation pour empaqueter et déployer toutes les ressources nécessaires.
+ CloudFormation À utiliser pour nettoyer toutes les ressources créées.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/apigateway_covid-19_tracker).
**Les services utilisés dans cet exemple**
+ API Gateway
+ CloudFormation
+ DynamoDB
+ Lambda
------
# Créer une API REST de bibliothèque de prêt
L’exemple de code suivant montre comment créer une bibliothèque de prêt dans laquelle les clients peuvent emprunter et retourner des livres à l’aide d’une API REST soutenue par une base de données Amazon Aurora.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Montre comment utiliser l' AWS SDK pour Python (Boto3) API Amazon Relational Database Service (Amazon RDS) et AWS Chalice pour créer une API REST soutenue par une base de données Amazon Aurora. Le service Web est entièrement sans serveur et représente une bibliothèque de prêt simple où les clients peuvent emprunter et retourner des livres. Découvrez comment :
+ Créer et gérer un cluster de bases de données Aurora sans serveur.
+ AWS Secrets Manager À utiliser pour gérer les informations d'identification de base de données.
+ Implémenter une couche de stockage de données qui utilise Amazon RDS pour déplacer des données vers et hors de la base de données.
+ Utilisez AWS Chalice pour déployer une API REST sans serveur sur Amazon API Gateway et. AWS Lambda
+ Utiliser le package Requests (Requêtes) pour envoyer des requêtes au service web.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/aurora_rest_lending_library).
**Les services utilisés dans cet exemple**
+ API Gateway
+ Aurora
+ Lambda
+ Secrets Manager
------
# Création d’une application de gestion des ressources photographiques permettant aux utilisateurs de gérer les photos à l’aide d’étiquettes
Les exemples de code suivants montrent comment créer une application sans serveur permettant aux utilisateurs de gérer des photos à l’aide d’étiquettes.
------
#### [ .NET ]
**SDK pour .NET**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/PhotoAssetManager).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/cross-service/photo_asset_manager).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ Java ]
**SDK pour Java 2.x**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/pam_source_files).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ JavaScript ]
**SDK pour JavaScript (v3)**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/photo-asset-manager).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ Kotlin ]
**SDK pour Kotlin**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/usecases/creating_pam).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ PHP ]
**Kit SDK pour PHP**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/applications/photo_asset_manager).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ Rust ]
**SDK pour Rust**
Montre comment développer une application de gestion de ressources photographiques qui détecte les étiquettes dans les images à l’aide d’Amazon Rekognition et les stocke pour les récupérer ultérieurement.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/cross_service/photo_asset_management).
Pour explorer en profondeur l’origine de cet exemple, consultez l’article sur [AWS Community](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
# Créer une application de chat Websocket avec API Gateway
L’exemple de code suivant montre comment créer une application de chat desservie par une API Websocket basée sur Amazon API Gateway.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Montre comment utiliser Amazon API Gateway V2 pour créer une API Websocket qui s'intègre à Amazon AWS Lambda DynamoDB. AWS SDK pour Python (Boto3)
+ Créez une API WebSocket dans API Gateway.
+ Définissez un gestionnaire Lambda qui stocke les connexions dans DynamoDB et publie des messages pour d’autres participants au chat.
+ Connectez-vous à l’application de chat Websocket et envoyez des messages avec le package Websockets.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/apigateway_websocket_chat).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
------
# Création et déploiement d'une API REST à l'aide d'un AWS SDK
L’exemple de code suivant illustre comment :
+ créer une API REST dans API Gateway ;
+ ajouter des ressources à l’API REST pour représenter un profil utilisateur ;
+ ajouter des méthodes d’intégration afin que l’API REST utilise une table DynamoDB pour stocker les données de profil utilisateur ;
+ envoyer des requêtes HTTP à l’API REST pour ajouter et extraire des profils utilisateur.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples).
Créez une classe qui encapsule les opérations API Gateway.
```
import argparse
import json
import logging
from pprint import pprint
import boto3
from botocore.exceptions import ClientError
import requests
logger = logging.getLogger(__name__)
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def create_rest_api(self, api_name):
"""
Creates a REST API on API Gateway. The default API has only a root resource
and no HTTP methods.
:param api_name: The name of the API. This descriptive name is not used in
the API path.
:return: The ID of the newly created API.
"""
try:
result = self.apig_client.create_rest_api(name=api_name)
self.api_id = result["id"]
logger.info("Created REST API %s with ID %s.", api_name, self.api_id)
except ClientError:
logger.exception("Couldn't create REST API %s.", api_name)
raise
try:
result = self.apig_client.get_resources(restApiId=self.api_id)
self.root_id = next(
item for item in result["items"] if item["path"] == "/"
)["id"]
except ClientError:
logger.exception("Couldn't get resources for API %s.", self.api_id)
raise
except StopIteration as err:
logger.exception("No root resource found in API %s.", self.api_id)
raise ValueError from err
return self.api_id
def add_rest_resource(self, parent_id, resource_path):
"""
Adds a resource to a REST API.
:param parent_id: The ID of the parent resource.
:param resource_path: The path of the new resource, relative to the parent.
:return: The ID of the new resource.
"""
try:
result = self.apig_client.create_resource(
restApiId=self.api_id, parentId=parent_id, pathPart=resource_path
)
resource_id = result["id"]
logger.info("Created resource %s.", resource_path)
except ClientError:
logger.exception("Couldn't create resource %s.", resource_path)
raise
else:
return resource_id
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
def deploy_api(self, stage_name):
"""
Deploys a REST API. After a REST API is deployed, it can be called from any
REST client, such as the Python Requests package or Postman.
:param stage_name: The stage of the API to deploy, such as 'test'.
:return: The base URL of the deployed REST API.
"""
try:
self.apig_client.create_deployment(
restApiId=self.api_id, stageName=stage_name
)
self.stage = stage_name
logger.info("Deployed stage %s.", stage_name)
except ClientError:
logger.exception("Couldn't deploy stage %s.", stage_name)
raise
else:
return self.api_url()
def api_url(self, resource=None):
"""
Builds the REST API URL from its parts.
:param resource: The resource path to append to the base URL.
:return: The REST URL to the specified resource.
"""
url = (
f"https://{self.api_id}.execute-api.{self.apig_client.meta.region_name}"
f".amazonaws.com/{self.stage}"
)
if resource is not None:
url = f"{url}/{resource}"
return url
```
Déployez une API REST et appelez-la avec le package Requests.
```
def usage_demo(table_name, role_name, rest_api_name):
"""
Demonstrates how to used API Gateway to create and deploy a REST API, and how
to use the Requests package to call it.
:param table_name: The name of the demo DynamoDB table.
:param role_name: The name of the demo role that grants API Gateway permission to
call DynamoDB.
:param rest_api_name: The name of the demo REST API created by the demo.
"""
gateway = ApiGatewayToService(boto3.client("apigateway"))
role = boto3.resource("iam").Role(role_name)
print("Creating REST API in API Gateway.")
gateway.create_rest_api(rest_api_name)
print("Adding resources to the REST API.")
profiles_id = gateway.add_rest_resource(gateway.root_id, "profiles")
username_id = gateway.add_rest_resource(profiles_id, "{username}")
# The DynamoDB service requires that all integration requests use POST.
print("Adding integration methods to read and write profiles in Amazon DynamoDB.")
gateway.add_integration_method(
profiles_id,
"GET",
"dynamodb",
"Scan",
"POST",
role.arn,
{"TableName": table_name},
)
gateway.add_integration_method(
profiles_id,
"POST",
"dynamodb",
"PutItem",
"POST",
role.arn,
{
"TableName": table_name,
"Item": {
"username": {"S": "$input.path('$.username')"},
"name": {"S": "$input.path('$.name')"},
"title": {"S": "$input.path('$.title')"},
},
},
)
gateway.add_integration_method(
username_id,
"GET",
"dynamodb",
"GetItem",
"POST",
role.arn,
{
"TableName": table_name,
"Key": {"username": {"S": "$method.request.path.username"}},
},
)
stage = "test"
print(f"Deploying the {stage} stage.")
gateway.deploy_api(stage)
profiles_url = gateway.api_url("profiles")
print(
f"Using the Requests package to post some people to the profiles REST API at "
f"{profiles_url}."
)
requests.post(
profiles_url,
json={"username": "will", "name": "William Shakespeare", "title": "playwright"},
)
requests.post(
profiles_url,
json={
"username": "ludwig",
"name": "Ludwig van Beethoven",
"title": "composer",
},
)
requests.post(
profiles_url,
json={"username": "jane", "name": "Jane Austen", "title": "author"},
)
print("Getting the list of profiles from the REST API.")
profiles = requests.get(profiles_url).json()
pprint(profiles)
print(f"Getting just the profile for username 'jane' (URL: {profiles_url}/jane).")
jane = requests.get(f"{profiles_url}/jane").json()
pprint(jane)
```
+ Pour plus de détails sur l’API, consultez les rubriques suivantes dans la *Référence des API du kit AWS SDK for Python (Boto3)*.
+ [CreateDeployment](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDeployment)
+ [CreateResource](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateResource)
+ [CreateRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateRestApi)
+ [DeleteRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteRestApi)
+ [GetResources](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetResources)
+ [GetRestApis](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRestApis)
+ [PutIntegration](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegration)
+ [PutIntegrationResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegrationResponse)
+ [PutMethod](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethod)
+ [PutMethodResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethodResponse)
------
# Utiliser API Gateway pour appeler une fonction Lambda
Les exemples de code suivants montrent comment créer une AWS Lambda fonction invoquée par Amazon API Gateway.
------
#### [ Java ]
**SDK pour Java 2.x**
Montre comment créer une AWS Lambda fonction à l'aide de l'API d'exécution Lambda Java. Cet exemple fait appel à différents AWS services pour réaliser un cas d'utilisation spécifique. Cet exemple montre comment créer une fonction Lambda invoquée par Amazon API Gateway qui analyse une table Amazon DynamoDB à la recherche d’anniversaires professionnels et utilise Amazon Simple Notification Service (Amazon SNS) pour envoyer un message texte à vos employés qui les félicitent à leur date d’anniversaire.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/creating_lambda_apigateway).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon SNS
------
#### [ JavaScript ]
**SDK pour JavaScript (v3)**
Montre comment créer une AWS Lambda fonction à l'aide de l'API JavaScript d'exécution Lambda. Cet exemple fait appel à différents AWS services pour réaliser un cas d'utilisation spécifique. Cet exemple montre comment créer une fonction Lambda invoquée par Amazon API Gateway qui analyse une table Amazon DynamoDB à la recherche d’anniversaires professionnels et utilise Amazon Simple Notification Service (Amazon SNS) pour envoyer un message texte à vos employés qui les félicitent à leur date d’anniversaire.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/lambda-api-gateway).
Cet exemple est également disponible dans le [AWS SDK pour JavaScript guide du développeur v3](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/api-gateway-invoking-lambda-example.html).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon SNS
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Cet exemple montre comment créer et utiliser une API REST Amazon API Gateway qui cible une fonction AWS Lambda . Le gestionnaire Lambda explique comment router en fonction des méthodes HTTP, comment obtenir des données à partir de la chaîne de requête, de l’en-tête et du corps, et comment renvoyer une réponse JSON.
+ Déployer une fonction Lambda.
+ Créer une API REST avec API Gateway.
+ Créer une ressource REST qui cible la fonction Lambda.
+ Accorder à API Gateway l’autorisation d’invoquer la fonction Lambda.
+ Utiliser le package Requests (Requêtes) pour envoyer des requêtes à l’API REST.
+ Nettoyer toutes les ressources créées lors de la démonstration.
Il est préférable de visionner cet exemple sur GitHub. Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/lambda#readme).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon SNS
------
# AWS contributions de la communauté pour API Gateway
AWS les *contributions communautaires* sont des exemples qui ont été créés et sont maintenus par plusieurs équipes AWS. Pour faire un commentaire, utilisez le mécanisme fourni dans les référentiels liés.
**Topics**
+ [Création et test d’une application sans serveur](api-gateway_example_tributary-lite_serverless-application_section.md)
# Création et test d’une application sans serveur
Les exemples de code suivants montrent comment créer et tester une application sans serveur à l’aide d’API Gateway avec Lambda et DynamoDB.
------
#### [ .NET ]
**SDK pour .NET**
Illustre comment créer et tester une application sans serveur composée d’une API Gateway avec Lambda et DynamoDB à l’aide du kit SDK .NET.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/aws-samples/serverless-dotnet-demo).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
------
#### [ Go ]
**Kit SDK pour Go V2**
Illustre comment créer et tester une application sans serveur composée d’une API Gateway avec Lambda et DynamoDB à l’aide du kit SDK Go.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/aws-samples/serverless-go-demo).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
------
#### [ Java ]
**SDK pour Java 2.x**
Illustre comment créer et tester une application sans serveur composée d’une API Gateway avec Lambda et DynamoDB à l’aide du kit SDK Java.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/aws-samples/serverless-java-frameworks-samples).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
------
#### [ Rust ]
**SDK pour Rust**
Illustre comment créer et tester une application sans serveur composée d’une API Gateway avec Lambda et DynamoDB à l’aide du kit SDK Rust.
Pour obtenir le code source complet et les instructions de configuration et d'exécution, consultez l'exemple complet sur [GitHub](https://github.com/aws-samples/serverless-rust-demo).
**Les services utilisés dans cet exemple**
+ API Gateway
+ DynamoDB
+ Lambda
------
# Exemples de code pour l'API API Gateway Management utilisant AWS SDKs
Les exemples de code suivants vous montrent comment utiliser l'API Amazon API Gateway Management avec un kit de développement AWS logiciel (SDK).
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
**Ressources supplémentaires**
+ **[Guide du développeur de l’API de gestion d’API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)** : plus d’informations sur l’API de gestion d’API Gateway.
+ **[Référence des API de l’API de gestion d’API Gateway](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html)** : détails sur toutes les actions de l’API de gestion d’API Gateway disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23api-gateway)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](apigatewaymanagementapi_code_examples_basics.md)
+ [Actions](apigatewaymanagementapi_code_examples_actions.md)
+ [`PostToConnection`](apigatewaymanagementapi_example_apigatewaymanagementapi_PostToConnection_section.md)
# Exemples de base d'utilisation de l'API Gateway Management API AWS SDKs
Les exemples de code suivants montrent comment utiliser les bases de l'API Amazon API Gateway Management avec AWS SDKs.
**Contents**
+ [Actions](apigatewaymanagementapi_code_examples_actions.md)
+ [`PostToConnection`](apigatewaymanagementapi_example_apigatewaymanagementapi_PostToConnection_section.md)
# Actions pour l'API API Gateway Management utilisant AWS SDKs
Les exemples de code suivants montrent comment effectuer des actions d'API API Gateway Management individuelles avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez la [Référence des API de l’API de gestion d’Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html).
**Topics**
+ [`PostToConnection`](apigatewaymanagementapi_example_apigatewaymanagementapi_PostToConnection_section.md)
# Utilisation `PostToConnection` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `PostToConnection`.
------
#### [ CLI ]
**AWS CLI**
**Pour envoyer des données à une WebSocket connexion**
L'`post-to-connection`exemple suivant envoie un message à un client connecté à l' WebSocket API spécifiée.
```
aws apigatewaymanagementapi post-to-connection \
--connection-id L0SM9cOFvHcCIhw= \
--data "Hello from API Gateway!" \
--endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Utilisation des commandes @connections dans votre service dorsal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) dans le *Guide du développeur Amazon API Gateway*.
+ Pour plus de détails sur l'API, voir [PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html)la section *Référence des AWS CLI commandes*.
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/apigatewaymanagement#code-examples).
```
async fn send_data(
client: &aws_sdk_apigatewaymanagement::Client,
con_id: &str,
data: &str,
) -> Result<(), aws_sdk_apigatewaymanagement::Error> {
client
.post_to_connection()
.connection_id(con_id)
.data(Blob::new(data))
.send()
.await?;
Ok(())
}
let endpoint_url = format!(
"https://{api_id}.execute-api.{region}.amazonaws.com/{stage}",
api_id = api_id,
region = region,
stage = stage
);
let shared_config = aws_config::from_env().region(region_provider).load().await;
let api_management_config = config::Builder::from(&shared_config)
.endpoint_url(endpoint_url)
.build();
let client = Client::from_conf(api_management_config);
```
+ Pour plus de détails sur l'API, voir [PostToConnection](https://docs.rs/aws-sdk-apigatewaymanagementapi/latest/aws_sdk_apigatewaymanagementapi/client/struct.Client.html#method.post_to_connection)la section de *référence de l'API AWS SDK for Rust*.
------
# Exemples de code pour Application Auto Scaling à l'aide de AWS SDKs
Les exemples de code suivants vous montrent comment utiliser Application Auto Scaling avec un kit de développement AWS logiciel (SDK).
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
**Ressources supplémentaires**
+ **[Guide de l’utilisateur Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html)** : plus d’informations sur Application Auto Scaling.
+ **[Référence des API Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/APIReference/Welcome.html)** : détails sur toutes les actions Application Auto Scaling disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](application-auto-scaling_code_examples_basics.md)
+ [Actions](application-auto-scaling_code_examples_actions.md)
+ [`DeleteScalingPolicy`](application-auto-scaling_example_application-auto-scaling_DeleteScalingPolicy_section.md)
+ [`DeleteScheduledAction`](application-auto-scaling_example_application-auto-scaling_DeleteScheduledAction_section.md)
+ [`DeregisterScalableTarget`](application-auto-scaling_example_application-auto-scaling_DeregisterScalableTarget_section.md)
+ [`DescribeScalableTargets`](application-auto-scaling_example_application-auto-scaling_DescribeScalableTargets_section.md)
+ [`DescribeScalingActivities`](application-auto-scaling_example_application-auto-scaling_DescribeScalingActivities_section.md)
+ [`DescribeScalingPolicies`](application-auto-scaling_example_application-auto-scaling_DescribeScalingPolicies_section.md)
+ [`DescribeScheduledActions`](application-auto-scaling_example_application-auto-scaling_DescribeScheduledActions_section.md)
+ [`PutScalingPolicy`](application-auto-scaling_example_application-auto-scaling_PutScalingPolicy_section.md)
+ [`PutScheduledAction`](application-auto-scaling_example_application-auto-scaling_PutScheduledAction_section.md)
+ [`RegisterScalableTarget`](application-auto-scaling_example_application-auto-scaling_RegisterScalableTarget_section.md)
# Exemples de base pour l'utilisation d'Application Auto Scaling AWS SDKs
Les exemples de code suivants montrent comment utiliser les principes de base d'Application Auto Scaling avec AWS SDKs.
**Contents**
+ [Actions](application-auto-scaling_code_examples_actions.md)
+ [`DeleteScalingPolicy`](application-auto-scaling_example_application-auto-scaling_DeleteScalingPolicy_section.md)
+ [`DeleteScheduledAction`](application-auto-scaling_example_application-auto-scaling_DeleteScheduledAction_section.md)
+ [`DeregisterScalableTarget`](application-auto-scaling_example_application-auto-scaling_DeregisterScalableTarget_section.md)
+ [`DescribeScalableTargets`](application-auto-scaling_example_application-auto-scaling_DescribeScalableTargets_section.md)
+ [`DescribeScalingActivities`](application-auto-scaling_example_application-auto-scaling_DescribeScalingActivities_section.md)
+ [`DescribeScalingPolicies`](application-auto-scaling_example_application-auto-scaling_DescribeScalingPolicies_section.md)
+ [`DescribeScheduledActions`](application-auto-scaling_example_application-auto-scaling_DescribeScheduledActions_section.md)
+ [`PutScalingPolicy`](application-auto-scaling_example_application-auto-scaling_PutScalingPolicy_section.md)
+ [`PutScheduledAction`](application-auto-scaling_example_application-auto-scaling_PutScheduledAction_section.md)
+ [`RegisterScalableTarget`](application-auto-scaling_example_application-auto-scaling_RegisterScalableTarget_section.md)
# Actions pour Application Auto Scaling à l'aide de AWS SDKs
Les exemples de code suivants montrent comment effectuer des actions Application Auto Scaling individuelles avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir une liste complète, consultez la [Référence des API Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/APIReference/Welcome.html).
**Topics**
+ [`DeleteScalingPolicy`](application-auto-scaling_example_application-auto-scaling_DeleteScalingPolicy_section.md)
+ [`DeleteScheduledAction`](application-auto-scaling_example_application-auto-scaling_DeleteScheduledAction_section.md)
+ [`DeregisterScalableTarget`](application-auto-scaling_example_application-auto-scaling_DeregisterScalableTarget_section.md)
+ [`DescribeScalableTargets`](application-auto-scaling_example_application-auto-scaling_DescribeScalableTargets_section.md)
+ [`DescribeScalingActivities`](application-auto-scaling_example_application-auto-scaling_DescribeScalingActivities_section.md)
+ [`DescribeScalingPolicies`](application-auto-scaling_example_application-auto-scaling_DescribeScalingPolicies_section.md)
+ [`DescribeScheduledActions`](application-auto-scaling_example_application-auto-scaling_DescribeScheduledActions_section.md)
+ [`PutScalingPolicy`](application-auto-scaling_example_application-auto-scaling_PutScalingPolicy_section.md)
+ [`PutScheduledAction`](application-auto-scaling_example_application-auto-scaling_PutScheduledAction_section.md)
+ [`RegisterScalableTarget`](application-auto-scaling_example_application-auto-scaling_RegisterScalableTarget_section.md)
# Utilisation `DeleteScalingPolicy` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteScalingPolicy`.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer une stratégie de mise à l’échelle**
Cet exemple supprime une stratégie de mise à l’échelle pour l’application Web du service Amazon ECS exécutée dans le cluster par défaut.
Commande :
```
aws application-autoscaling delete-scaling-policy --policy-name web-app-cpu-lt-25 --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app --service-namespace ecs
```
+ Pour plus de détails sur l'API, voir [DeleteScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/delete-scaling-policy.html)la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/appautoscale#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.applicationautoscaling.ApplicationAutoScalingClient;
import software.amazon.awssdk.services.applicationautoscaling.model.ApplicationAutoScalingException;
import software.amazon.awssdk.services.applicationautoscaling.model.DeleteScalingPolicyRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.DeregisterScalableTargetRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsResponse;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesResponse;
import software.amazon.awssdk.services.applicationautoscaling.model.ScalableDimension;
import software.amazon.awssdk.services.applicationautoscaling.model.ServiceNamespace;
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class DisableDynamoDBAutoscaling {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
tableId - The table Id value (for example, table/Music).\s
policyName - The name of the policy (for example, $Music5-scaling-policy).
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
ApplicationAutoScalingClient appAutoScalingClient = ApplicationAutoScalingClient.builder()
.region(Region.US_EAST_1)
.build();
ServiceNamespace ns = ServiceNamespace.DYNAMODB;
ScalableDimension tableWCUs = ScalableDimension.DYNAMODB_TABLE_WRITE_CAPACITY_UNITS;
String tableId = args[0];
String policyName = args[1];
deletePolicy(appAutoScalingClient, policyName, tableWCUs, ns, tableId);
verifyScalingPolicies(appAutoScalingClient, tableId, ns, tableWCUs);
deregisterScalableTarget(appAutoScalingClient, tableId, ns, tableWCUs);
verifyTarget(appAutoScalingClient, tableId, ns, tableWCUs);
}
public static void deletePolicy(ApplicationAutoScalingClient appAutoScalingClient, String policyName, ScalableDimension tableWCUs, ServiceNamespace ns, String tableId) {
try {
DeleteScalingPolicyRequest delSPRequest = DeleteScalingPolicyRequest.builder()
.policyName(policyName)
.scalableDimension(tableWCUs)
.serviceNamespace(ns)
.resourceId(tableId)
.build();
appAutoScalingClient.deleteScalingPolicy(delSPRequest);
System.out.println(policyName +" was deleted successfully.");
} catch (ApplicationAutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
}
}
// Verify that the scaling policy was deleted
public static void verifyScalingPolicies(ApplicationAutoScalingClient appAutoScalingClient, String tableId, ServiceNamespace ns, ScalableDimension tableWCUs) {
DescribeScalingPoliciesRequest dscRequest = DescribeScalingPoliciesRequest.builder()
.scalableDimension(tableWCUs)
.serviceNamespace(ns)
.resourceId(tableId)
.build();
DescribeScalingPoliciesResponse response = appAutoScalingClient.describeScalingPolicies(dscRequest);
System.out.println("DescribeScalableTargets result: ");
System.out.println(response);
}
public static void deregisterScalableTarget(ApplicationAutoScalingClient appAutoScalingClient, String tableId, ServiceNamespace ns, ScalableDimension tableWCUs) {
try {
DeregisterScalableTargetRequest targetRequest = DeregisterScalableTargetRequest.builder()
.scalableDimension(tableWCUs)
.serviceNamespace(ns)
.resourceId(tableId)
.build();
appAutoScalingClient.deregisterScalableTarget(targetRequest);
System.out.println("The scalable target was deregistered.");
} catch (ApplicationAutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
}
}
public static void verifyTarget(ApplicationAutoScalingClient appAutoScalingClient, String tableId, ServiceNamespace ns, ScalableDimension tableWCUs) {
DescribeScalableTargetsRequest dscRequest = DescribeScalableTargetsRequest.builder()
.scalableDimension(tableWCUs)
.serviceNamespace(ns)
.resourceIds(tableId)
.build();
DescribeScalableTargetsResponse response = appAutoScalingClient.describeScalableTargets(dscRequest);
System.out.println("DescribeScalableTargets result: ");
System.out.println(response);
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteScalingPolicy](https://docs.aws.amazon.com/goto/SdkForJavaV2/application-autoscaling-2016-02-06/DeleteScalingPolicy)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande supprime la stratégie de mise à l’échelle spécifiée pour une cible évolutive Application Auto Scaling.**
```
Remove-AASScalingPolicy -ServiceNamespace AppStream -PolicyName "default-scale-out" -ResourceId fleet/Test -ScalableDimension appstream:fleet:DesiredCapacity
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteScalingPolicy](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande supprime la stratégie de mise à l’échelle spécifiée pour une cible évolutive Application Auto Scaling.**
```
Remove-AASScalingPolicy -ServiceNamespace AppStream -PolicyName "default-scale-out" -ResourceId fleet/Test -ScalableDimension appstream:fleet:DesiredCapacity
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DeleteScheduledAction` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteScheduledAction`.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer une action planifiée**
L'`delete-scheduled-action`exemple suivant supprime l'action planifiée spécifiée de la flotte Amazon AppStream 2.0 spécifiée :
```
aws application-autoscaling delete-scheduled-action \
--service-namespace appstream \
--scalable-dimension appstream:fleet:DesiredCapacity \
--resource-id fleet/sample-fleet \
--scheduled-action-name my-recurring-action
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Mise à l’échelle planifiée](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/delete-scheduled-action.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande supprime l’action planifiée spécifiée pour une cible évolutive Application Auto Scaling.**
```
Remove-AASScheduledAction -ServiceNamespace AppStream -ScheduledActionName WeekDaysFleetScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity
```
**Sortie** :
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScheduledAction (DeleteScheduledAction)" on target "WeekDaysFleetScaling".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande supprime l’action planifiée spécifiée pour une cible évolutive Application Auto Scaling.**
```
Remove-AASScheduledAction -ServiceNamespace AppStream -ScheduledActionName WeekDaysFleetScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity
```
**Sortie** :
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScheduledAction (DeleteScheduledAction)" on target "WeekDaysFleetScaling".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DeregisterScalableTarget` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DeregisterScalableTarget`.
------
#### [ CLI ]
**AWS CLI**
**Pour annuler l’enregistrement d’une cible évolutive**
Cet exemple annule l’enregistrement d’une cible évolutive pour un service Amazon ECS appelé web-app qui s’exécute dans le cluster par défaut.
Commande :
```
aws application-autoscaling deregister-scalable-target --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app
```
Cet exemple annule l’enregistrement d’une cible évolutive pour une ressource personnalisée. Le fichier custom-resource-id .txt contient une chaîne qui identifie l'ID de ressource, qui, pour une ressource personnalisée, est le chemin d'accès à la ressource personnalisée via votre point de terminaison Amazon API Gateway.
Commande :
```
aws application-autoscaling deregister-scalable-target --service-namespace custom-resource --scalable-dimension custom-resource:ResourceType:Property --resource-id file://~/custom-resource-id.txt
```
Contenu du fichier custom-resource-id .txt :
```
https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789
```
+ Pour plus de détails sur l'API, voir [DeregisterScalableTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/deregister-scalable-target.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande annule l’enregistrement d’une cible évolutive Application Auto Scaling. Le désenregistrement d’une cible évolutive supprime les politiques de mise à l’échelle qui lui sont associées.**
```
Remove-AASScalableTarget -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -ServiceNamespace AppStream
```
**Sortie** :
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScalableTarget (DeregisterScalableTarget)" on target "fleet/MyFleet".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Pour plus de détails sur l'API, reportez-vous [DeregisterScalableTarget](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande annule l’enregistrement d’une cible évolutive Application Auto Scaling. Le désenregistrement d’une cible évolutive supprime les politiques de mise à l’échelle qui lui sont associées.**
```
Remove-AASScalableTarget -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -ServiceNamespace AppStream
```
**Sortie** :
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScalableTarget (DeregisterScalableTarget)" on target "fleet/MyFleet".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Pour plus de détails sur l'API, reportez-vous [DeregisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeScalableTargets` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeScalableTargets`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire des cibles évolutives**
L’exemple `describe-scalable-targets` suivant décrit les cibles évolutives pour l’espace de noms de service `ecs`.
```
aws application-autoscaling describe-scalable-targets \
--service-namespace ecs
```
Sortie :
```
{
"ScalableTargets": [
{
"ServiceNamespace": "ecs",
"ScalableDimension": "ecs:service:DesiredCount",
"ResourceId": "service/default/web-app",
"MinCapacity": 1,
"MaxCapacity": 10,
"RoleARN": "arn:aws:iam::123456789012:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService",
"CreationTime": 1462558906.199,
"SuspendedState": {
"DynamicScalingOutSuspended": false,
"ScheduledScalingSuspended": false,
"DynamicScalingInSuspended": false
},
"ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}
]
}
```
Pour plus d’informations, consultez [Services AWS que vous pouvez utiliser avec Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [DescribeScalableTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scalable-targets.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple fournit des informations sur les cibles évolutives Application Auto·Scaling dans l’espace de noms spécifié.**
```
Get-AASScalableTarget -ServiceNamespace "AppStream"
```
**Sortie** :
```
CreationTime : 11/7/2019 2:30:03 AM
MaxCapacity : 5
MinCapacity : 1
ResourceId : fleet/Test
RoleARN : arn:aws:iam::012345678912:role/aws-service-role/appstream.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_AppStreamFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
SuspendedState : Amazon.ApplicationAutoScaling.Model.SuspendedState
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScalableTargets](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple fournit des informations sur les cibles évolutives Application Auto·Scaling dans l’espace de noms spécifié.**
```
Get-AASScalableTarget -ServiceNamespace "AppStream"
```
**Sortie** :
```
CreationTime : 11/7/2019 2:30:03 AM
MaxCapacity : 5
MinCapacity : 1
ResourceId : fleet/Test
RoleARN : arn:aws:iam::012345678912:role/aws-service-role/appstream.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_AppStreamFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
SuspendedState : Amazon.ApplicationAutoScaling.Model.SuspendedState
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScalableTargets](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeScalingActivities` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeScalingActivities`.
------
#### [ CLI ]
**AWS CLI**
**Exemple 1 : pour décrire les activités de mise à l’échelle pour le service Amazon ECS spécifié**
L’exemple `describe-scaling-activities` suivant décrit les activités de mise à l’échelle d’un service Amazon ECS appelé `web-app` qui s’exécute dans le cluster `default`. La sortie montre une activité de mise à l’échelle initiée par une politique de mise à l’échelle.
```
aws application-autoscaling describe-scaling-activities \
--service-namespace ecs \
--resource-id service/default/web-app
```
Sortie :
```
{
"ScalingActivities": [
{
"ScalableDimension": "ecs:service:DesiredCount",
"Description": "Setting desired count to 1.",
"ResourceId": "service/default/web-app",
"ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399",
"StartTime": 1462575838.171,
"ServiceNamespace": "ecs",
"EndTime": 1462575872.111,
"Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25",
"StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.",
"StatusCode": "Successful"
}
]
}
```
Pour plus d’informations, consultez [Activités de mise à l’échelle pour Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
**Exemple 2 : pour décrire les activités de mise à l’échelle pour la table DynamoDB spécifiée**
L’exemple `describe-scaling-activities` suivant décrit les activités de mise à l’échelle pour une table DynamoDB appelée `TestTable`. La sortie montre les activités de mise à l’échelle initiées par deux actions planifiées différentes.
```
aws application-autoscaling describe-scaling-activities \
--service-namespace dynamodb \
--resource-id table/TestTable
```
Sortie :
```
{
"ScalingActivities": [
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting write capacity units to 10.",
"ResourceId": "table/my-table",
"ActivityId": "4d1308c0-bbcf-4514-a673-b0220ae38547",
"StartTime": 1561574415.086,
"ServiceNamespace": "dynamodb",
"EndTime": 1561574449.51,
"Cause": "maximum capacity was set to 10",
"StatusMessage": "Successfully set write capacity units to 10. Change successfully fulfilled by dynamodb.",
"StatusCode": "Successful"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting min capacity to 5 and max capacity to 10",
"ResourceId": "table/my-table",
"ActivityId": "f2b7847b-721d-4e01-8ef0-0c8d3bacc1c7",
"StartTime": 1561574414.644,
"ServiceNamespace": "dynamodb",
"Cause": "scheduled action name my-second-scheduled-action was triggered",
"StatusMessage": "Successfully set min capacity to 5 and max capacity to 10",
"StatusCode": "Successful"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting write capacity units to 15.",
"ResourceId": "table/my-table",
"ActivityId": "d8ea4de6-9eaa-499f-b466-2cc5e681ba8b",
"StartTime": 1561574108.904,
"ServiceNamespace": "dynamodb",
"EndTime": 1561574140.255,
"Cause": "minimum capacity was set to 15",
"StatusMessage": "Successfully set write capacity units to 15. Change successfully fulfilled by dynamodb.",
"StatusCode": "Successful"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting min capacity to 15 and max capacity to 20",
"ResourceId": "table/my-table",
"ActivityId": "3250fd06-6940-4e8e-bb1f-d494db7554d2",
"StartTime": 1561574108.512,
"ServiceNamespace": "dynamodb",
"Cause": "scheduled action name my-first-scheduled-action was triggered",
"StatusMessage": "Successfully set min capacity to 15 and max capacity to 20",
"StatusCode": "Successful"
}
]
}
```
Pour plus d’informations, consultez [Activités de mise à l’échelle pour Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [DescribeScalingActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scaling-activities.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : fournit des informations descriptives pour les activités de mise à l’échelle avec un espace de noms de service spécifié pour les six dernières semaines.**
```
Get-AASScalingActivity -ServiceNamespace AppStream
```
**Sortie** :
```
ActivityId : 2827409f-b639-4cdb-a957-8055d5d07434
Cause : monitor alarm Appstream2-MyFleet-default-scale-in-Alarm in state ALARM triggered policy default-scale-in
Description : Setting desired capacity to 2.
Details :
EndTime : 12/14/2019 11:32:49 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StartTime : 12/14/2019 11:32:14 AM
StatusCode : Successful
StatusMessage : Successfully set desired capacity to 2. Change successfully fulfilled by appstream.
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : fournit des informations descriptives pour les activités de mise à l’échelle avec un espace de noms de service spécifié pour les six dernières semaines.**
```
Get-AASScalingActivity -ServiceNamespace AppStream
```
**Sortie** :
```
ActivityId : 2827409f-b639-4cdb-a957-8055d5d07434
Cause : monitor alarm Appstream2-MyFleet-default-scale-in-Alarm in state ALARM triggered policy default-scale-in
Description : Setting desired capacity to 2.
Details :
EndTime : 12/14/2019 11:32:49 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StartTime : 12/14/2019 11:32:14 AM
StatusCode : Successful
StatusMessage : Successfully set desired capacity to 2. Change successfully fulfilled by appstream.
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation `DescribeScalingPolicies` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeScalingPolicies`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire les politiques de mise à l’échelle**
Cet exemple de commande décrit les politiques de mise à l’échelle pour l’espace de noms du service ecs.
Commande :
```
aws application-autoscaling describe-scaling-policies --service-namespace ecs
```
Sortie :
```
{
"ScalingPolicies": [
{
"PolicyName": "web-app-cpu-gt-75",
"ScalableDimension": "ecs:service:DesiredCount",
"ResourceId": "service/default/web-app",
"CreationTime": 1462561899.23,
"StepScalingPolicyConfiguration": {
"Cooldown": 60,
"StepAdjustments": [
{
"ScalingAdjustment": 200,
"MetricIntervalLowerBound": 0.0
}
],
"AdjustmentType": "PercentChangeInCapacity"
},
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75",
"PolicyType": "StepScaling",
"Alarms": [
{
"AlarmName": "web-app-cpu-gt-75",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75"
}
],
"ServiceNamespace": "ecs"
},
{
"PolicyName": "web-app-cpu-lt-25",
"ScalableDimension": "ecs:service:DesiredCount",
"ResourceId": "service/default/web-app",
"CreationTime": 1462562575.099,
"StepScalingPolicyConfiguration": {
"Cooldown": 1,
"StepAdjustments": [
{
"ScalingAdjustment": -50,
"MetricIntervalUpperBound": 0.0
}
],
"AdjustmentType": "PercentChangeInCapacity"
},
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-lt-25",
"PolicyType": "StepScaling",
"Alarms": [
{
"AlarmName": "web-app-cpu-lt-25",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-lt-25"
}
],
"ServiceNamespace": "ecs"
}
]
}
```
+ Pour plus de détails sur l'API, voir [DescribeScalingPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scaling-policies.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande décrit les politiques de mise à l’échelle d’Application Auto Scaling pour l’espace de noms de service spécifié.**
```
Get-AASScalingPolicy -ServiceNamespace AppStream
```
**Sortie** :
```
Alarms : {Appstream2-LabFleet-default-scale-out-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-out
PolicyName : default-scale-out
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
Alarms : {Appstream2-LabFleet-default-scale-in-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-in
PolicyName : default-scale-in
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScalingPolicies](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande décrit les politiques de mise à l’échelle d’Application Auto Scaling pour l’espace de noms de service spécifié.**
```
Get-AASScalingPolicy -ServiceNamespace AppStream
```
**Sortie** :
```
Alarms : {Appstream2-LabFleet-default-scale-out-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-out
PolicyName : default-scale-out
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
Alarms : {Appstream2-LabFleet-default-scale-in-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-in
PolicyName : default-scale-in
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScalingPolicies](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/applicationautoscaling#code-examples).
```
async fn show_policies(client: &Client) -> Result<(), Error> {
let response = client
.describe_scaling_policies()
.service_namespace(ServiceNamespace::Ec2)
.send()
.await?;
println!("Auto Scaling Policies:");
for policy in response.scaling_policies() {
println!("{:?}\n", policy);
}
println!("Next token: {:?}", response.next_token());
Ok(())
}
```
+ Pour plus de détails sur l'API, voir [DescribeScalingPolicies](https://docs.rs/aws-sdk-applicationautoscaling/latest/aws_sdk_applicationautoscaling/client/struct.Client.html#method.describe_scaling_policies)la section de *référence de l'API AWS SDK for Rust*.
------
# Utilisation de `DescribeScheduledActions` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeScheduledActions`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire les actions planifiées**
L’exemple `describe-scheduled-actions` suivant affiche les informations des actions planifiées pour l’espace de noms de service spécifié :
```
aws application-autoscaling describe-scheduled-actions \
--service-namespace dynamodb
```
Sortie :
```
{
"ScheduledActions": [
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Schedule": "at(2019-05-20T18:35:00)",
"ResourceId": "table/my-table",
"CreationTime": 1561571888.361,
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action",
"ScalableTargetAction": {
"MinCapacity": 15,
"MaxCapacity": 20
},
"ScheduledActionName": "my-first-scheduled-action",
"ServiceNamespace": "dynamodb"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Schedule": "at(2019-05-20T18:40:00)",
"ResourceId": "table/my-table",
"CreationTime": 1561571946.021,
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action",
"ScalableTargetAction": {
"MinCapacity": 5,
"MaxCapacity": 10
},
"ScheduledActionName": "my-second-scheduled-action",
"ServiceNamespace": "dynamodb"
}
]
}
```
Pour plus d’informations, consultez [Mise à l’échelle planifiée](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [DescribeScheduledActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scheduled-actions.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande répertorie les actions planifiées pour votre groupe Auto Scaling qui n’ont pas été exécutées ou qui n’ont pas atteint leur heure de fin. **
```
Get-AASScheduledAction -ServiceNamespace AppStream
```
**Sortie** :
```
CreationTime : 12/22/2019 9:25:52 AM
EndTime : 1/1/0001 12:00:00 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ScalableTargetAction : Amazon.ApplicationAutoScaling.Model.ScalableTargetAction
Schedule : cron(0 0 8 ? * MON-FRI *)
ScheduledActionARN : arn:aws:autoscaling:us-west-2:012345678912:scheduledAction:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:scheduledActionName
/WeekDaysFleetScaling
ScheduledActionName : WeekDaysFleetScaling
ServiceNamespace : appstream
StartTime : 1/1/0001 12:00:00 AM
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande répertorie les actions planifiées pour votre groupe Auto Scaling qui n’ont pas été exécutées ou qui n’ont pas atteint leur heure de fin. **
```
Get-AASScheduledAction -ServiceNamespace AppStream
```
**Sortie** :
```
CreationTime : 12/22/2019 9:25:52 AM
EndTime : 1/1/0001 12:00:00 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ScalableTargetAction : Amazon.ApplicationAutoScaling.Model.ScalableTargetAction
Schedule : cron(0 0 8 ? * MON-FRI *)
ScheduledActionARN : arn:aws:autoscaling:us-west-2:012345678912:scheduledAction:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:scheduledActionName
/WeekDaysFleetScaling
ScheduledActionName : WeekDaysFleetScaling
ServiceNamespace : appstream
StartTime : 1/1/0001 12:00:00 AM
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `PutScalingPolicy` avec une CLI
Les exemples de code suivants illustrent comment utiliser `PutScalingPolicy`.
------
#### [ CLI ]
**AWS CLI**
**Exemple 1 : pour appliquer une politique de suivi des objectifs et d’échelonnement avec une spécification de métrique prédéfinie**
L’exemple `put-scaling-policy` suivant applique une politique de suivi des cibles et d’échelonnement avec une spécification de métrique prédéfinie sur un service Amazon ECS appelé web-app dans le cluster par défaut. La politique maintient l’utilisation moyenne de l’UC du service à 75 %, avec des temps de stabilisation de montée en puissance et de mise à l’échelle horizontale de 60 secondes. La sortie contient les noms ARNs et les noms des deux CloudWatch alarmes créées en votre nom.
```
aws application-autoscaling put-scaling-policy --service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--policy-name cpu75-target-tracking-scaling-policy --policy-type TargetTrackingScaling \
--target-tracking-scaling-policy-configuration file://config.json
```
Cet exemple suppose que le répertoire en cours contient un fichier config.json dont le contenu est le suivant :
```
{
"TargetValue": 75.0,
"PredefinedMetricSpecification": {
"PredefinedMetricType": "ECSServiceAverageCPUUtilization"
},
"ScaleOutCooldown": 60,
"ScaleInCooldown": 60
}
```
Sortie :
```
{
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy",
"Alarms": [
{
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca",
"AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
},
{
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d",
"AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d"
}
]
}
```
**Exemple 2 : pour appliquer une politique de suivi des objectifs et d’échelonnement avec une spécification de métrique personnalisée**
L’exemple `put-scaling-policy` suivant applique une politique de suivi des cibles et d’échelonnement avec un type de métrique personnalisé à un service ECS appelé web-app dans le cluster par défaut. La politique maintient l’utilisation moyenne du service à 75 %, avec des temps de stabilisation de montée en puissance et de mise à l’échelle horizontale de 60 secondes. La sortie contient les noms ARNs et les noms des deux CloudWatch alarmes créées en votre nom.
```
aws application-autoscaling put-scaling-policy --service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--policy-name cms75-target-tracking-scaling-policy
--policy-type TargetTrackingScaling \
--target-tracking-scaling-policy-configuration file://config.json
```
Cet exemple suppose que le répertoire en cours contient un fichier config.json dont le contenu est le suivant :
```
{
"TargetValue":75.0,
"CustomizedMetricSpecification":{
"MetricName":"MyUtilizationMetric",
"Namespace":"MyNamespace",
"Dimensions": [
{
"Name":"MyOptionalMetricDimensionName",
"Value":"MyOptionalMetricDimensionValue"
}
],
"Statistic":"Average",
"Unit":"Percent"
},
"ScaleOutCooldown": 60,
"ScaleInCooldown": 60
}
```
Sortie :
```
{
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy: 8784a896-b2ba-47a1-b08c-27301cc499a1:resource/ecs/service/default/web-app:policyName/cms75-target-tracking-scaling-policy",
"Alarms": [
{
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0",
"AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0"
},
{
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4",
"AlarmName": "TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4"
}
]
}
```
**Exemple 3 : pour appliquer une politique de suivi des objectifs et d’échelonnement uniquement en vue d’une évolutivité horizontale**
L’exemple `put-scaling-policy` suivant applique une politique de suivi des cibles et d’échelonnement sur un service Amazon ECS appelé `web-app` dans le cluster par défaut. La politique est utilisée pour augmenter horizontalement le service ECS lorsque la métrique `RequestCountPerTarget` de l’Application Load Balancer dépasse le seuil. La sortie contient l'ARN et le nom de l' CloudWatch alarme créée en votre nom.
```
aws application-autoscaling put-scaling-policy \
--service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--policy-name alb-scale-out-target-tracking-scaling-policy \
--policy-type TargetTrackingScaling \
--target-tracking-scaling-policy-configuration file://config.json
```
Contenu de `config.json` :
```
{
"TargetValue": 1000.0,
"PredefinedMetricSpecification": {
"PredefinedMetricType": "ALBRequestCountPerTarget",
"ResourceLabel": "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d"
},
"ScaleOutCooldown": 60,
"ScaleInCooldown": 60,
"DisableScaleIn": true
}
```
Sortie :
```
{
"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/alb-scale-out-target-tracking-scaling-policy",
"Alarms": [
{
"AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
}
]
}
```
Pour plus d’informations, consultez [Politique de suivi des cibles et d’échelonnement pour Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) dans le *AWS Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [PutScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/put-scaling-policy.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande crée ou met à jour une politique pour une cible évolutive Application Auto Scaling. Chaque cible évolutive est identifiée par un espace de noms de service, un ID de ressource et une dimension évolutive.**
```
Set-AASScalingPolicy -ServiceNamespace AppStream -PolicyName ASFleetScaleInPolicy -PolicyType StepScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -StepScalingPolicyConfiguration_AdjustmentType ChangeInCapacity -StepScalingPolicyConfiguration_Cooldown 360 -StepScalingPolicyConfiguration_MetricAggregationType Average -StepScalingPolicyConfiguration_StepAdjustments @{ScalingAdjustment = -1; MetricIntervalUpperBound = 0}
```
**Sortie** :
```
Alarms PolicyARN
------ ---------
{} arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:policyName/ASFleetScaleInPolicy
```
+ Pour plus de détails sur l'API, reportez-vous [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande crée ou met à jour une politique pour une cible évolutive Application Auto Scaling. Chaque cible évolutive est identifiée par un espace de noms de service, un ID de ressource et une dimension évolutive.**
```
Set-AASScalingPolicy -ServiceNamespace AppStream -PolicyName ASFleetScaleInPolicy -PolicyType StepScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -StepScalingPolicyConfiguration_AdjustmentType ChangeInCapacity -StepScalingPolicyConfiguration_Cooldown 360 -StepScalingPolicyConfiguration_MetricAggregationType Average -StepScalingPolicyConfiguration_StepAdjustments @{ScalingAdjustment = -1; MetricIntervalUpperBound = 0}
```
**Sortie** :
```
Alarms PolicyARN
------ ---------
{} arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:policyName/ASFleetScaleInPolicy
```
+ Pour plus de détails sur l'API, reportez-vous [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `PutScheduledAction` avec une CLI
Les exemples de code suivants illustrent comment utiliser `PutScheduledAction`.
------
#### [ CLI ]
**AWS CLI**
**Pour ajouter une action planifiée à une table DynamoDB**
Cet exemple ajoute une action planifiée à une table DynamoDB TestTable appelée pour effectuer une mise à l'échelle selon un calendrier récurrent. Selon le calendrier spécifié (tous les jours à 12 h 15 UTC), si la capacité actuelle est inférieure à la valeur spécifiée pour MinCapacity, Application Auto Scaling s'adapte à la valeur spécifiée par MinCapacity.
Commande :
```
aws application-autoscaling put-scheduled-action --service-namespace dynamodb --scheduled-action-name my-recurring-action --schedule "cron(15 12 * * ? *)" --resource-id table/TestTable --scalable-dimension dynamodb:table:WriteCapacityUnits --scalable-target-action MinCapacity=6
```
Pour plus d’informations, consultez Dimensionnement planifié dans le *Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [PutScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/put-scheduled-action.html)la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande crée ou met à jour une action planifiée pour une cible évolutive Application Auto Scaling. Chaque cible évolutive est identifiée par un espace de noms de service, un ID de ressource et une dimension évolutive.**
```
Set-AASScheduledAction -ServiceNamespace AppStream -ResourceId fleet/MyFleet -Schedule "cron(0 0 8 ? * MON-FRI *)" -ScalableDimension appstream:fleet:DesiredCapacity -ScheduledActionName WeekDaysFleetScaling -ScalableTargetAction_MinCapacity 5 -ScalableTargetAction_MaxCapacity 10
```
+ Pour plus de détails sur l'API, reportez-vous [PutScheduledAction](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande crée ou met à jour une action planifiée pour une cible évolutive Application Auto Scaling. Chaque cible évolutive est identifiée par un espace de noms de service, un ID de ressource et une dimension évolutive.**
```
Set-AASScheduledAction -ServiceNamespace AppStream -ResourceId fleet/MyFleet -Schedule "cron(0 0 8 ? * MON-FRI *)" -ScalableDimension appstream:fleet:DesiredCapacity -ScheduledActionName WeekDaysFleetScaling -ScalableTargetAction_MinCapacity 5 -ScalableTargetAction_MaxCapacity 10
```
+ Pour plus de détails sur l'API, reportez-vous [PutScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation `RegisterScalableTarget` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `RegisterScalableTarget`.
------
#### [ CLI ]
**AWS CLI**
**Exemple 1 : pour enregistrer un service ECS en tant que cible évolutive**
L’exemple `register-scalable-target` suivant enregistre un service Amazon ECS avec Application Auto Scaling. Il ajoute également une balise avec le nom de la clé `environment` et la valeur `production` à la cible évolutive.
```
aws application-autoscaling register-scalable-target \
--service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--min-capacity 1 --max-capacity 10 \
--tags environment=production
```
Sortie :
```
{
"ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}
```
Pour des exemples d'autres AWS services et ressources personnalisées, consultez les rubriques relatives [AWS aux services que vous pouvez utiliser avec Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) dans le *Guide de l'utilisateur d'Application Auto Scaling*.
**Exemple 2 : pour suspendre les activités de mise à l’échelle pour une cible évolutive**
L’exemple `register-scalable-target` suivant suspend les activités de mise à l’échelle pour une cible évolutive existante.
```
aws application-autoscaling register-scalable-target \
--service-namespace dynamodb \
--scalable-dimension dynamodb:table:ReadCapacityUnits \
--resource-id table/my-table \
--suspended-state DynamicScalingInSuspended=true,DynamicScalingOutSuspended=true,ScheduledScalingSuspended=true
```
Sortie :
```
{
"ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}
```
Pour plus d’informations, consultez [Suspension et reprise de la mise à l’échelle pour Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
**Exemple 3 : pour reprendre les activités de mise à l’échelle pour une cible évolutive**
L’exemple `register-scalable-target` suivant reprend les activités de mise à l’échelle pour une cible évolutive existante.
```
aws application-autoscaling register-scalable-target \
--service-namespace dynamodb \
--scalable-dimension dynamodb:table:ReadCapacityUnits \
--resource-id table/my-table \
--suspended-state DynamicScalingInSuspended=false,DynamicScalingOutSuspended=false,ScheduledScalingSuspended=false
```
Sortie :
```
{
"ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}
```
Pour plus d’informations, consultez [Suspension et reprise de la mise à l’échelle pour Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) dans le *Guide de l’utilisateur Application Auto Scaling*.
+ Pour plus de détails sur l'API, voir [RegisterScalableTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/register-scalable-target.html)la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/appautoscale#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.applicationautoscaling.ApplicationAutoScalingClient;
import software.amazon.awssdk.services.applicationautoscaling.model.ApplicationAutoScalingException;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsResponse;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesResponse;
import software.amazon.awssdk.services.applicationautoscaling.model.PolicyType;
import software.amazon.awssdk.services.applicationautoscaling.model.PredefinedMetricSpecification;
import software.amazon.awssdk.services.applicationautoscaling.model.PutScalingPolicyRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.RegisterScalableTargetRequest;
import software.amazon.awssdk.services.applicationautoscaling.model.ScalingPolicy;
import software.amazon.awssdk.services.applicationautoscaling.model.ServiceNamespace;
import software.amazon.awssdk.services.applicationautoscaling.model.ScalableDimension;
import software.amazon.awssdk.services.applicationautoscaling.model.MetricType;
import software.amazon.awssdk.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration;
import java.util.List;
/**
* Before running this Java V2 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-java/latest/developer-guide/get-started.html
*/
public class EnableDynamoDBAutoscaling {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
tableId - The table Id value (for example, table/Music).
roleARN - The ARN of the role that has ApplicationAutoScaling permissions.
policyName - The name of the policy to create.
""";
if (args.length != 3) {
System.out.println(usage);
System.exit(1);
}
System.out.println("This example registers an Amazon DynamoDB table, which is the resource to scale.");
String tableId = args[0];
String roleARN = args[1];
String policyName = args[2];
ServiceNamespace ns = ServiceNamespace.DYNAMODB;
ScalableDimension tableWCUs = ScalableDimension.DYNAMODB_TABLE_WRITE_CAPACITY_UNITS;
ApplicationAutoScalingClient appAutoScalingClient = ApplicationAutoScalingClient.builder()
.region(Region.US_EAST_1)
.build();
registerScalableTarget(appAutoScalingClient, tableId, roleARN, ns, tableWCUs);
verifyTarget(appAutoScalingClient, tableId, ns, tableWCUs);
configureScalingPolicy(appAutoScalingClient, tableId, ns, tableWCUs, policyName);
}
public static void registerScalableTarget(ApplicationAutoScalingClient appAutoScalingClient, String tableId, String roleARN, ServiceNamespace ns, ScalableDimension tableWCUs) {
try {
RegisterScalableTargetRequest targetRequest = RegisterScalableTargetRequest.builder()
.serviceNamespace(ns)
.scalableDimension(tableWCUs)
.resourceId(tableId)
.roleARN(roleARN)
.minCapacity(5)
.maxCapacity(10)
.build();
appAutoScalingClient.registerScalableTarget(targetRequest);
System.out.println("You have registered " + tableId);
} catch (ApplicationAutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
}
}
// Verify that the target was created.
public static void verifyTarget(ApplicationAutoScalingClient appAutoScalingClient, String tableId, ServiceNamespace ns, ScalableDimension tableWCUs) {
DescribeScalableTargetsRequest dscRequest = DescribeScalableTargetsRequest.builder()
.scalableDimension(tableWCUs)
.serviceNamespace(ns)
.resourceIds(tableId)
.build();
DescribeScalableTargetsResponse response = appAutoScalingClient.describeScalableTargets(dscRequest);
System.out.println("DescribeScalableTargets result: ");
System.out.println(response);
}
// Configure a scaling policy.
public static void configureScalingPolicy(ApplicationAutoScalingClient appAutoScalingClient, String tableId, ServiceNamespace ns, ScalableDimension tableWCUs, String policyName) {
// Check if the policy exists before creating a new one.
DescribeScalingPoliciesResponse describeScalingPoliciesResponse = appAutoScalingClient.describeScalingPolicies(DescribeScalingPoliciesRequest.builder()
.serviceNamespace(ns)
.resourceId(tableId)
.scalableDimension(tableWCUs)
.build());
if (!describeScalingPoliciesResponse.scalingPolicies().isEmpty()) {
// If policies exist, consider updating an existing policy instead of creating a new one.
System.out.println("Policy already exists. Consider updating it instead.");
List polList = describeScalingPoliciesResponse.scalingPolicies();
for (ScalingPolicy pol : polList) {
System.out.println("Policy name:" +pol.policyName());
}
} else {
// If no policies exist, proceed with creating a new policy.
PredefinedMetricSpecification specification = PredefinedMetricSpecification.builder()
.predefinedMetricType(MetricType.DYNAMO_DB_WRITE_CAPACITY_UTILIZATION)
.build();
TargetTrackingScalingPolicyConfiguration policyConfiguration = TargetTrackingScalingPolicyConfiguration.builder()
.predefinedMetricSpecification(specification)
.targetValue(50.0)
.scaleInCooldown(60)
.scaleOutCooldown(60)
.build();
PutScalingPolicyRequest putScalingPolicyRequest = PutScalingPolicyRequest.builder()
.targetTrackingScalingPolicyConfiguration(policyConfiguration)
.serviceNamespace(ns)
.scalableDimension(tableWCUs)
.resourceId(tableId)
.policyName(policyName)
.policyType(PolicyType.TARGET_TRACKING_SCALING)
.build();
try {
appAutoScalingClient.putScalingPolicy(putScalingPolicyRequest);
System.out.println("You have successfully created a scaling policy for an Application Auto Scaling scalable target");
} catch (ApplicationAutoScalingException e) {
System.err.println("Error: " + e.awsErrorDetails().errorMessage());
}
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [RegisterScalableTarget](https://docs.aws.amazon.com/goto/SdkForJavaV2/application-autoscaling-2016-02-06/RegisterScalableTarget)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cette applet de commande enregistre ou met à jour une cible évolutive. Une cible évolutive est une ressource qu’Application Auto Scaling peut augmenter et diminuer.**
```
Add-AASScalableTarget -ServiceNamespace AppStream -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -MinCapacity 2 -MaxCapacity 10
```
+ Pour plus de détails sur l'API, reportez-vous [RegisterScalableTarget](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cette applet de commande enregistre ou met à jour une cible évolutive. Une cible évolutive est une ressource qu’Application Auto Scaling peut augmenter et diminuer.**
```
Add-AASScalableTarget -ServiceNamespace AppStream -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -MinCapacity 2 -MaxCapacity 10
```
+ Pour plus de détails sur l'API, reportez-vous [RegisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Exemples de code pour Application Recovery Controller utilisant AWS SDKs
Les exemples de code suivants vous montrent comment utiliser Amazon Route 53 Application Recovery Controller avec un kit de développement AWS logiciel (SDK).
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
**Ressources supplémentaires**
+ **[Guide du développeur du Contrôleur de récupération d’application](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html)** : plus d’informations sur le contrôleur de récupération d’application.
+ **[Référence des API du contrôleur de récupération d’application](https://docs.aws.amazon.com/routing-control/latest/APIReference/Welcome.html)** : détails sur toutes les actions du contrôleur de récupération d’application disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23route53)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](route53-recovery-cluster_code_examples_basics.md)
+ [Actions](route53-recovery-cluster_code_examples_actions.md)
+ [`GetRoutingControlState`](route53-recovery-cluster_example_route53-recovery-cluster_GetRoutingControlState_section.md)
+ [`UpdateRoutingControlState`](route53-recovery-cluster_example_route53-recovery-cluster_UpdateRoutingControlState_section.md)
# Exemples de base pour l'utilisation d'Application Recovery Controller AWS SDKs
Les exemples de code suivants montrent comment utiliser les bases d'Amazon Route 53 Application Recovery Controller avec AWS SDKs.
**Contents**
+ [Actions](route53-recovery-cluster_code_examples_actions.md)
+ [`GetRoutingControlState`](route53-recovery-cluster_example_route53-recovery-cluster_GetRoutingControlState_section.md)
+ [`UpdateRoutingControlState`](route53-recovery-cluster_example_route53-recovery-cluster_UpdateRoutingControlState_section.md)
# Actions pour Application Recovery Controller utilisant AWS SDKs
Les exemples de code suivants montrent comment effectuer des actions individuelles d'Application Recovery Controller avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez la [Référence des API du contrôleur de récupération d’application Amazon Route 53](https://docs.aws.amazon.com/routing-control/latest/APIReference/Welcome.html).
**Topics**
+ [`GetRoutingControlState`](route53-recovery-cluster_example_route53-recovery-cluster_GetRoutingControlState_section.md)
+ [`UpdateRoutingControlState`](route53-recovery-cluster_example_route53-recovery-cluster_UpdateRoutingControlState_section.md)
# Utilisation `GetRoutingControlState` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `GetRoutingControlState`.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53recoverycluster#code-examples).
```
public static GetRoutingControlStateResponse getRoutingControlState(List clusterEndpoints,
String routingControlArn) {
// As a best practice, we recommend choosing a random cluster endpoint to get or
// set routing control states.
// For more information, see
// https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html#route53-arc-best-practices.regional
Collections.shuffle(clusterEndpoints);
for (ClusterEndpoint clusterEndpoint : clusterEndpoints) {
try {
System.out.println(clusterEndpoint);
Route53RecoveryClusterClient client = Route53RecoveryClusterClient.builder()
.endpointOverride(URI.create(clusterEndpoint.endpoint()))
.region(Region.of(clusterEndpoint.region())).build();
return client.getRoutingControlState(
GetRoutingControlStateRequest.builder()
.routingControlArn(routingControlArn).build());
} catch (Exception exception) {
System.out.println(exception);
}
}
return null;
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetRoutingControlState](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53-recovery-cluster-2019-12-02/GetRoutingControlState)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/route53-recovery-cluster#code-examples).
```
import boto3
def create_recovery_client(cluster_endpoint):
"""
Creates a Boto3 Route 53 Application Recovery Controller client for the specified
cluster endpoint URL and AWS Region.
:param cluster_endpoint: The cluster endpoint URL and Region.
:return: The Boto3 client.
"""
return boto3.client(
"route53-recovery-cluster",
endpoint_url=cluster_endpoint["Endpoint"],
region_name=cluster_endpoint["Region"],
)
def get_routing_control_state(routing_control_arn, cluster_endpoints):
"""
Gets the state of a routing control. Cluster endpoints are tried in
sequence until the first successful response is received.
:param routing_control_arn: The ARN of the routing control to look up.
:param cluster_endpoints: The list of cluster endpoints to query.
:return: The routing control state response.
"""
# As a best practice, we recommend choosing a random cluster endpoint to get or set routing control states.
# For more information, see https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html#route53-arc-best-practices.regional
random.shuffle(cluster_endpoints)
for cluster_endpoint in cluster_endpoints:
try:
recovery_client = create_recovery_client(cluster_endpoint)
response = recovery_client.get_routing_control_state(
RoutingControlArn=routing_control_arn
)
return response
except Exception as error:
print(error)
raise error
```
+ Pour plus de détails sur l'API, consultez [GetRoutingControlState](https://docs.aws.amazon.com/goto/boto3/route53-recovery-cluster-2019-12-02/GetRoutingControlState)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/r5v#code-examples).
```
CONSTANTS cv_pfl TYPE /aws1/rt_profile_id VALUE 'ZCODE_DEMO'.
DATA lo_exception TYPE REF TO /aws1/cx_rt_generic.
DATA lo_session TYPE REF TO /aws1/cl_rt_session_base.
DATA lo_client TYPE REF TO /aws1/if_r5v.
DATA lt_endpoints TYPE TABLE OF string.
DATA lv_endpoint TYPE string.
DATA lv_region TYPE /aws1/rt_region_id.
" Parse the comma-separated cluster endpoints
" Expected format: "https://endpoint1.com|us-west-2,https://endpoint2.com|us-east-1"
SPLIT iv_cluster_endpoints AT ',' INTO TABLE lt_endpoints.
" As a best practice, shuffle cluster endpoints to distribute load
" For more information, see https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html#route53-arc-best-practices.regional
" For simplicity, we'll try them in order (shuffling can be added if needed)
" Try each endpoint in order
LOOP AT lt_endpoints INTO lv_endpoint.
TRY.
" Parse endpoint and region from the format "url|region"
DATA(lv_pos) = find( val = lv_endpoint sub = '|' ).
IF lv_pos > 0.
DATA(lv_url) = substring( val = lv_endpoint len = lv_pos ).
lv_region = substring( val = lv_endpoint off = lv_pos + 1 ).
ELSE.
" If no region specified, use default
lv_url = lv_endpoint.
lv_region = 'us-east-1'.
ENDIF.
" Create session for this region
lo_session = /aws1/cl_rt_session_aws=>create( cv_pfl ).
" Create client with the specific endpoint
lo_client = create_recovery_client(
iv_endpoint = lv_url
iv_region = lv_region
io_session = lo_session ).
" Try to get the routing control state
oo_result = lo_client->getroutingcontrolstate(
iv_routingcontrolarn = iv_routing_control_arn ).
" If successful, return the result
RETURN.
CATCH /aws1/cx_r5vendpttmpyunavailex INTO DATA(lo_endpoint_ex).
" This endpoint is temporarily unavailable, try the next one
lo_exception = lo_endpoint_ex.
CONTINUE.
CATCH /aws1/cx_r5vaccessdeniedex
/aws1/cx_r5vinternalserverex
/aws1/cx_r5vresourcenotfoundex
/aws1/cx_r5vthrottlingex
/aws1/cx_r5vvalidationex
/aws1/cx_rt_generic INTO lo_exception.
" For other errors, re-raise immediately
RAISE EXCEPTION lo_exception.
ENDTRY.
ENDLOOP.
" If we get here, all endpoints failed - re-raise the last exception
IF lo_exception IS BOUND.
RAISE EXCEPTION lo_exception.
ENDIF.
```
+ Pour plus de détails sur l'API, reportez-vous [GetRoutingControlState](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation `UpdateRoutingControlState` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `UpdateRoutingControlState`.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53recoverycluster#code-examples).
```
public static UpdateRoutingControlStateResponse updateRoutingControlState(List clusterEndpoints,
String routingControlArn,
String routingControlState) {
// As a best practice, we recommend choosing a random cluster endpoint to get or
// set routing control states.
// For more information, see
// https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html#route53-arc-best-practices.regional
Collections.shuffle(clusterEndpoints);
for (ClusterEndpoint clusterEndpoint : clusterEndpoints) {
try {
System.out.println(clusterEndpoint);
Route53RecoveryClusterClient client = Route53RecoveryClusterClient.builder()
.endpointOverride(URI.create(clusterEndpoint.endpoint()))
.region(Region.of(clusterEndpoint.region()))
.build();
return client.updateRoutingControlState(
UpdateRoutingControlStateRequest.builder()
.routingControlArn(routingControlArn).routingControlState(routingControlState).build());
} catch (Exception exception) {
System.out.println(exception);
}
}
return null;
}
```
+ Pour plus de détails sur l'API, reportez-vous [UpdateRoutingControlState](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/route53-recovery-cluster#code-examples).
```
import boto3
def create_recovery_client(cluster_endpoint):
"""
Creates a Boto3 Route 53 Application Recovery Controller client for the specified
cluster endpoint URL and AWS Region.
:param cluster_endpoint: The cluster endpoint URL and Region.
:return: The Boto3 client.
"""
return boto3.client(
"route53-recovery-cluster",
endpoint_url=cluster_endpoint["Endpoint"],
region_name=cluster_endpoint["Region"],
)
def update_routing_control_state(
routing_control_arn, cluster_endpoints, routing_control_state
):
"""
Updates the state of a routing control. Cluster endpoints are tried in
sequence until the first successful response is received.
:param routing_control_arn: The ARN of the routing control to update the state for.
:param cluster_endpoints: The list of cluster endpoints to try.
:param routing_control_state: The new routing control state.
:return: The routing control update response.
"""
# As a best practice, we recommend choosing a random cluster endpoint to get or set routing control states.
# For more information, see https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html#route53-arc-best-practices.regional
random.shuffle(cluster_endpoints)
for cluster_endpoint in cluster_endpoints:
try:
recovery_client = create_recovery_client(cluster_endpoint)
response = recovery_client.update_routing_control_state(
RoutingControlArn=routing_control_arn,
RoutingControlState=routing_control_state,
)
return response
except Exception as error:
print(error)
```
+ Pour plus de détails sur l'API, consultez [UpdateRoutingControlState](https://docs.aws.amazon.com/goto/boto3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/r5v#code-examples).
```
CONSTANTS cv_pfl TYPE /aws1/rt_profile_id VALUE 'ZCODE_DEMO'.
DATA lo_exception TYPE REF TO /aws1/cx_rt_generic.
DATA lo_session TYPE REF TO /aws1/cl_rt_session_base.
DATA lo_client TYPE REF TO /aws1/if_r5v.
DATA lt_endpoints TYPE TABLE OF string.
DATA lv_endpoint TYPE string.
DATA lv_region TYPE /aws1/rt_region_id.
" Parse the comma-separated cluster endpoints
" Expected format: "https://endpoint1.com|us-west-2,https://endpoint2.com|us-east-1"
SPLIT iv_cluster_endpoints AT ',' INTO TABLE lt_endpoints.
" As a best practice, shuffle cluster endpoints to distribute load
" For more information, see https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html#route53-arc-best-practices.regional
" For simplicity, we'll try them in order (shuffling can be added if needed)
" Try each endpoint in order
LOOP AT lt_endpoints INTO lv_endpoint.
TRY.
" Parse endpoint and region from the format "url|region"
DATA(lv_pos) = find( val = lv_endpoint sub = '|' ).
IF lv_pos > 0.
DATA(lv_url) = substring( val = lv_endpoint len = lv_pos ).
lv_region = substring( val = lv_endpoint off = lv_pos + 1 ).
ELSE.
" If no region specified, use default
lv_url = lv_endpoint.
lv_region = 'us-east-1'.
ENDIF.
" Create session for this region
lo_session = /aws1/cl_rt_session_aws=>create( cv_pfl ).
" Create client with the specific endpoint
lo_client = create_recovery_client(
iv_endpoint = lv_url
iv_region = lv_region
io_session = lo_session ).
" Try to update the routing control state
oo_result = lo_client->updateroutingcontrolstate(
iv_routingcontrolarn = iv_routing_control_arn
iv_routingcontrolstate = iv_routing_control_state
it_safetyrulestooverride = it_safety_rules_override ).
" If successful, return the result
RETURN.
CATCH /aws1/cx_r5vendpttmpyunavailex INTO DATA(lo_endpoint_ex).
" This endpoint is temporarily unavailable, try the next one
lo_exception = lo_endpoint_ex.
CONTINUE.
CATCH /aws1/cx_r5vaccessdeniedex
/aws1/cx_r5vconflictexception
/aws1/cx_r5vinternalserverex
/aws1/cx_r5vresourcenotfoundex
/aws1/cx_r5vthrottlingex
/aws1/cx_r5vvalidationex
/aws1/cx_rt_generic INTO lo_exception.
" For other errors, re-raise immediately
RAISE EXCEPTION lo_exception.
ENDTRY.
ENDLOOP.
" If we get here, all endpoints failed - re-raise the last exception
IF lo_exception IS BOUND.
RAISE EXCEPTION lo_exception.
ENDIF.
```
+ Pour plus de détails sur l'API, reportez-vous [UpdateRoutingControlState](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Exemples de code pour Audit Manager à l'aide de AWS SDKs
Les exemples de code suivants vous montrent comment utiliser AWS Audit Manager un kit de développement AWS logiciel (SDK).
Les *scénarios* sont des exemples de code qui vous montrent comment accomplir des tâches spécifiques en appelant plusieurs fonctions au sein d’un même service ou combinés à d’autres Services AWS.
**Ressources supplémentaires**
+ **[Guide de l’utilisateur Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html)** : plus d’informations sur Audit Manager.
+ **[Référence des API Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/APIReference/Welcome.html)** : détails sur toutes les actions Audit Manager disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23audit-mgr)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Scénarios](auditmanager_code_examples_scenarios.md)
+ [Création d'un framework personnalisé à partir d'un AWS Config pack de conformité](auditmanager_example_auditmanager_Scenario_CustomFrameworkFromConformancePack_section.md)
+ [Créez un framework personnalisé contenant les contrôles Security Hub CSPM](auditmanager_example_auditmanager_Scenario_CustomFrameworkFromSecurityHub_section.md)
+ [Création d’un rapport d’évaluation](auditmanager_example_auditmanager_Scenario_CreateAssessmentReport_section.md)
# Scénarios d'utilisation d'Audit Manager AWS SDKs
Les exemples de code suivants vous montrent comment implémenter des scénarios courants dans Audit Manager avec AWS SDKs. Ces scénarios vous montrent comment accomplir des tâches spécifiques en appelant plusieurs fonctions dans Audit Manager ou en les combinant avec d’autres Services AWS. Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code.
Les scénarios ciblent un niveau d’expérience intermédiaire pour vous aider à comprendre les actions de service dans leur contexte.
**Topics**
+ [Création d'un framework personnalisé à partir d'un AWS Config pack de conformité](auditmanager_example_auditmanager_Scenario_CustomFrameworkFromConformancePack_section.md)
+ [Créez un framework personnalisé contenant les contrôles Security Hub CSPM](auditmanager_example_auditmanager_Scenario_CustomFrameworkFromSecurityHub_section.md)
+ [Création d’un rapport d’évaluation](auditmanager_example_auditmanager_Scenario_CreateAssessmentReport_section.md)
# Créez un framework personnalisé Audit Manager à partir d'un pack de AWS Config conformité à l'aide d'un SDK AWS
L’exemple de code suivant illustre comment :
+ Obtenez une liste des packs de AWS Config conformité.
+ créer un contrôle personnalisé Audit Manager pour chaque règle gérée dans un pack de conformité ;
+ créer un cadre personnalisé Audit Manager contenant les contrôles.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auditmanager#code-examples).
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
class ConformancePack:
def __init__(self, config_client, auditmanager_client):
self.config_client = config_client
self.auditmanager_client = auditmanager_client
def get_conformance_pack(self):
"""
Return a selected conformance pack from the list of conformance packs.
:return: selected conformance pack
"""
try:
conformance_packs = self.config_client.describe_conformance_packs()
print(
"Number of conformance packs fetched: ",
len(conformance_packs.get("ConformancePackDetails")),
)
print("Fetched the following conformance packs: ")
all_cpack_names = {
cp["ConformancePackName"]
for cp in conformance_packs.get("ConformancePackDetails")
}
for pack in all_cpack_names:
print(f"\t{pack}")
cpack_name = input(
"Provide ConformancePackName that you want to create a custom "
"framework for: "
)
if cpack_name not in all_cpack_names:
print(f"{cpack_name} is not in the list of conformance packs!")
print(
"Provide a conformance pack name from the available list of "
"conformance packs."
)
raise Exception("Invalid conformance pack")
print("-" * 88)
except ClientError:
logger.exception("Couldn't select conformance pack.")
raise
else:
return cpack_name
def create_custom_controls(self, cpack_name):
"""
Create custom controls for all managed AWS Config rules in a conformance pack.
:param cpack_name: The name of the conformance pack to create controls for.
:return: The list of custom control IDs.
"""
try:
rules_in_pack = self.config_client.describe_conformance_pack_compliance(
ConformancePackName=cpack_name
)
print(
"Number of rules in the conformance pack: ",
len(rules_in_pack.get("ConformancePackRuleComplianceList")),
)
for rule in rules_in_pack.get("ConformancePackRuleComplianceList"):
print(f"\t{rule.get('ConfigRuleName')}")
print("-" * 88)
print(
"Creating a custom control for each rule and a custom framework "
"consisting of these rules in Audit Manager."
)
am_controls = []
for rule in rules_in_pack.get("ConformancePackRuleComplianceList"):
config_rule = self.config_client.describe_config_rules(
ConfigRuleNames=[rule.get("ConfigRuleName")]
)
source_id = (
config_rule.get("ConfigRules")[0]
.get("Source", {})
.get("SourceIdentifier")
)
custom_control = self.auditmanager_client.create_control(
name="Config-" + rule.get("ConfigRuleName"),
controlMappingSources=[
{
"sourceName": "ConfigRule",
"sourceSetUpOption": "System_Controls_Mapping",
"sourceType": "AWS_Config",
"sourceKeyword": {
"keywordInputType": "SELECT_FROM_LIST",
"keywordValue": source_id,
},
}
],
).get("control", {})
am_controls.append({"id": custom_control.get("id")})
print("Successfully created a control for each config rule.")
print("-" * 88)
except ClientError:
logger.exception("Failed to create custom controls.")
raise
else:
return am_controls
def create_custom_framework(self, cpack_name, am_control_ids):
"""
Create a custom Audit Manager framework from a selected AWS Config conformance
pack.
:param cpack_name: The name of the conformance pack to create a framework from.
:param am_control_ids: The IDs of the custom controls created from the
conformance pack.
"""
try:
print("Creating custom framework...")
custom_framework = self.auditmanager_client.create_assessment_framework(
name="Config-Conformance-pack-" + cpack_name,
controlSets=[{"name": cpack_name, "controls": am_control_ids}],
)
print(
f"Successfully created the custom framework: ",
f"{custom_framework.get('framework').get('name')}: ",
f"{custom_framework.get('framework').get('id')}",
)
print("-" * 88)
except ClientError:
logger.exception("Failed to create custom framework.")
raise
def run_demo():
print("-" * 88)
print("Welcome to the AWS Audit Manager custom framework demo!")
print("-" * 88)
print(
"You can use this sample to select a conformance pack from AWS Config and "
"use AWS Audit Manager to create a custom control for all the managed "
"rules under the conformance pack. A custom framework is also created "
"with these controls."
)
print("-" * 88)
conf_pack = ConformancePack(boto3.client("config"), boto3.client("auditmanager"))
cpack_name = conf_pack.get_conformance_pack()
am_controls = conf_pack.create_custom_controls(cpack_name)
conf_pack.create_custom_framework(cpack_name, am_controls)
if __name__ == "__main__":
run_demo()
```
+ Pour plus d’informations sur l’API, consultez les rubriques suivantes dans *AWS SDK for Python (Boto3) API Reference*.
+ [CreateAssessmentFramework](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateAssessmentFramework)
+ [CreateControl](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateControl)
------
# Créez un framework personnalisé Audit Manager contenant les contrôles Security Hub CSPM à l'aide d'un SDK AWS
L’exemple de code suivant illustre comment :
+ Obtenez une liste de tous les contrôles standard dont la source de données Security Hub CSPM est la source de données.
+ créer un cadre personnalisé Audit Manager contenant les contrôles.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auditmanager#code-examples).
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
class SecurityHub:
def __init__(self, auditmanager_client):
self.auditmanager_client = auditmanager_client
def get_sechub_controls(self):
"""
Gets the list of controls that use Security Hub as their data source.
:return: The list of Security Hub controls.
"""
print("-" * 88)
next_token = None
page = 1
sechub_control_list = []
while True:
print("Page [" + str(page) + "]")
if next_token is None:
control_list = self.auditmanager_client.list_controls(
controlType="Standard", maxResults=100
)
else:
control_list = self.auditmanager_client.list_controls(
controlType="Standard", nextToken=next_token, maxResults=100
)
print("Total controls found:", len(control_list.get("controlMetadataList")))
for control in control_list.get("controlMetadataList"):
control_details = self.auditmanager_client.get_control(
controlId=control.get("id")
).get("control", {})
if "AWS Security Hub" in control_details.get("controlSources"):
sechub_control_list.append({"id": control_details.get("id")})
next_token = control_list.get("nextToken")
if not next_token:
break
page += 1
print("Number of Security Hub controls found: ", len(sechub_control_list))
return sechub_control_list
def create_custom_framework(self, am_controls):
"""
Create a custom framework with a list of controls.
:param am_controls: The list of controls to include in the framework.
"""
try:
print("Creating custom framework...")
custom_framework = self.auditmanager_client.create_assessment_framework(
name="All Security Hub Controls Framework",
controlSets=[{"name": "Security-Hub", "controls": am_controls}],
)
print(
f"Successfully created the custom framework: "
f"{custom_framework.get('framework').get('name')}: "
f"{custom_framework.get('framework').get('id')}"
)
print("-" * 88)
except ClientError:
logger.exception("Failed to create custom framework.")
raise
def run_demo():
print("-" * 88)
print("Welcome to the AWS Audit Manager Security Hub demo!")
print("-" * 88)
print(" This script creates a custom framework with all Security Hub controls.")
print("-" * 88)
sechub = SecurityHub(boto3.client("auditmanager"))
am_controls = sechub.get_sechub_controls()
sechub.create_custom_framework(am_controls)
if __name__ == "__main__":
run_demo()
```
+ Pour plus d’informations sur l’API, consultez les rubriques suivantes dans *AWS SDK for Python (Boto3) API Reference*.
+ [CreateAssessmentFramework](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateAssessmentFramework)
+ [GetControl](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetControl)
+ [ListControls](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListControls)
------
# Créez un rapport d'évaluation d'Audit Manager contenant un jour de preuves à l'aide d'un AWS SDK
L’exemple de code suivant montre comment créer un rapport d’évaluation d’Audit Manager qui contient un jour de preuves.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auditmanager#code-examples).
```
import dateutil.parser
import logging
import time
import urllib.request
import uuid
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
class AuditReport:
def __init__(self, auditmanager_client):
self.auditmanager_client = auditmanager_client
def get_input(self):
print("-" * 40)
try:
assessment_id = input("Provide assessment id [uuid]: ").lower()
try:
assessment_uuid = uuid.UUID(assessment_id)
except ValueError:
logger.error("Assessment Id is not a valid UUID: %s", assessment_id)
raise
evidence_folder = input("Provide evidence date [yyyy-mm-dd]: ")
try:
evidence_date = dateutil.parser.parse(evidence_folder).date()
except ValueError:
logger.error("Invalid date : %s", evidence_folder)
raise
try:
self.auditmanager_client.get_assessment(
assessmentId=str(assessment_uuid)
)
except ClientError:
logger.exception("Couldn't get assessment %s.", assessment_uuid)
raise
except (ValueError, ClientError):
return None, None
else:
return assessment_uuid, evidence_date
def clear_staging(self, assessment_uuid, evidence_date):
"""
Find all the evidence in the report and clear it.
"""
next_token = None
page = 1
interested_folder_id_list = []
while True:
print(f"Page [{page}]")
if next_token is None:
folder_list = (
self.auditmanager_client.get_evidence_folders_by_assessment(
assessmentId=str(assessment_uuid), maxResults=1000
)
)
else:
folder_list = (
self.auditmanager_client.get_evidence_folders_by_assessment(
assessmentId=str(assessment_uuid),
nextToken=next_token,
maxResults=1000,
)
)
folders = folder_list.get("evidenceFolders")
print(f"Got {len(folders)} folders.")
for folder in folders:
folder_id = folder.get("id")
if folder.get("name") == str(evidence_date):
interested_folder_id_list.append(folder_id)
if folder.get("assessmentReportSelectionCount") == folder.get(
"totalEvidence"
):
print(
f"Removing folder from report selection : {folder.get('name')} "
f"{folder_id} {folder.get('controlId')}"
)
self.auditmanager_client.disassociate_assessment_report_evidence_folder(
assessmentId=str(assessment_uuid), evidenceFolderId=folder_id
)
elif folder.get("assessmentReportSelectionCount") > 0:
# Get all evidence in the folder and
# add selected evidence in the selected_evidence_list.
evidence_list = (
self.auditmanager_client.get_evidence_by_evidence_folder(
assessmentId=str(assessment_uuid),
controlSetId=folder_id,
evidenceFolderId=folder_id,
maxResults=1000,
)
)
selected_evidence_list = []
for evidence in evidence_list.get("evidence"):
if evidence.get("assessmentReportSelection") == "Yes":
selected_evidence_list.append(evidence.get("id"))
print(
f"Removing evidence report selection : {folder.get('name')} "
f"{len(selected_evidence_list)}"
)
self.auditmanager_client.batch_disassociate_assessment_report_evidence(
assessmentId=str(assessment_uuid),
evidenceFolderId=folder_id,
evidenceIds=selected_evidence_list,
)
next_token = folder_list.get("nextToken")
if not next_token:
break
page += 1
return interested_folder_id_list
def add_folder_to_staging(self, assessment_uuid, folder_id_list):
print(f"Adding folders to report : {folder_id_list}")
for folder in folder_id_list:
self.auditmanager_client.associate_assessment_report_evidence_folder(
assessmentId=str(assessment_uuid), evidenceFolderId=folder
)
def get_report(self, assessment_uuid):
report = self.auditmanager_client.create_assessment_report(
name="ReportViaScript",
description="testing",
assessmentId=str(assessment_uuid),
)
if self._is_report_generated(report.get("assessmentReport").get("id")):
report_url = self.auditmanager_client.get_assessment_report_url(
assessmentReportId=report.get("assessmentReport").get("id"),
assessmentId=str(assessment_uuid),
)
print(report_url.get("preSignedUrl"))
urllib.request.urlretrieve(
report_url.get("preSignedUrl").get("link"),
report_url.get("preSignedUrl").get("hyperlinkName"),
)
print(
f"Report saved as {report_url.get('preSignedUrl').get('hyperlinkName')}."
)
else:
print("Report generation did not finish in 15 minutes.")
print(
"Failed to download report. Go to the console and manually download "
"the report."
)
def _is_report_generated(self, assessment_report_id):
max_wait_time = 0
while max_wait_time < 900:
print(f"Checking status of the report {assessment_report_id}")
report_list = self.auditmanager_client.list_assessment_reports(maxResults=1)
if (
report_list.get("assessmentReports")[0].get("id")
== assessment_report_id
and report_list.get("assessmentReports")[0].get("status") == "COMPLETE"
):
return True
print("Sleeping for 5 seconds...")
time.sleep(5)
max_wait_time += 5
def run_demo():
print("-" * 88)
print("Welcome to the AWS Audit Manager samples demo!")
print("-" * 88)
print(
"This script creates an assessment report for an assessment with all the "
"evidence collected on the provided date."
)
print("-" * 88)
report = AuditReport(boto3.client("auditmanager"))
assessment_uuid, evidence_date = report.get_input()
if assessment_uuid is not None and evidence_date is not None:
folder_id_list = report.clear_staging(assessment_uuid, evidence_date)
report.add_folder_to_staging(assessment_uuid, folder_id_list)
report.get_report(assessment_uuid)
if __name__ == "__main__":
run_demo()
```
+ Pour plus d’informations sur l’API, consultez les rubriques suivantes dans *AWS SDK for Python (Boto3) API Reference*.
+ [AssociateAssessmentReportEvidenceFolder](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder)
+ [BatchDisassociateAssessmentReportEvidence](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence)
+ [CreateAssessmentReport](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateAssessmentReport)
+ [DisassociateAssessmentReportEvidenceFolder](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder)
+ [GetAssessment](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetAssessment)
+ [GetAssessmentReportUrl](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetAssessmentReportUrl)
+ [GetEvidenceByEvidenceFolder](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder)
+ [GetEvidenceFoldersByAssessment](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment)
+ [ListAssessmentReports](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListAssessmentReports)
------
# Exemples de code pour Aurora à l'aide d'Aurora AWS SDKs
Les exemples de code suivants vous montrent comment utiliser Amazon Aurora avec un kit de développement AWS logiciel (SDK).
Les *principes de base* sont des exemples de code qui vous montrent comment effectuer les opérations essentielles au sein d’un service.
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Les *scénarios* sont des exemples de code qui vous montrent comment accomplir des tâches spécifiques en appelant plusieurs fonctions au sein d’un même service ou combinés à d’autres Services AWS.
**Ressources supplémentaires**
+ **[Guide de l’utilisateur Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)** : plus d’informations sur Aurora.
+ **[Référence des API Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/Welcome.html)** : détails sur toutes les actions Aurora disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23aurora)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](aurora_code_examples_basics.md)
+ [Bonjour Aurora](aurora_example_aurora_Hello_section.md)
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
+ [Actions](aurora_code_examples_actions.md)
+ [`CreateDBCluster`](aurora_example_aurora_CreateDBCluster_section.md)
+ [`CreateDBClusterParameterGroup`](aurora_example_aurora_CreateDBClusterParameterGroup_section.md)
+ [`CreateDBClusterSnapshot`](aurora_example_aurora_CreateDBClusterSnapshot_section.md)
+ [`CreateDBInstance`](aurora_example_aurora_CreateDBInstance_section.md)
+ [`DeleteDBCluster`](aurora_example_aurora_DeleteDBCluster_section.md)
+ [`DeleteDBClusterParameterGroup`](aurora_example_aurora_DeleteDBClusterParameterGroup_section.md)
+ [`DeleteDBInstance`](aurora_example_aurora_DeleteDBInstance_section.md)
+ [`DescribeDBClusterParameterGroups`](aurora_example_aurora_DescribeDBClusterParameterGroups_section.md)
+ [`DescribeDBClusterParameters`](aurora_example_aurora_DescribeDBClusterParameters_section.md)
+ [`DescribeDBClusterSnapshots`](aurora_example_aurora_DescribeDBClusterSnapshots_section.md)
+ [`DescribeDBClusters`](aurora_example_aurora_DescribeDBClusters_section.md)
+ [`DescribeDBEngineVersions`](aurora_example_aurora_DescribeDBEngineVersions_section.md)
+ [`DescribeDBInstances`](aurora_example_aurora_DescribeDBInstances_section.md)
+ [`DescribeOrderableDBInstanceOptions`](aurora_example_aurora_DescribeOrderableDBInstanceOptions_section.md)
+ [`ModifyDBClusterParameterGroup`](aurora_example_aurora_ModifyDBClusterParameterGroup_section.md)
+ [Scénarios](aurora_code_examples_scenarios.md)
+ [Créer une API REST de bibliothèque de prêt](aurora_example_cross_AuroraRestLendingLibrary_section.md)
+ [Créer un outil de suivi des éléments de travail sans serveur Aurora](aurora_example_cross_RDSDataTracker_section.md)
# Exemples de base pour l'utilisation d'Aurora AWS SDKs
Les exemples de code suivants montrent comment utiliser les bases d'Amazon Aurora avec AWS SDKs.
**Contents**
+ [Bonjour Aurora](aurora_example_aurora_Hello_section.md)
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
+ [Actions](aurora_code_examples_actions.md)
+ [`CreateDBCluster`](aurora_example_aurora_CreateDBCluster_section.md)
+ [`CreateDBClusterParameterGroup`](aurora_example_aurora_CreateDBClusterParameterGroup_section.md)
+ [`CreateDBClusterSnapshot`](aurora_example_aurora_CreateDBClusterSnapshot_section.md)
+ [`CreateDBInstance`](aurora_example_aurora_CreateDBInstance_section.md)
+ [`DeleteDBCluster`](aurora_example_aurora_DeleteDBCluster_section.md)
+ [`DeleteDBClusterParameterGroup`](aurora_example_aurora_DeleteDBClusterParameterGroup_section.md)
+ [`DeleteDBInstance`](aurora_example_aurora_DeleteDBInstance_section.md)
+ [`DescribeDBClusterParameterGroups`](aurora_example_aurora_DescribeDBClusterParameterGroups_section.md)
+ [`DescribeDBClusterParameters`](aurora_example_aurora_DescribeDBClusterParameters_section.md)
+ [`DescribeDBClusterSnapshots`](aurora_example_aurora_DescribeDBClusterSnapshots_section.md)
+ [`DescribeDBClusters`](aurora_example_aurora_DescribeDBClusters_section.md)
+ [`DescribeDBEngineVersions`](aurora_example_aurora_DescribeDBEngineVersions_section.md)
+ [`DescribeDBInstances`](aurora_example_aurora_DescribeDBInstances_section.md)
+ [`DescribeOrderableDBInstanceOptions`](aurora_example_aurora_DescribeOrderableDBInstanceOptions_section.md)
+ [`ModifyDBClusterParameterGroup`](aurora_example_aurora_ModifyDBClusterParameterGroup_section.md)
# Bonjour Aurora
Les exemples de code suivants montrent comment bien démarrer avec Aurora.
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
using Amazon.RDS;
using Amazon.RDS.Model;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
namespace AuroraActions;
public static class HelloAurora
{
static async Task Main(string[] args)
{
// Use the AWS .NET Core Setup package to set up dependency injection for the
// Amazon Relational Database Service (Amazon RDS).
// Use your AWS profile name, or leave it blank to use the default profile.
using var host = Host.CreateDefaultBuilder(args)
.ConfigureServices((_, services) =>
services.AddAWSService()
).Build();
// Now the client is available for injection. Fetching it directly here for example purposes only.
var rdsClient = host.Services.GetRequiredService();
// You can use await and any of the async methods to get a response.
var response = await rdsClient.DescribeDBClustersAsync(new DescribeDBClustersRequest { IncludeShared = true });
Console.WriteLine($"Hello Amazon RDS Aurora! Let's list some clusters in this account:");
if (response.DBClusters == null)
{
Console.WriteLine($"\tNo clusters found.");
}
else
{
foreach (var cluster in response.DBClusters)
{
Console.WriteLine(
$"\tCluster: database: {cluster.DatabaseName} identifier: {cluster.DBClusterIdentifier}.");
}
}
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora/hello_aurora#code-examples).
Code du CMake fichier CMake Lists.txt.
```
# Set the minimum required version of CMake for this project.
cmake_minimum_required(VERSION 3.13)
# Set the AWS service components used by this project.
set(SERVICE_COMPONENTS rds)
# Set this project's name.
project("hello_aurora")
# Set the C++ standard to use to build this target.
# At least C++ 11 is required for the AWS SDK for C++.
set(CMAKE_CXX_STANDARD 11)
# Use the MSVC variable to determine if this is a Windows build.
set(WINDOWS_BUILD ${MSVC})
if (WINDOWS_BUILD) # Set the location where CMake can find the installed libraries for the AWS SDK.
string(REPLACE ";" "/aws-cpp-sdk-all;" SYSTEM_MODULE_PATH "${CMAKE_SYSTEM_PREFIX_PATH}/aws-cpp-sdk-all")
list(APPEND CMAKE_PREFIX_PATH ${SYSTEM_MODULE_PATH})
endif ()
# Find the AWS SDK for C++ package.
find_package(AWSSDK REQUIRED COMPONENTS ${SERVICE_COMPONENTS})
if (WINDOWS_BUILD AND AWSSDK_INSTALL_AS_SHARED_LIBS)
# Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
# set(BIN_SUB_DIR "/Debug") # If you are building from the command line, you may need to uncomment this
# and set the proper subdirectory to the executables' location.
AWSSDK_CPY_DYN_LIBS(SERVICE_COMPONENTS "" ${CMAKE_CURRENT_BINARY_DIR}${BIN_SUB_DIR})
endif ()
add_executable(${PROJECT_NAME}
hello_aurora.cpp)
target_link_libraries(${PROJECT_NAME}
${AWSSDK_LINK_LIBRARIES})
```
Code pour le fichier source hello\$1aurora.cpp.
```
#include
#include
#include
#include
/*
* A "Hello Aurora" starter application which initializes an Amazon Relational Database Service (Amazon RDS) client
* and describes the Amazon Aurora (Aurora) clusters.
*
* main function
*
* Usage: 'hello_aurora'
*
*/
int main(int argc, char **argv) {
Aws::SDKOptions options;
// Optionally change the log level for debugging.
// options.loggingOptions.logLevel = Utils::Logging::LogLevel::Debug;
Aws::InitAPI(options); // Should only be called once.
int result = 0;
{
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient rdsClient(clientConfig);
Aws::String marker; // Used for pagination.
std::vector clusterIds;
do {
Aws::RDS::Model::DescribeDBClustersRequest request;
Aws::RDS::Model::DescribeDBClustersOutcome outcome =
rdsClient.DescribeDBClusters(request);
if (outcome.IsSuccess()) {
for (auto &cluster: outcome.GetResult().GetDBClusters()) {
clusterIds.push_back(cluster.GetDBClusterIdentifier());
}
marker = outcome.GetResult().GetMarker();
} else {
result = 1;
std::cerr << "Error with Aurora::GDescribeDBClusters. "
<< outcome.GetError().GetMessage()
<< std::endl;
break;
}
} while (!marker.empty());
std::cout << clusterIds.size() << " Aurora clusters found." << std::endl;
for (auto &clusterId: clusterIds) {
std::cout << " clusterId " << clusterId << std::endl;
}
}
Aws::ShutdownAPI(options); // Should only be called once.
return 0;
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
package main
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/config"
"github.com/aws/aws-sdk-go-v2/service/rds"
)
// main uses the AWS SDK for Go V2 to create an Amazon Aurora client and list up to 20
// DB clusters in your account.
// This example uses the default settings specified in your shared credentials
// and config files.
func main() {
ctx := context.Background()
sdkConfig, err := config.LoadDefaultConfig(ctx)
if err != nil {
fmt.Println("Couldn't load default configuration. Have you set up your AWS account?")
fmt.Println(err)
return
}
auroraClient := rds.NewFromConfig(sdkConfig)
const maxClusters = 20
fmt.Printf("Let's list up to %v DB clusters.\n", maxClusters)
output, err := auroraClient.DescribeDBClusters(
ctx, &rds.DescribeDBClustersInput{MaxRecords: aws.Int32(maxClusters)})
if err != nil {
fmt.Printf("Couldn't list DB clusters: %v\n", err)
return
}
if len(output.DBClusters) == 0 {
fmt.Println("No DB clusters found.")
} else {
for _, cluster := range output.DBClusters {
fmt.Printf("DB cluster %v has database %v.\n", *cluster.DBClusterIdentifier,
*cluster.DatabaseName)
}
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusters) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.rds.RdsClient;
import software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable;
public class DescribeDbClusters {
public static void main(String[] args) {
Region region = Region.US_EAST_1;
RdsClient rdsClient = RdsClient.builder()
.region(region)
.build();
describeClusters(rdsClient);
rdsClient.close();
}
public static void describeClusters(RdsClient rdsClient) {
DescribeDBClustersIterable clustersIterable = rdsClient.describeDBClustersPaginator();
clustersIterable.stream()
.flatMap(r -> r.dbClusters().stream())
.forEach(cluster -> System.out
.println("Database name: " + cluster.databaseName() + " Arn = " + cluster.dbClusterArn()));
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
import boto3
# Create an RDS client
rds = boto3.client("rds")
# Create a paginator for the describe_db_clusters operation
paginator = rds.get_paginator("describe_db_clusters")
# Use the paginator to get a list of DB clusters
response_iterator = paginator.paginate(
PaginationConfig={
"PageSize": 50, # Adjust PageSize as needed
"StartingToken": None,
}
)
# Iterate through the pages of the response
clusters_found = False
for page in response_iterator:
if "DBClusters" in page and page["DBClusters"]:
clusters_found = True
print("Here are your RDS Aurora clusters:")
for cluster in page["DBClusters"]:
print(
f"Cluster ID: {cluster['DBClusterIdentifier']}, Engine: {cluster['Engine']}"
)
if not clusters_found:
print("No clusters found!")
```
+ Pour plus de détails sur l'API, voir [AWS Describe DBClusters](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusters) *in SDK for Python (Boto3) API Reference*.
------
#### [ Ruby ]
**Kit SDK pour Ruby**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/aurora#code-examples).
```
require 'aws-sdk-rds'
# Creates an Amazon RDS client for the AWS Region
rds = Aws::RDS::Client.new
puts 'Listing clusters in this AWS account...'
# Calls the describe_db_clusters method to get information about clusters
resp = rds.describe_db_clusters(max_records: 20)
# Checks if any clusters are found and prints the appropriate message
if resp.db_clusters.empty?
puts 'No clusters found!'
else
# Loops through the array of cluster objects and prints the cluster identifier
resp.db_clusters.each do |cluster|
puts "Cluster identifier: #{cluster.db_cluster_identifier}"
end
end
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK pour Ruby API*.
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
use aws_sdk_rds::Client;
#[derive(Debug)]
struct Error(String);
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}
impl std::error::Error for Error {}
#[tokio::main]
async fn main() -> Result<(), Error> {
tracing_subscriber::fmt::init();
let sdk_config = aws_config::from_env().load().await;
let client = Client::new(&sdk_config);
let describe_db_clusters_output = client
.describe_db_clusters()
.send()
.await
.map_err(|e| Error(e.to_string()))?;
println!(
"Found {} clusters:",
describe_db_clusters_output.db_clusters().len()
);
for cluster in describe_db_clusters_output.db_clusters() {
let name = cluster.database_name().unwrap_or("Unknown");
let engine = cluster.engine().unwrap_or("Unknown");
let id = cluster.db_cluster_identifier().unwrap_or("Unknown");
let class = cluster.db_cluster_instance_class().unwrap_or("Unknown");
println!("\tDatabase: {name}",);
println!("\t Engine: {engine}",);
println!("\t ID: {id}",);
println!("\tInstance: {class}",);
}
Ok(())
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBClusters](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_clusters) dans le *AWS SDK pour la référence de l'API Rust*.
------
# Découvrez les bases d'Aurora avec un AWS SDK
Les exemples de code suivants montrent comment :
+ Créez un groupe de paramètres pour le cluster de bases de données Aurora personnalisé et définissez des valeurs pour les paramètres.
+ Créez un cluster de bases de données qui utilise le groupe de paramètres.
+ Créez une instance de base de données qui contient une base de données.
+ Prenez un instantané du cluster de bases de données, puis nettoyez les ressources.
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
Exécutez un scénario interactif à une invite de commande.
```
using Amazon.RDS;
using Amazon.RDS.Model;
using AuroraActions;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Console;
using Microsoft.Extensions.Logging.Debug;
namespace AuroraScenario;
///
/// Scenario for Amazon Aurora examples.
///
public class AuroraScenario
{
/*
Before running this .NET code example, set up your development environment, including your credentials.
This .NET example performs the following tasks:
1. Return a list of the available DB engine families for Aurora MySql using the DescribeDBEngineVersionsAsync method.
2. Select an engine family and create a custom DB cluster parameter group using the CreateDBClusterParameterGroupAsync method.
3. Get the parameter group using the DescribeDBClusterParameterGroupsAsync method.
4. Get some parameters in the group using the DescribeDBClusterParametersAsync method.
5. Parse and display some parameters in the group.
6. Modify the auto_increment_offset and auto_increment_increment parameters
using the ModifyDBClusterParameterGroupAsync method.
7. Get and display the updated parameters using the DescribeDBClusterParametersAsync method with a source of "user".
8. Get a list of allowed engine versions using the DescribeDBEngineVersionsAsync method.
9. Create an Aurora DB cluster that contains a MySql database and uses the parameter group.
using the CreateDBClusterAsync method.
10. Wait for the DB cluster to be ready using the DescribeDBClustersAsync method.
11. Display and select from a list of instance classes available for the selected engine and version
using the paginated DescribeOrderableDBInstanceOptions method.
12. Create a database instance in the cluster using the CreateDBInstanceAsync method.
13. Wait for the DB instance to be ready using the DescribeDBInstances method.
14. Display the connection endpoint string for the new DB cluster.
15. Create a snapshot of the DB cluster using the CreateDBClusterSnapshotAsync method.
16. Wait for DB snapshot to be ready using the DescribeDBClusterSnapshotsAsync method.
17. Delete the DB instance using the DeleteDBInstanceAsync method.
18. Delete the DB cluster using the DeleteDBClusterAsync method.
19. Wait for DB cluster to be deleted using the DescribeDBClustersAsync methods.
20. Delete the cluster parameter group using the DeleteDBClusterParameterGroupAsync.
*/
private static readonly string sepBar = new('-', 80);
private static AuroraWrapper auroraWrapper = null!;
private static ILogger logger = null!;
private static readonly string engine = "aurora-mysql";
static async Task Main(string[] args)
{
// Set up dependency injection for the Amazon Relational Database Service (Amazon RDS).
using var host = Host.CreateDefaultBuilder(args)
.ConfigureLogging(logging =>
logging.AddFilter("System", LogLevel.Debug)
.AddFilter("Microsoft", LogLevel.Information)
.AddFilter("Microsoft", LogLevel.Trace))
.ConfigureServices((_, services) =>
services.AddAWSService()
.AddTransient()
)
.Build();
logger = LoggerFactory.Create(builder =>
{
builder.AddConsole();
}).CreateLogger();
auroraWrapper = host.Services.GetRequiredService();
Console.WriteLine(sepBar);
Console.WriteLine(
"Welcome to the Amazon Aurora: get started with DB clusters example.");
Console.WriteLine(sepBar);
DBClusterParameterGroup parameterGroup = null!;
DBCluster? newCluster = null;
DBInstance? newInstance = null;
try
{
var parameterGroupFamily = await ChooseParameterGroupFamilyAsync();
parameterGroup = await CreateDBParameterGroupAsync(parameterGroupFamily);
var parameters = await DescribeParametersInGroupAsync(parameterGroup.DBClusterParameterGroupName,
new List { "auto_increment_offset", "auto_increment_increment" });
await ModifyParametersAsync(parameterGroup.DBClusterParameterGroupName, parameters);
await DescribeUserSourceParameters(parameterGroup.DBClusterParameterGroupName);
var engineVersionChoice = await ChooseDBEngineVersionAsync(parameterGroupFamily);
var newClusterIdentifier = "Example-Cluster-" + DateTime.Now.Ticks;
newCluster = await CreateNewCluster
(
parameterGroup,
engine,
engineVersionChoice.EngineVersion,
newClusterIdentifier
);
var instanceClassChoice = await ChooseDBInstanceClass(engine, engineVersionChoice.EngineVersion);
var newInstanceIdentifier = "Example-Instance-" + DateTime.Now.Ticks;
newInstance = await CreateNewInstance(
newClusterIdentifier,
engine,
engineVersionChoice.EngineVersion,
instanceClassChoice.DBInstanceClass,
newInstanceIdentifier
);
DisplayConnectionString(newCluster!);
await CreateSnapshot(newCluster!);
await CleanupResources(newInstance, newCluster, parameterGroup);
Console.WriteLine("Scenario complete.");
Console.WriteLine(sepBar);
}
catch (Exception ex)
{
await CleanupResources(newInstance, newCluster, parameterGroup);
logger.LogError(ex, "There was a problem executing the scenario.");
}
}
///
/// Choose the Aurora DB parameter group family from a list of available options.
///
/// The selected parameter group family.
public static async Task ChooseParameterGroupFamilyAsync()
{
Console.WriteLine(sepBar);
// 1. Get a list of available engines.
var engines = await auroraWrapper.DescribeDBEngineVersionsForEngineAsync(engine);
Console.WriteLine($"1. The following is a list of available DB parameter group families for engine {engine}:");
var parameterGroupFamilies =
engines.GroupBy(e => e.DBParameterGroupFamily).ToList();
for (var i = 1; i <= parameterGroupFamilies.Count; i++)
{
var parameterGroupFamily = parameterGroupFamilies[i - 1];
// List the available parameter group families.
Console.WriteLine(
$"\t{i}. Family: {parameterGroupFamily.Key}");
}
var choiceNumber = 0;
while (choiceNumber < 1 || choiceNumber > parameterGroupFamilies.Count)
{
Console.WriteLine("2. Select an available DB parameter group family by entering a number from the preceding list:");
var choice = Console.ReadLine();
Int32.TryParse(choice, out choiceNumber);
}
var parameterGroupFamilyChoice = parameterGroupFamilies[choiceNumber - 1];
Console.WriteLine(sepBar);
return parameterGroupFamilyChoice.Key;
}
///
/// Create and get information on a DB parameter group.
///
/// The DBParameterGroupFamily for the new DB parameter group.
/// The new DBParameterGroup.
public static async Task CreateDBParameterGroupAsync(string dbParameterGroupFamily)
{
Console.WriteLine(sepBar);
Console.WriteLine($"2. Create new DB parameter group with family {dbParameterGroupFamily}:");
var parameterGroup = await auroraWrapper.CreateCustomClusterParameterGroupAsync(
dbParameterGroupFamily,
"ExampleParameterGroup-" + DateTime.Now.Ticks,
"New example parameter group");
var groupInfo =
await auroraWrapper.DescribeCustomDBClusterParameterGroupAsync(parameterGroup.DBClusterParameterGroupName);
Console.WriteLine(
$"3. New DB parameter group created: \n\t{groupInfo?.Description}, \n\tARN {groupInfo?.DBClusterParameterGroupName}");
Console.WriteLine(sepBar);
return parameterGroup;
}
///
/// Get and describe parameters from a DBParameterGroup.
///
/// The name of the DBParameterGroup.
/// Optional specific names of parameters to describe.
/// The list of requested parameters.
public static async Task> DescribeParametersInGroupAsync(string parameterGroupName, List? parameterNames = null)
{
Console.WriteLine(sepBar);
Console.WriteLine("4. Get some parameters from the group.");
Console.WriteLine(sepBar);
var parameters =
await auroraWrapper.DescribeDBClusterParametersInGroupAsync(parameterGroupName);
var matchingParameters =
parameters.Where(p => parameterNames == null || parameterNames.Contains(p.ParameterName)).ToList();
Console.WriteLine("5. Parameter information:");
matchingParameters.ForEach(p =>
Console.WriteLine(
$"\n\tParameter: {p.ParameterName}." +
$"\n\tDescription: {p.Description}." +
$"\n\tAllowed Values: {p.AllowedValues}." +
$"\n\tValue: {p.ParameterValue}."));
Console.WriteLine(sepBar);
return matchingParameters;
}
///
/// Modify a parameter from a DBParameterGroup.
///
/// Name of the DBParameterGroup.
/// The parameters to modify.
/// Async task.
public static async Task ModifyParametersAsync(string parameterGroupName, List parameters)
{
Console.WriteLine(sepBar);
Console.WriteLine("6. Modify some parameters in the group.");
await auroraWrapper.ModifyIntegerParametersInGroupAsync(parameterGroupName, parameters);
Console.WriteLine(sepBar);
}
///
/// Describe the user source parameters in the group.
///
/// The name of the DBParameterGroup.
/// Async task.
public static async Task DescribeUserSourceParameters(string parameterGroupName)
{
Console.WriteLine(sepBar);
Console.WriteLine("7. Describe updated user source parameters in the group.");
var parameters =
await auroraWrapper.DescribeDBClusterParametersInGroupAsync(parameterGroupName, "user");
parameters.ForEach(p =>
Console.WriteLine(
$"\n\tParameter: {p.ParameterName}." +
$"\n\tDescription: {p.Description}." +
$"\n\tAllowed Values: {p.AllowedValues}." +
$"\n\tValue: {p.ParameterValue}."));
Console.WriteLine(sepBar);
}
///
/// Choose a DB engine version.
///
/// DB parameter group family for engine choice.
/// The selected engine version.
public static async Task ChooseDBEngineVersionAsync(string dbParameterGroupFamily)
{
Console.WriteLine(sepBar);
// Get a list of allowed engines.
var allowedEngines =
await auroraWrapper.DescribeDBEngineVersionsForEngineAsync(engine, dbParameterGroupFamily);
Console.WriteLine($"Available DB engine versions for parameter group family {dbParameterGroupFamily}:");
int i = 1;
foreach (var version in allowedEngines)
{
Console.WriteLine(
$"\t{i}. {version.DBEngineVersionDescription}.");
i++;
}
var choiceNumber = 0;
while (choiceNumber < 1 || choiceNumber > allowedEngines.Count)
{
Console.WriteLine("8. Select an available DB engine version by entering a number from the list above:");
var choice = Console.ReadLine();
Int32.TryParse(choice, out choiceNumber);
}
var engineChoice = allowedEngines[choiceNumber - 1];
Console.WriteLine(sepBar);
return engineChoice;
}
///
/// Create a new RDS DB cluster.
///
/// Parameter group to use for the DB cluster.
/// Engine to use for the DB cluster.
/// Engine version to use for the DB cluster.
/// Cluster identifier to use for the DB cluster.
/// The new DB cluster.
public static async Task CreateNewCluster(DBClusterParameterGroup parameterGroup,
string engineName, string engineVersion, string clusterIdentifier)
{
Console.WriteLine(sepBar);
Console.WriteLine($"9. Create a new DB cluster with identifier {clusterIdentifier}.");
DBCluster newCluster;
var clusters = await auroraWrapper.DescribeDBClustersPagedAsync();
var isClusterCreated = clusters.Any(i => i.DBClusterIdentifier == clusterIdentifier);
if (isClusterCreated)
{
Console.WriteLine("Cluster already created.");
newCluster = clusters.First(i => i.DBClusterIdentifier == clusterIdentifier);
}
else
{
Console.WriteLine("Enter an admin username:");
var username = Console.ReadLine();
Console.WriteLine("Enter an admin password:");
var password = Console.ReadLine();
newCluster = await auroraWrapper.CreateDBClusterWithAdminAsync(
"ExampleDatabase",
clusterIdentifier,
parameterGroup.DBClusterParameterGroupName,
engineName,
engineVersion,
username!,
password!
);
Console.WriteLine("10. Waiting for DB cluster to be ready...");
while (newCluster.Status != "available")
{
Console.Write(".");
Thread.Sleep(5000);
clusters = await auroraWrapper.DescribeDBClustersPagedAsync(clusterIdentifier);
newCluster = clusters.First();
}
}
Console.WriteLine(sepBar);
return newCluster;
}
///
/// Choose a DB instance class for a particular engine and engine version.
///
/// DB engine for DB instance choice.
/// DB engine version for DB instance choice.
/// The selected orderable DB instance option.
public static async Task ChooseDBInstanceClass(string engine, string engineVersion)
{
Console.WriteLine(sepBar);
// Get a list of allowed DB instance classes.
var allowedInstances =
await auroraWrapper.DescribeOrderableDBInstanceOptionsPagedAsync(engine, engineVersion);
Console.WriteLine($"Available DB instance classes for engine {engine} and version {engineVersion}:");
int i = 1;
foreach (var instance in allowedInstances)
{
Console.WriteLine(
$"\t{i}. Instance class: {instance.DBInstanceClass} (storage type {instance.StorageType})");
i++;
}
var choiceNumber = 0;
while (choiceNumber < 1 || choiceNumber > allowedInstances.Count)
{
Console.WriteLine("11. Select an available DB instance class by entering a number from the preceding list:");
var choice = Console.ReadLine();
Int32.TryParse(choice, out choiceNumber);
}
var instanceChoice = allowedInstances[choiceNumber - 1];
Console.WriteLine(sepBar);
return instanceChoice;
}
///
/// Create a new DB instance.
///
/// Engine to use for the DB instance.
/// Engine version to use for the DB instance.
/// Instance class to use for the DB instance.
/// Instance identifier to use for the DB instance.
/// The new DB instance.
public static async Task CreateNewInstance(
string clusterIdentifier,
string engineName,
string engineVersion,
string instanceClass,
string instanceIdentifier)
{
Console.WriteLine(sepBar);
Console.WriteLine($"12. Create a new DB instance with identifier {instanceIdentifier}.");
bool isInstanceReady = false;
DBInstance newInstance;
var instances = await auroraWrapper.DescribeDBInstancesPagedAsync();
isInstanceReady = instances.FirstOrDefault(i =>
i.DBInstanceIdentifier == instanceIdentifier)?.DBInstanceStatus == "available";
if (isInstanceReady)
{
Console.WriteLine("Instance already created.");
newInstance = instances.First(i => i.DBInstanceIdentifier == instanceIdentifier);
}
else
{
newInstance = await auroraWrapper.CreateDBInstanceInClusterAsync(
clusterIdentifier,
instanceIdentifier,
engineName,
engineVersion,
instanceClass
);
Console.WriteLine("13. Waiting for DB instance to be ready...");
while (!isInstanceReady)
{
Console.Write(".");
Thread.Sleep(5000);
instances = await auroraWrapper.DescribeDBInstancesPagedAsync(instanceIdentifier);
isInstanceReady = instances.FirstOrDefault()?.DBInstanceStatus == "available";
newInstance = instances.First();
}
}
Console.WriteLine(sepBar);
return newInstance;
}
///
/// Display a connection string for an Amazon RDS DB cluster.
///
/// The DB cluster to use to get a connection string.
public static void DisplayConnectionString(DBCluster cluster)
{
Console.WriteLine(sepBar);
// Display the connection string.
Console.WriteLine("14. New DB cluster connection string: ");
Console.WriteLine(
$"\n{engine} -h {cluster.Endpoint} -P {cluster.Port} "
+ $"-u {cluster.MasterUsername} -p [YOUR PASSWORD]\n");
Console.WriteLine(sepBar);
}
///
/// Create a snapshot from an Amazon RDS DB cluster.
///
/// DB cluster to use when creating a snapshot.
/// The snapshot object.
public static async Task CreateSnapshot(DBCluster cluster)
{
Console.WriteLine(sepBar);
// Create a snapshot.
Console.WriteLine($"15. Creating snapshot from DB cluster {cluster.DBClusterIdentifier}.");
var snapshot = await auroraWrapper.CreateClusterSnapshotByIdentifierAsync(
cluster.DBClusterIdentifier,
"ExampleSnapshot-" + DateTime.Now.Ticks);
// Wait for the snapshot to be available.
bool isSnapshotReady = false;
Console.WriteLine($"16. Waiting for snapshot to be ready...");
while (!isSnapshotReady)
{
Console.Write(".");
Thread.Sleep(5000);
var snapshots =
await auroraWrapper.DescribeDBClusterSnapshotsByIdentifierAsync(cluster.DBClusterIdentifier);
isSnapshotReady = snapshots.FirstOrDefault()?.Status == "available";
snapshot = snapshots.First();
}
Console.WriteLine(
$"Snapshot {snapshot.DBClusterSnapshotIdentifier} status is {snapshot.Status}.");
Console.WriteLine(sepBar);
return snapshot;
}
///
/// Clean up resources from the scenario.
///
/// The instance to clean up.
/// The cluster to clean up.
/// The parameter group to clean up.
/// Async Task.
private static async Task CleanupResources(
DBInstance? newInstance,
DBCluster? newCluster,
DBClusterParameterGroup? parameterGroup)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"Clean up resources.");
if (newInstance is not null && GetYesNoResponse($"\tClean up instance {newInstance.DBInstanceIdentifier}? (y/n)"))
{
// Delete the DB instance.
Console.WriteLine($"17. Deleting the DB instance {newInstance.DBInstanceIdentifier}.");
await auroraWrapper.DeleteDBInstanceByIdentifierAsync(newInstance.DBInstanceIdentifier);
}
if (newCluster is not null && GetYesNoResponse($"\tClean up cluster {newCluster.DBClusterIdentifier}? (y/n)"))
{
// Delete the DB cluster.
Console.WriteLine($"18. Deleting the DB cluster {newCluster.DBClusterIdentifier}.");
await auroraWrapper.DeleteDBClusterByIdentifierAsync(newCluster.DBClusterIdentifier);
// Wait for the DB cluster to delete.
Console.WriteLine($"19. Waiting for the DB cluster to delete...");
bool isClusterDeleted = false;
while (!isClusterDeleted)
{
Console.Write(".");
Thread.Sleep(5000);
var cluster = await auroraWrapper.DescribeDBClustersPagedAsync();
isClusterDeleted = cluster.All(i => i.DBClusterIdentifier != newCluster.DBClusterIdentifier);
}
Console.WriteLine("DB cluster deleted.");
}
if (parameterGroup is not null && GetYesNoResponse($"\tClean up parameter group? (y/n)"))
{
Console.WriteLine($"20. Deleting the DB parameter group {parameterGroup.DBClusterParameterGroupName}.");
await auroraWrapper.DeleteClusterParameterGroupByNameAsync(parameterGroup.DBClusterParameterGroupName);
Console.WriteLine("Parameter group deleted.");
}
Console.WriteLine(new string('-', 80));
}
///
/// Get a yes or no response from the user.
///
/// The question string to print on the console.
/// True if the user responds with a yes.
private static bool GetYesNoResponse(string question)
{
Console.WriteLine(question);
var ynResponse = Console.ReadLine();
var response = ynResponse != null &&
ynResponse.Equals("y",
StringComparison.InvariantCultureIgnoreCase);
return response;
}
```
Méthodes d’encapsulation appelées par le scénario pour gérer les actions Aurora.
```
using Amazon.RDS;
using Amazon.RDS.Model;
namespace AuroraActions;
///
/// Wrapper for the Amazon Aurora cluster client operations.
///
public class AuroraWrapper
{
private readonly IAmazonRDS _amazonRDS;
public AuroraWrapper(IAmazonRDS amazonRDS)
{
_amazonRDS = amazonRDS;
}
///
/// Get a list of DB engine versions for a particular DB engine.
///
/// The name of the engine.
/// Optional parameter group family name.
/// A list of DBEngineVersions.
public async Task> DescribeDBEngineVersionsForEngineAsync(string engine,
string? parameterGroupFamily = null)
{
var response = await _amazonRDS.DescribeDBEngineVersionsAsync(
new DescribeDBEngineVersionsRequest()
{
Engine = engine,
DBParameterGroupFamily = parameterGroupFamily
});
return response.DBEngineVersions;
}
///
/// Create a custom cluster parameter group.
///
/// The family of the parameter group.
/// The name for the new parameter group.
/// A description for the new parameter group.
/// The new parameter group object.
public async Task CreateCustomClusterParameterGroupAsync(
string parameterGroupFamily,
string groupName,
string description)
{
var request = new CreateDBClusterParameterGroupRequest
{
DBParameterGroupFamily = parameterGroupFamily,
DBClusterParameterGroupName = groupName,
Description = description,
};
var response = await _amazonRDS.CreateDBClusterParameterGroupAsync(request);
return response.DBClusterParameterGroup;
}
///
/// Describe the cluster parameters in a parameter group.
///
/// The name of the parameter group.
/// The optional name of the source filter.
/// The collection of parameters.
public async Task> DescribeDBClusterParametersInGroupAsync(string groupName, string? source = null)
{
var paramList = new List();
DescribeDBClusterParametersResponse response;
var request = new DescribeDBClusterParametersRequest
{
DBClusterParameterGroupName = groupName,
Source = source,
};
// Get the full list if there are multiple pages.
do
{
response = await _amazonRDS.DescribeDBClusterParametersAsync(request);
paramList.AddRange(response.Parameters);
request.Marker = response.Marker;
}
while (response.Marker is not null);
return paramList;
}
///
/// Get the description of a DB cluster parameter group by name.
///
/// The name of the DB parameter group to describe.
/// The parameter group description.
public async Task DescribeCustomDBClusterParameterGroupAsync(string name)
{
var response = await _amazonRDS.DescribeDBClusterParameterGroupsAsync(
new DescribeDBClusterParameterGroupsRequest()
{
DBClusterParameterGroupName = name
});
return response.DBClusterParameterGroups.FirstOrDefault();
}
///
/// Modify the specified integer parameters with new values from user input.
///
/// The group name for the parameters.
/// The list of integer parameters to modify.
/// Optional int value to set for parameters.
/// The name of the group that was modified.
public async Task ModifyIntegerParametersInGroupAsync(string groupName, List parameters, int newValue = 0)
{
foreach (var p in parameters)
{
if (p.IsModifiable.GetValueOrDefault() && p.DataType == "integer")
{
while (newValue == 0)
{
Console.WriteLine(
$"Enter a new value for {p.ParameterName} from the allowed values {p.AllowedValues} ");
var choice = Console.ReadLine();
int.TryParse(choice, out newValue);
}
p.ParameterValue = newValue.ToString();
}
}
var request = new ModifyDBClusterParameterGroupRequest
{
Parameters = parameters,
DBClusterParameterGroupName = groupName,
};
var result = await _amazonRDS.ModifyDBClusterParameterGroupAsync(request);
return result.DBClusterParameterGroupName;
}
///
/// Get a list of orderable DB instance options for a specific
/// engine and engine version.
///
/// Name of the engine.
/// Version of the engine.
/// List of OrderableDBInstanceOptions.
public async Task> DescribeOrderableDBInstanceOptionsPagedAsync(string engine, string engineVersion)
{
// Use a paginator to get a list of DB instance options.
var results = new List();
var paginateInstanceOptions = _amazonRDS.Paginators.DescribeOrderableDBInstanceOptions(
new DescribeOrderableDBInstanceOptionsRequest()
{
Engine = engine,
EngineVersion = engineVersion,
});
// Get the entire list using the paginator.
await foreach (var instanceOptions in paginateInstanceOptions.OrderableDBInstanceOptions)
{
results.Add(instanceOptions);
}
return results;
}
///
/// Delete a particular parameter group by name.
///
/// The name of the parameter group.
/// True if successful.
public async Task DeleteClusterParameterGroupByNameAsync(string groupName)
{
var request = new DeleteDBClusterParameterGroupRequest
{
DBClusterParameterGroupName = groupName,
};
var response = await _amazonRDS.DeleteDBClusterParameterGroupAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
///
/// Create a new cluster and database.
///
/// The name of the new database.
/// The identifier of the cluster.
/// The name of the parameter group.
/// The engine to use for the new cluster.
/// The version of the engine to use.
/// The admin username.
/// The primary admin password.
/// The cluster object.
public async Task CreateDBClusterWithAdminAsync(
string dbName,
string clusterIdentifier,
string parameterGroupName,
string dbEngine,
string dbEngineVersion,
string adminName,
string adminPassword)
{
var request = new CreateDBClusterRequest
{
DatabaseName = dbName,
DBClusterIdentifier = clusterIdentifier,
DBClusterParameterGroupName = parameterGroupName,
Engine = dbEngine,
EngineVersion = dbEngineVersion,
MasterUsername = adminName,
MasterUserPassword = adminPassword,
};
var response = await _amazonRDS.CreateDBClusterAsync(request);
return response.DBCluster;
}
///
/// Returns a list of DB instances.
///
/// Optional name of a specific DB instance.
/// List of DB instances.
public async Task> DescribeDBInstancesPagedAsync(string? dbInstanceIdentifier = null)
{
var results = new List();
var instancesPaginator = _amazonRDS.Paginators.DescribeDBInstances(
new DescribeDBInstancesRequest
{
DBInstanceIdentifier = dbInstanceIdentifier
});
// Get the entire list using the paginator.
await foreach (var instances in instancesPaginator.DBInstances)
{
results.Add(instances);
}
return results;
}
///
/// Returns a list of DB clusters.
///
/// Optional name of a specific DB cluster.
/// List of DB clusters.
public async Task> DescribeDBClustersPagedAsync(string? dbClusterIdentifier = null)
{
var results = new List();
DescribeDBClustersResponse response;
DescribeDBClustersRequest request = new DescribeDBClustersRequest
{
DBClusterIdentifier = dbClusterIdentifier
};
// Get the full list if there are multiple pages.
do
{
response = await _amazonRDS.DescribeDBClustersAsync(request);
if (response.DBClusters != null)
{
results.AddRange(response.DBClusters);
}
request.Marker = response.Marker;
}
while (response.Marker is not null);
return results;
}
///
/// Create an Amazon Relational Database Service (Amazon RDS) DB instance
/// with a particular set of properties. Use the action DescribeDBInstancesAsync
/// to determine when the DB instance is ready to use.
///
/// DB instance identifier.
/// DB cluster identifier.
/// The engine for the DB instance.
/// Version for the DB instance.
/// Class for the DB instance.
/// DB instance object.
public async Task CreateDBInstanceInClusterAsync(
string dbClusterIdentifier,
string dbInstanceIdentifier,
string dbEngine,
string dbEngineVersion,
string instanceClass)
{
// When creating the instance within a cluster, do not specify the name or size.
var response = await _amazonRDS.CreateDBInstanceAsync(
new CreateDBInstanceRequest()
{
DBClusterIdentifier = dbClusterIdentifier,
DBInstanceIdentifier = dbInstanceIdentifier,
Engine = dbEngine,
EngineVersion = dbEngineVersion,
DBInstanceClass = instanceClass
});
return response.DBInstance;
}
///
/// Create a snapshot of a cluster.
///
/// DB cluster identifier.
/// Identifier for the snapshot.
/// DB snapshot object.
public async Task CreateClusterSnapshotByIdentifierAsync(string dbClusterIdentifier, string snapshotIdentifier)
{
var response = await _amazonRDS.CreateDBClusterSnapshotAsync(
new CreateDBClusterSnapshotRequest()
{
DBClusterIdentifier = dbClusterIdentifier,
DBClusterSnapshotIdentifier = snapshotIdentifier,
});
return response.DBClusterSnapshot;
}
///
/// Return a list of DB snapshots for a particular DB cluster.
///
/// DB cluster identifier.
/// List of DB snapshots.
public async Task> DescribeDBClusterSnapshotsByIdentifierAsync(string dbClusterIdentifier)
{
var results = new List();
DescribeDBClusterSnapshotsResponse response;
DescribeDBClusterSnapshotsRequest request = new DescribeDBClusterSnapshotsRequest
{
DBClusterIdentifier = dbClusterIdentifier
};
// Get the full list if there are multiple pages.
do
{
response = await _amazonRDS.DescribeDBClusterSnapshotsAsync(request);
results.AddRange(response.DBClusterSnapshots);
request.Marker = response.Marker;
}
while (response.Marker is not null);
return results;
}
///
/// Delete a particular DB cluster.
///
/// DB cluster identifier.
/// DB cluster object.
public async Task DeleteDBClusterByIdentifierAsync(string dbClusterIdentifier)
{
var response = await _amazonRDS.DeleteDBClusterAsync(
new DeleteDBClusterRequest()
{
DBClusterIdentifier = dbClusterIdentifier,
SkipFinalSnapshot = true
});
return response.DBCluster;
}
///
/// Delete a particular DB instance.
///
/// DB instance identifier.
/// DB instance object.
public async Task DeleteDBInstanceByIdentifierAsync(string dbInstanceIdentifier)
{
var response = await _amazonRDS.DeleteDBInstanceAsync(
new DeleteDBInstanceRequest()
{
DBInstanceIdentifier = dbInstanceIdentifier,
SkipFinalSnapshot = true,
DeleteAutomatedBackups = true
});
return response.DBInstance;
}
}
```
+ Pour plus d’informations sur l’API consultez les rubriques suivantes dans la *référence de l’API AWS SDK pour .NET *.
+ [CréerDBCluster](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBCluster)
+ [CréerDBClusterParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterParameterGroup)
+ [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterSnapshot)
+ [CréerDBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBInstance)
+ [SuppressionDBCluster](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBCluster)
+ [SuppressionDBClusterParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBClusterParameterGroup)
+ [SuppressionDBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBInstance)
+ [DécrireDBClusterParameterGroups](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterParameterGroups)
+ [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterParameters)
+ [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterSnapshots)
+ [DécrireDBClusters](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusters)
+ [Décrire DBEngine les versions](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBEngineVersions)
+ [DécrireDBInstances](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [ModifyDBClusterParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBClusterParameterGroup)
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
//! Routine which creates an Amazon Aurora DB cluster and demonstrates several operations
//! on that cluster.
/*!
\sa gettingStartedWithDBClusters()
\param clientConfiguration: AWS client configuration.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::gettingStartedWithDBClusters(
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::RDS::RDSClient client(clientConfig);
printAsterisksLine();
std::cout << "Welcome to the Amazon Relational Database Service (Amazon Aurora)"
<< std::endl;
std::cout << "get started with DB clusters demo." << std::endl;
printAsterisksLine();
std::cout << "Checking for an existing DB cluster parameter group named '" <<
CLUSTER_PARAMETER_GROUP_NAME << "'." << std::endl;
Aws::String dbParameterGroupFamily("Undefined");
bool parameterGroupFound = true;
{
// 1. Check if the DB cluster parameter group already exists.
Aws::RDS::Model::DescribeDBClusterParameterGroupsRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
Aws::RDS::Model::DescribeDBClusterParameterGroupsOutcome outcome =
client.DescribeDBClusterParameterGroups(request);
if (outcome.IsSuccess()) {
std::cout << "DB cluster parameter group named '" <<
CLUSTER_PARAMETER_GROUP_NAME << "' already exists." << std::endl;
dbParameterGroupFamily = outcome.GetResult().GetDBClusterParameterGroups()[0].GetDBParameterGroupFamily();
}
else if (outcome.GetError().GetErrorType() ==
Aws::RDS::RDSErrors::D_B_PARAMETER_GROUP_NOT_FOUND_FAULT) {
std::cout << "DB cluster parameter group named '" <<
CLUSTER_PARAMETER_GROUP_NAME << "' does not exist." << std::endl;
parameterGroupFound = false;
}
else {
std::cerr << "Error with Aurora::DescribeDBClusterParameterGroups. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
}
if (!parameterGroupFound) {
Aws::Vector engineVersions;
// 2. Get available parameter group families for the specified engine.
if (!getDBEngineVersions(DB_ENGINE, NO_PARAMETER_GROUP_FAMILY,
engineVersions, client)) {
return false;
}
std::cout << "Getting available parameter group families for " << DB_ENGINE
<< "."
<< std::endl;
std::vector families;
for (const Aws::RDS::Model::DBEngineVersion &version: engineVersions) {
Aws::String family = version.GetDBParameterGroupFamily();
if (std::find(families.begin(), families.end(), family) ==
families.end()) {
families.push_back(family);
std::cout << " " << families.size() << ": " << family << std::endl;
}
}
int choice = askQuestionForIntRange("Which family do you want to use? ", 1,
static_cast(families.size()));
dbParameterGroupFamily = families[choice - 1];
}
if (!parameterGroupFound) {
// 3. Create a DB cluster parameter group.
Aws::RDS::Model::CreateDBClusterParameterGroupRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
request.SetDBParameterGroupFamily(dbParameterGroupFamily);
request.SetDescription("Example cluster parameter group.");
Aws::RDS::Model::CreateDBClusterParameterGroupOutcome outcome =
client.CreateDBClusterParameterGroup(request);
if (outcome.IsSuccess()) {
std::cout << "The DB cluster parameter group was successfully created."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::CreateDBClusterParameterGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
}
printAsterisksLine();
std::cout << "Let's set some parameter values in your cluster parameter group."
<< std::endl;
Aws::Vector autoIncrementParameters;
// 4. Get the parameters in the DB cluster parameter group.
if (!getDBCLusterParameters(CLUSTER_PARAMETER_GROUP_NAME, AUTO_INCREMENT_PREFIX,
NO_SOURCE,
autoIncrementParameters,
client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, "", "", client);
return false;
}
Aws::Vector updateParameters;
for (Aws::RDS::Model::Parameter &autoIncParameter: autoIncrementParameters) {
if (autoIncParameter.GetIsModifiable() &&
(autoIncParameter.GetDataType() == "integer")) {
std::cout << "The " << autoIncParameter.GetParameterName()
<< " is described as: " <<
autoIncParameter.GetDescription() << "." << std::endl;
if (autoIncParameter.ParameterValueHasBeenSet()) {
std::cout << "The current value is "
<< autoIncParameter.GetParameterValue()
<< "." << std::endl;
}
std::vector splitValues = splitToInts(
autoIncParameter.GetAllowedValues(), '-');
if (splitValues.size() == 2) {
int newValue = askQuestionForIntRange(
Aws::String("Enter a new value between ") +
autoIncParameter.GetAllowedValues() + ": ",
splitValues[0], splitValues[1]);
autoIncParameter.SetParameterValue(std::to_string(newValue));
updateParameters.push_back(autoIncParameter);
}
else {
std::cerr << "Error parsing " << autoIncParameter.GetAllowedValues()
<< std::endl;
}
}
}
{
// 5. Modify the auto increment parameters in the DB cluster parameter group.
Aws::RDS::Model::ModifyDBClusterParameterGroupRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
request.SetParameters(updateParameters);
Aws::RDS::Model::ModifyDBClusterParameterGroupOutcome outcome =
client.ModifyDBClusterParameterGroup(request);
if (outcome.IsSuccess()) {
std::cout << "The DB cluster parameter group was successfully modified."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::ModifyDBClusterParameterGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
}
std::cout
<< "You can get a list of parameters you've set by specifying a source of 'user'."
<< std::endl;
Aws::Vector userParameters;
// 6. Display the modified parameters in the DB cluster parameter group.
if (!getDBCLusterParameters(CLUSTER_PARAMETER_GROUP_NAME, NO_NAME_PREFIX, "user",
userParameters,
client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, "", "", client);
return false;
}
for (const auto &userParameter: userParameters) {
std::cout << " " << userParameter.GetParameterName() << ", " <<
userParameter.GetDescription() << ", parameter value - "
<< userParameter.GetParameterValue() << std::endl;
}
printAsterisksLine();
std::cout << "Checking for an existing DB Cluster." << std::endl;
Aws::RDS::Model::DBCluster dbCluster;
// 7. Check if the DB cluster already exists.
if (!describeDBCluster(DB_CLUSTER_IDENTIFIER, dbCluster, client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, "", "", client);
return false;
}
Aws::String engineVersionName;
Aws::String engineName;
if (dbCluster.DBClusterIdentifierHasBeenSet()) {
std::cout << "The DB cluster already exists." << std::endl;
engineVersionName = dbCluster.GetEngineVersion();
engineName = dbCluster.GetEngine();
}
else {
std::cout << "Let's create a DB cluster." << std::endl;
const Aws::String administratorName = askQuestion(
"Enter an administrator username for the database: ");
const Aws::String administratorPassword = askQuestion(
"Enter a password for the administrator (at least 8 characters): ");
Aws::Vector engineVersions;
// 8. Get a list of engine versions for the parameter group family.
if (!getDBEngineVersions(DB_ENGINE, dbParameterGroupFamily, engineVersions,
client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, "", "", client);
return false;
}
std::cout << "The available engines for your parameter group family are:"
<< std::endl;
int index = 1;
for (const Aws::RDS::Model::DBEngineVersion &engineVersion: engineVersions) {
std::cout << " " << index << ": " << engineVersion.GetEngineVersion()
<< std::endl;
++index;
}
int choice = askQuestionForIntRange("Which engine do you want to use? ", 1,
static_cast(engineVersions.size()));
const Aws::RDS::Model::DBEngineVersion engineVersion = engineVersions[choice -
1];
engineName = engineVersion.GetEngine();
engineVersionName = engineVersion.GetEngineVersion();
std::cout << "Creating a DB cluster named '" << DB_CLUSTER_IDENTIFIER
<< "' and database '" << DB_NAME << "'.\n"
<< "The DB cluster is configured to use your custom cluster parameter group '"
<< CLUSTER_PARAMETER_GROUP_NAME << "', and \n"
<< "selected engine version " << engineVersion.GetEngineVersion()
<< ".\nThis typically takes several minutes." << std::endl;
Aws::RDS::Model::CreateDBClusterRequest request;
request.SetDBClusterIdentifier(DB_CLUSTER_IDENTIFIER);
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
request.SetEngine(engineName);
request.SetEngineVersion(engineVersionName);
request.SetMasterUsername(administratorName);
request.SetMasterUserPassword(administratorPassword);
Aws::RDS::Model::CreateDBClusterOutcome outcome =
client.CreateDBCluster(request);
if (outcome.IsSuccess()) {
std::cout << "The DB cluster creation has started."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::CreateDBCluster. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, "", "", client);
return false;
}
}
std::cout << "Waiting for the DB cluster to become available." << std::endl;
int counter = 0;
// 11. Wait for the DB cluster to become available.
do {
std::this_thread::sleep_for(std::chrono::seconds(1));
++counter;
if (counter > 900) {
std::cerr << "Wait for cluster to become available timed out ofter "
<< counter
<< " seconds." << std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, "", client);
return false;
}
dbCluster = Aws::RDS::Model::DBCluster();
if (!describeDBCluster(DB_CLUSTER_IDENTIFIER, dbCluster, client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, "", client);
return false;
}
if ((counter % 20) == 0) {
std::cout << "Current DB cluster status is '"
<< dbCluster.GetStatus()
<< "' after " << counter << " seconds." << std::endl;
}
} while (dbCluster.GetStatus() != "available");
if (dbCluster.GetStatus() == "available") {
std::cout << "The DB cluster has been created." << std::endl;
}
printAsterisksLine();
Aws::RDS::Model::DBInstance dbInstance;
// 11. Check if the DB instance already exists.
if (!describeDBInstance(DB_INSTANCE_IDENTIFIER, dbInstance, client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, DB_CLUSTER_IDENTIFIER, "",
client);
return false;
}
if (dbInstance.DbInstancePortHasBeenSet()) {
std::cout << "The DB instance already exists." << std::endl;
}
else {
std::cout << "Let's create a DB instance." << std::endl;
Aws::String dbInstanceClass;
// 12. Get a list of instance classes.
if (!chooseDBInstanceClass(engineName,
engineVersionName,
dbInstanceClass,
client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, DB_CLUSTER_IDENTIFIER, "",
client);
return false;
}
std::cout << "Creating a DB instance named '" << DB_INSTANCE_IDENTIFIER
<< "' with selected DB instance class '" << dbInstanceClass
<< "'.\nThis typically takes several minutes." << std::endl;
// 13. Create a DB instance.
Aws::RDS::Model::CreateDBInstanceRequest request;
request.SetDBInstanceIdentifier(DB_INSTANCE_IDENTIFIER);
request.SetDBClusterIdentifier(DB_CLUSTER_IDENTIFIER);
request.SetEngine(engineName);
request.SetDBInstanceClass(dbInstanceClass);
Aws::RDS::Model::CreateDBInstanceOutcome outcome =
client.CreateDBInstance(request);
if (outcome.IsSuccess()) {
std::cout << "The DB instance creation has started."
<< std::endl;
}
else {
std::cerr << "Error with RDS::CreateDBInstance. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, DB_CLUSTER_IDENTIFIER, "",
client);
return false;
}
}
std::cout << "Waiting for the DB instance to become available." << std::endl;
counter = 0;
// 14. Wait for the DB instance to become available.
do {
std::this_thread::sleep_for(std::chrono::seconds(1));
++counter;
if (counter > 900) {
std::cerr << "Wait for instance to become available timed out ofter "
<< counter
<< " seconds." << std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
dbInstance = Aws::RDS::Model::DBInstance();
if (!describeDBInstance(DB_INSTANCE_IDENTIFIER, dbInstance, client)) {
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
if ((counter % 20) == 0) {
std::cout << "Current DB instance status is '"
<< dbInstance.GetDBInstanceStatus()
<< "' after " << counter << " seconds." << std::endl;
}
} while (dbInstance.GetDBInstanceStatus() != "available");
if (dbInstance.GetDBInstanceStatus() == "available") {
std::cout << "The DB instance has been created." << std::endl;
}
// 15. Display the connection string that can be used to connect a 'mysql' shell to the database.
displayConnection(dbCluster);
printAsterisksLine();
if (askYesNoQuestion(
"Do you want to create a snapshot of your DB cluster (y/n)? ")) {
Aws::String snapshotID(DB_CLUSTER_IDENTIFIER + "-" +
Aws::String(Aws::Utils::UUID::RandomUUID()));
{
std::cout << "Creating a snapshot named " << snapshotID << "." << std::endl;
std::cout << "This typically takes a few minutes." << std::endl;
// 16. Create a snapshot of the DB cluster. (CreateDBClusterSnapshot)
Aws::RDS::Model::CreateDBClusterSnapshotRequest request;
request.SetDBClusterIdentifier(DB_CLUSTER_IDENTIFIER);
request.SetDBClusterSnapshotIdentifier(snapshotID);
Aws::RDS::Model::CreateDBClusterSnapshotOutcome outcome =
client.CreateDBClusterSnapshot(request);
if (outcome.IsSuccess()) {
std::cout << "Snapshot creation has started."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::CreateDBClusterSnapshot. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
}
std::cout << "Waiting for the snapshot to become available." << std::endl;
Aws::RDS::Model::DBClusterSnapshot snapshot;
counter = 0;
do {
std::this_thread::sleep_for(std::chrono::seconds(1));
++counter;
if (counter > 600) {
std::cerr << "Wait for snapshot to be available timed out ofter "
<< counter
<< " seconds." << std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
// 17. Wait for the snapshot to become available.
Aws::RDS::Model::DescribeDBClusterSnapshotsRequest request;
request.SetDBClusterSnapshotIdentifier(snapshotID);
Aws::RDS::Model::DescribeDBClusterSnapshotsOutcome outcome =
client.DescribeDBClusterSnapshots(request);
if (outcome.IsSuccess()) {
snapshot = outcome.GetResult().GetDBClusterSnapshots()[0];
}
else {
std::cerr << "Error with Aurora::DescribeDBClusterSnapshots. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
if ((counter % 20) == 0) {
std::cout << "Current snapshot status is '"
<< snapshot.GetStatus()
<< "' after " << counter << " seconds." << std::endl;
}
} while (snapshot.GetStatus() != "available");
if (snapshot.GetStatus() != "available") {
std::cout << "A snapshot has been created." << std::endl;
}
}
printAsterisksLine();
bool result = true;
if (askYesNoQuestion(
"Do you want to delete the DB cluster, DB instance, and parameter group (y/n)? ")) {
result = cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER,
client);
}
return result;
}
//! Routine which gets a DB cluster description.
/*!
\sa describeDBCluster()
\param dbClusterIdentifier: A DB cluster identifier.
\param clusterResult: The 'DBCluster' object containing the description.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::describeDBCluster(const Aws::String &dbClusterIdentifier,
Aws::RDS::Model::DBCluster &clusterResult,
const Aws::RDS::RDSClient &client) {
Aws::RDS::Model::DescribeDBClustersRequest request;
request.SetDBClusterIdentifier(dbClusterIdentifier);
Aws::RDS::Model::DescribeDBClustersOutcome outcome =
client.DescribeDBClusters(request);
bool result = true;
if (outcome.IsSuccess()) {
clusterResult = outcome.GetResult().GetDBClusters()[0];
}
else if (outcome.GetError().GetErrorType() !=
Aws::RDS::RDSErrors::D_B_CLUSTER_NOT_FOUND_FAULT) {
result = false;
std::cerr << "Error with Aurora::GDescribeDBClusters. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
// This example does not log an error if the DB cluster does not exist.
// Instead, clusterResult is set to empty.
else {
clusterResult = Aws::RDS::Model::DBCluster();
}
return result;
}
//! Routine which gets DB parameters using the 'DescribeDBClusterParameters' api.
/*!
\sa getDBCLusterParameters()
\param parameterGroupName: The name of the cluster parameter group.
\param namePrefix: Prefix string to filter results by parameter name.
\param source: A source such as 'user', ignored if empty.
\param parametersResult: Vector of 'Parameter' objects returned by the routine.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::getDBCLusterParameters(const Aws::String ¶meterGroupName,
const Aws::String &namePrefix,
const Aws::String &source,
Aws::Vector ¶metersResult,
const Aws::RDS::RDSClient &client) {
Aws::String marker; // The marker is used for pagination.
do {
Aws::RDS::Model::DescribeDBClusterParametersRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
if (!marker.empty()) {
request.SetMarker(marker);
}
if (!source.empty()) {
request.SetSource(source);
}
Aws::RDS::Model::DescribeDBClusterParametersOutcome outcome =
client.DescribeDBClusterParameters(request);
if (outcome.IsSuccess()) {
const Aws::Vector ¶meters =
outcome.GetResult().GetParameters();
for (const Aws::RDS::Model::Parameter ¶meter: parameters) {
if (!namePrefix.empty()) {
if (parameter.GetParameterName().find(namePrefix) == 0) {
parametersResult.push_back(parameter);
}
}
else {
parametersResult.push_back(parameter);
}
}
marker = outcome.GetResult().GetMarker();
}
else {
std::cerr << "Error with Aurora::DescribeDBClusterParameters. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
} while (!marker.empty());
return true;
}
//! Routine which gets available DB engine versions for an engine name and
//! an optional parameter group family.
/*!
\sa getDBEngineVersions()
\param engineName: A DB engine name.
\param parameterGroupFamily: A parameter group family name, ignored if empty.
\param engineVersionsResult: Vector of 'DBEngineVersion' objects returned by the routine.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::getDBEngineVersions(const Aws::String &engineName,
const Aws::String ¶meterGroupFamily,
Aws::Vector &engineVersionsResult,
const Aws::RDS::RDSClient &client) {
Aws::RDS::Model::DescribeDBEngineVersionsRequest request;
request.SetEngine(engineName);
if (!parameterGroupFamily.empty()) {
request.SetDBParameterGroupFamily(parameterGroupFamily);
}
engineVersionsResult.clear();
Aws::String marker; // The marker is used for pagination.
do {
if (!marker.empty()) {
request.SetMarker(marker);
}
Aws::RDS::Model::DescribeDBEngineVersionsOutcome outcome =
client.DescribeDBEngineVersions(request);
if (outcome.IsSuccess()) {
const Aws::Vector &engineVersions =
outcome.GetResult().GetDBEngineVersions();
engineVersionsResult.insert(engineVersionsResult.end(),
engineVersions.begin(), engineVersions.end());
marker = outcome.GetResult().GetMarker();
}
else {
std::cerr << "Error with Aurora::DescribeDBEngineVersionsRequest. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
} while (!marker.empty());
return true;
}
//! Routine which gets a DB instance description.
/*!
\sa describeDBCluster()
\param dbInstanceIdentifier: A DB instance identifier.
\param instanceResult: The 'DBInstance' object containing the description.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::describeDBInstance(const Aws::String &dbInstanceIdentifier,
Aws::RDS::Model::DBInstance &instanceResult,
const Aws::RDS::RDSClient &client) {
Aws::RDS::Model::DescribeDBInstancesRequest request;
request.SetDBInstanceIdentifier(dbInstanceIdentifier);
Aws::RDS::Model::DescribeDBInstancesOutcome outcome =
client.DescribeDBInstances(request);
bool result = true;
if (outcome.IsSuccess()) {
instanceResult = outcome.GetResult().GetDBInstances()[0];
}
else if (outcome.GetError().GetErrorType() !=
Aws::RDS::RDSErrors::D_B_INSTANCE_NOT_FOUND_FAULT) {
result = false;
std::cerr << "Error with Aurora::DescribeDBInstances. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
// This example does not log an error if the DB instance does not exist.
// Instead, instanceResult is set to empty.
else {
instanceResult = Aws::RDS::Model::DBInstance();
}
return result;
}
//! Routine which gets available DB instance classes, displays the list
//! to the user, and returns the user selection.
/*!
\sa chooseDBInstanceClass()
\param engineName: The DB engine name.
\param engineVersion: The DB engine version.
\param dbInstanceClass: String for DB instance class chosen by the user.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::chooseDBInstanceClass(const Aws::String &engine,
const Aws::String &engineVersion,
Aws::String &dbInstanceClass,
const Aws::RDS::RDSClient &client) {
std::vector instanceClasses;
Aws::String marker; // The marker is used for pagination.
do {
Aws::RDS::Model::DescribeOrderableDBInstanceOptionsRequest request;
request.SetEngine(engine);
request.SetEngineVersion(engineVersion);
if (!marker.empty()) {
request.SetMarker(marker);
}
Aws::RDS::Model::DescribeOrderableDBInstanceOptionsOutcome outcome =
client.DescribeOrderableDBInstanceOptions(request);
if (outcome.IsSuccess()) {
const Aws::Vector &options =
outcome.GetResult().GetOrderableDBInstanceOptions();
for (const Aws::RDS::Model::OrderableDBInstanceOption &option: options) {
const Aws::String &instanceClass = option.GetDBInstanceClass();
if (std::find(instanceClasses.begin(), instanceClasses.end(),
instanceClass) == instanceClasses.end()) {
instanceClasses.push_back(instanceClass);
}
}
marker = outcome.GetResult().GetMarker();
}
else {
std::cerr << "Error with Aurora::DescribeOrderableDBInstanceOptions. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
} while (!marker.empty());
std::cout << "The available DB instance classes for your database engine are:"
<< std::endl;
for (int i = 0; i < instanceClasses.size(); ++i) {
std::cout << " " << i + 1 << ": " << instanceClasses[i] << std::endl;
}
int choice = askQuestionForIntRange(
"Which DB instance class do you want to use? ",
1, static_cast(instanceClasses.size()));
dbInstanceClass = instanceClasses[choice - 1];
return true;
}
//! Routine which deletes resources created by the scenario.
/*!
\sa cleanUpResources()
\param parameterGroupName: A parameter group name, this may be empty.
\param dbInstanceIdentifier: A DB instance identifier, this may be empty.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::cleanUpResources(const Aws::String ¶meterGroupName,
const Aws::String &dbClusterIdentifier,
const Aws::String &dbInstanceIdentifier,
const Aws::RDS::RDSClient &client) {
bool result = true;
bool instanceDeleting = false;
bool clusterDeleting = false;
if (!dbInstanceIdentifier.empty()) {
{
// 18. Delete the DB instance.
Aws::RDS::Model::DeleteDBInstanceRequest request;
request.SetDBInstanceIdentifier(dbInstanceIdentifier);
request.SetSkipFinalSnapshot(true);
request.SetDeleteAutomatedBackups(true);
Aws::RDS::Model::DeleteDBInstanceOutcome outcome =
client.DeleteDBInstance(request);
if (outcome.IsSuccess()) {
std::cout << "DB instance deletion has started."
<< std::endl;
instanceDeleting = true;
std::cout
<< "Waiting for DB instance to delete before deleting the parameter group."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::DeleteDBInstance. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
}
}
if (!dbClusterIdentifier.empty()) {
{
// 19. Delete the DB cluster.
Aws::RDS::Model::DeleteDBClusterRequest request;
request.SetDBClusterIdentifier(dbClusterIdentifier);
request.SetSkipFinalSnapshot(true);
Aws::RDS::Model::DeleteDBClusterOutcome outcome =
client.DeleteDBCluster(request);
if (outcome.IsSuccess()) {
std::cout << "DB cluster deletion has started."
<< std::endl;
clusterDeleting = true;
std::cout
<< "Waiting for DB cluster to delete before deleting the parameter group."
<< std::endl;
std::cout << "This may take a while." << std::endl;
}
else {
std::cerr << "Error with Aurora::DeleteDBCluster. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
}
}
int counter = 0;
while (clusterDeleting || instanceDeleting) {
// 20. Wait for the DB cluster and instance to be deleted.
std::this_thread::sleep_for(std::chrono::seconds(1));
++counter;
if (counter > 800) {
std::cerr << "Wait for instance to delete timed out ofter " << counter
<< " seconds." << std::endl;
return false;
}
Aws::RDS::Model::DBInstance dbInstance = Aws::RDS::Model::DBInstance();
if (instanceDeleting) {
if (!describeDBInstance(dbInstanceIdentifier, dbInstance, client)) {
return false;
}
instanceDeleting = dbInstance.DBInstanceIdentifierHasBeenSet();
}
Aws::RDS::Model::DBCluster dbCluster = Aws::RDS::Model::DBCluster();
if (clusterDeleting) {
if (!describeDBCluster(dbClusterIdentifier, dbCluster, client)) {
return false;
}
clusterDeleting = dbCluster.DBClusterIdentifierHasBeenSet();
}
if ((counter % 20) == 0) {
if (instanceDeleting) {
std::cout << "Current DB instance status is '"
<< dbInstance.GetDBInstanceStatus() << "." << std::endl;
}
if (clusterDeleting) {
std::cout << "Current DB cluster status is '"
<< dbCluster.GetStatus() << "." << std::endl;
}
}
}
if (!parameterGroupName.empty()) {
// 21. Delete the DB cluster parameter group.
Aws::RDS::Model::DeleteDBClusterParameterGroupRequest request;
request.SetDBClusterParameterGroupName(parameterGroupName);
Aws::RDS::Model::DeleteDBClusterParameterGroupOutcome outcome =
client.DeleteDBClusterParameterGroup(request);
if (outcome.IsSuccess()) {
std::cout << "The DB parameter group was successfully deleted."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::DeleteDBClusterParameterGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
}
return result;
}
```
+ Pour plus de détails sur l’API, consultez les rubriques suivantes dans la *Référence des API du kit AWS SDK pour C\$1\$1 *.
+ [CréerDBCluster](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBCluster)
+ [CréerDBClusterParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterParameterGroup)
+ [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterSnapshot)
+ [CréerDBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBInstance)
+ [SuppressionDBCluster](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBCluster)
+ [SuppressionDBClusterParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBClusterParameterGroup)
+ [SuppressionDBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBInstance)
+ [DécrireDBClusterParameterGroups](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterParameterGroups)
+ [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterParameters)
+ [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterSnapshots)
+ [DécrireDBClusters](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusters)
+ [Décrire DBEngine les versions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBEngineVersions)
+ [DécrireDBInstances](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [ModifyDBClusterParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBClusterParameterGroup)
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
Exécutez un scénario interactif à une invite de commande.
```
import (
"aurora/actions"
"context"
"fmt"
"log"
"slices"
"sort"
"strconv"
"strings"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
"github.com/awsdocs/aws-doc-sdk-examples/gov2/demotools"
"github.com/google/uuid"
)
// GetStartedClusters is an interactive example that shows you how to use the AWS SDK for Go
// with Amazon Aurora to do the following:
//
// 1. Create a custom DB cluster parameter group and set parameter values.
// 2. Create an Aurora DB cluster that is configured to use the parameter group.
// 3. Create a DB instance in the DB cluster that contains a database.
// 4. Take a snapshot of the DB cluster.
// 5. Delete the DB instance, DB cluster, and parameter group.
type GetStartedClusters struct {
sdkConfig aws.Config
dbClusters actions.DbClusters
questioner demotools.IQuestioner
helper IScenarioHelper
isTestRun bool
}
// NewGetStartedClusters constructs a GetStartedClusters instance from a configuration.
// It uses the specified config to get an Amazon Relational Database Service (Amazon RDS)
// client and create wrappers for the actions used in the scenario.
func NewGetStartedClusters(sdkConfig aws.Config, questioner demotools.IQuestioner,
helper IScenarioHelper) GetStartedClusters {
auroraClient := rds.NewFromConfig(sdkConfig)
return GetStartedClusters{
sdkConfig: sdkConfig,
dbClusters: actions.DbClusters{AuroraClient: auroraClient},
questioner: questioner,
helper: helper,
}
}
// Run runs the interactive scenario.
func (scenario GetStartedClusters) Run(ctx context.Context, dbEngine string, parameterGroupName string,
clusterName string, dbName string) {
defer func() {
if r := recover(); r != nil {
log.Println("Something went wrong with the demo.")
}
}()
log.Println(strings.Repeat("-", 88))
log.Println("Welcome to the Amazon Aurora DB Cluster demo.")
log.Println(strings.Repeat("-", 88))
parameterGroup := scenario.CreateParameterGroup(ctx, dbEngine, parameterGroupName)
scenario.SetUserParameters(ctx, parameterGroupName)
cluster := scenario.CreateCluster(ctx, clusterName, dbEngine, dbName, parameterGroup)
scenario.helper.Pause(5)
dbInstance := scenario.CreateInstance(ctx, cluster)
scenario.DisplayConnection(cluster)
scenario.CreateSnapshot(ctx, clusterName)
scenario.Cleanup(ctx, dbInstance, cluster, parameterGroup)
log.Println(strings.Repeat("-", 88))
log.Println("Thanks for watching!")
log.Println(strings.Repeat("-", 88))
}
// CreateParameterGroup shows how to get available engine versions for a specified
// database engine and create a DB cluster parameter group that is compatible with a
// selected engine family.
func (scenario GetStartedClusters) CreateParameterGroup(ctx context.Context, dbEngine string,
parameterGroupName string) *types.DBClusterParameterGroup {
log.Printf("Checking for an existing DB cluster parameter group named %v.\n",
parameterGroupName)
parameterGroup, err := scenario.dbClusters.GetParameterGroup(ctx, parameterGroupName)
if err != nil {
panic(err)
}
if parameterGroup == nil {
log.Printf("Getting available database engine versions for %v.\n", dbEngine)
engineVersions, err := scenario.dbClusters.GetEngineVersions(ctx, dbEngine, "")
if err != nil {
panic(err)
}
familySet := map[string]struct{}{}
for _, family := range engineVersions {
familySet[*family.DBParameterGroupFamily] = struct{}{}
}
var families []string
for family := range familySet {
families = append(families, family)
}
sort.Strings(families)
familyIndex := scenario.questioner.AskChoice("Which family do you want to use?\n", families)
log.Println("Creating a DB cluster parameter group.")
_, err = scenario.dbClusters.CreateParameterGroup(
ctx, parameterGroupName, families[familyIndex], "Example parameter group.")
if err != nil {
panic(err)
}
parameterGroup, err = scenario.dbClusters.GetParameterGroup(ctx, parameterGroupName)
if err != nil {
panic(err)
}
}
log.Printf("Parameter group %v:\n", *parameterGroup.DBParameterGroupFamily)
log.Printf("\tName: %v\n", *parameterGroup.DBClusterParameterGroupName)
log.Printf("\tARN: %v\n", *parameterGroup.DBClusterParameterGroupArn)
log.Printf("\tFamily: %v\n", *parameterGroup.DBParameterGroupFamily)
log.Printf("\tDescription: %v\n", *parameterGroup.Description)
log.Println(strings.Repeat("-", 88))
return parameterGroup
}
// SetUserParameters shows how to get the parameters contained in a custom parameter
// group and update some of the parameter values in the group.
func (scenario GetStartedClusters) SetUserParameters(ctx context.Context, parameterGroupName string) {
log.Println("Let's set some parameter values in your parameter group.")
dbParameters, err := scenario.dbClusters.GetParameters(ctx, parameterGroupName, "")
if err != nil {
panic(err)
}
var updateParams []types.Parameter
for _, dbParam := range dbParameters {
if strings.HasPrefix(*dbParam.ParameterName, "auto_increment") &&
*dbParam.IsModifiable && *dbParam.DataType == "integer" {
log.Printf("The %v parameter is described as:\n\t%v",
*dbParam.ParameterName, *dbParam.Description)
rangeSplit := strings.Split(*dbParam.AllowedValues, "-")
lower, _ := strconv.Atoi(rangeSplit[0])
upper, _ := strconv.Atoi(rangeSplit[1])
newValue := scenario.questioner.AskInt(
fmt.Sprintf("Enter a value between %v and %v:", lower, upper),
demotools.InIntRange{Lower: lower, Upper: upper})
dbParam.ParameterValue = aws.String(strconv.Itoa(newValue))
updateParams = append(updateParams, dbParam)
}
}
err = scenario.dbClusters.UpdateParameters(ctx, parameterGroupName, updateParams)
if err != nil {
panic(err)
}
log.Println("You can get a list of parameters you've set by specifying a source of 'user'.")
userParameters, err := scenario.dbClusters.GetParameters(ctx, parameterGroupName, "user")
if err != nil {
panic(err)
}
log.Println("Here are the parameters you've set:")
for _, param := range userParameters {
log.Printf("\t%v: %v\n", *param.ParameterName, *param.ParameterValue)
}
log.Println(strings.Repeat("-", 88))
}
// CreateCluster shows how to create an Aurora DB cluster that contains a database
// of a specified type. The database is also configured to use a custom DB cluster
// parameter group.
func (scenario GetStartedClusters) CreateCluster(ctx context.Context, clusterName string, dbEngine string,
dbName string, parameterGroup *types.DBClusterParameterGroup) *types.DBCluster {
log.Println("Checking for an existing DB cluster.")
cluster, err := scenario.dbClusters.GetDbCluster(ctx, clusterName)
if err != nil {
panic(err)
}
if cluster == nil {
adminUsername := scenario.questioner.Ask(
"Enter an administrator user name for the database: ", demotools.NotEmpty{})
adminPassword := scenario.questioner.Ask(
"Enter a password for the administrator (at least 8 characters): ", demotools.NotEmpty{})
engineVersions, err := scenario.dbClusters.GetEngineVersions(ctx, dbEngine, *parameterGroup.DBParameterGroupFamily)
if err != nil {
panic(err)
}
var engineChoices []string
for _, engine := range engineVersions {
engineChoices = append(engineChoices, *engine.EngineVersion)
}
log.Println("The available engines for your parameter group are:")
engineIndex := scenario.questioner.AskChoice("Which engine do you want to use?\n", engineChoices)
log.Printf("Creating DB cluster %v and database %v.\n", clusterName, dbName)
log.Printf("The DB cluster is configured to use\nyour custom parameter group %v\n",
*parameterGroup.DBClusterParameterGroupName)
log.Printf("and selected engine %v.\n", engineChoices[engineIndex])
log.Println("This typically takes several minutes.")
cluster, err = scenario.dbClusters.CreateDbCluster(
ctx, clusterName, *parameterGroup.DBClusterParameterGroupName, dbName, dbEngine,
engineChoices[engineIndex], adminUsername, adminPassword)
if err != nil {
panic(err)
}
for *cluster.Status != "available" {
scenario.helper.Pause(30)
cluster, err = scenario.dbClusters.GetDbCluster(ctx, clusterName)
if err != nil {
panic(err)
}
log.Println("Cluster created and available.")
}
}
log.Println("Cluster data:")
log.Printf("\tDBClusterIdentifier: %v\n", *cluster.DBClusterIdentifier)
log.Printf("\tARN: %v\n", *cluster.DBClusterArn)
log.Printf("\tStatus: %v\n", *cluster.Status)
log.Printf("\tEngine: %v\n", *cluster.Engine)
log.Printf("\tEngine version: %v\n", *cluster.EngineVersion)
log.Printf("\tDBClusterParameterGroup: %v\n", *cluster.DBClusterParameterGroup)
log.Printf("\tEngineMode: %v\n", *cluster.EngineMode)
log.Println(strings.Repeat("-", 88))
return cluster
}
// CreateInstance shows how to create a DB instance in an existing Aurora DB cluster.
// A new DB cluster contains no DB instances, so you must add one. The first DB instance
// that is added to a DB cluster defaults to a read-write DB instance.
func (scenario GetStartedClusters) CreateInstance(ctx context.Context, cluster *types.DBCluster) *types.DBInstance {
log.Println("Checking for an existing database instance.")
dbInstance, err := scenario.dbClusters.GetInstance(ctx, *cluster.DBClusterIdentifier)
if err != nil {
panic(err)
}
if dbInstance == nil {
log.Println("Let's create a database instance in your DB cluster.")
log.Println("First, choose a DB instance type:")
instOpts, err := scenario.dbClusters.GetOrderableInstances(
ctx, *cluster.Engine, *cluster.EngineVersion)
if err != nil {
panic(err)
}
var instChoices []string
for _, opt := range instOpts {
instChoices = append(instChoices, *opt.DBInstanceClass)
}
slices.Sort(instChoices)
instChoices = slices.Compact(instChoices)
instIndex := scenario.questioner.AskChoice(
"Which DB instance class do you want to use?\n", instChoices)
log.Println("Creating a database instance. This typically takes several minutes.")
dbInstance, err = scenario.dbClusters.CreateInstanceInCluster(
ctx, *cluster.DBClusterIdentifier, *cluster.DBClusterIdentifier, *cluster.Engine,
instChoices[instIndex])
if err != nil {
panic(err)
}
for *dbInstance.DBInstanceStatus != "available" {
scenario.helper.Pause(30)
dbInstance, err = scenario.dbClusters.GetInstance(ctx, *cluster.DBClusterIdentifier)
if err != nil {
panic(err)
}
}
}
log.Println("Instance data:")
log.Printf("\tDBInstanceIdentifier: %v\n", *dbInstance.DBInstanceIdentifier)
log.Printf("\tARN: %v\n", *dbInstance.DBInstanceArn)
log.Printf("\tStatus: %v\n", *dbInstance.DBInstanceStatus)
log.Printf("\tEngine: %v\n", *dbInstance.Engine)
log.Printf("\tEngine version: %v\n", *dbInstance.EngineVersion)
log.Println(strings.Repeat("-", 88))
return dbInstance
}
// DisplayConnection displays connection information about an Aurora DB cluster and tips
// on how to connect to it.
func (scenario GetStartedClusters) DisplayConnection(cluster *types.DBCluster) {
log.Println(
"You can now connect to your database using your favorite MySql client.\n" +
"One way to connect is by using the 'mysql' shell on an Amazon EC2 instance\n" +
"that is running in the same VPC as your database cluster. Pass the endpoint,\n" +
"port, and administrator user name to 'mysql' and enter your password\n" +
"when prompted:")
log.Printf("\n\tmysql -h %v -P %v -u %v -p\n",
*cluster.Endpoint, *cluster.Port, *cluster.MasterUsername)
log.Println("For more information, see the User Guide for Aurora:\n" +
"\thttps://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.CreatingConnecting.Aurora.html#CHAP_GettingStartedAurora.Aurora.Connect")
log.Println(strings.Repeat("-", 88))
}
// CreateSnapshot shows how to create a DB cluster snapshot and wait until it's available.
func (scenario GetStartedClusters) CreateSnapshot(ctx context.Context, clusterName string) {
if scenario.questioner.AskBool(
"Do you want to create a snapshot of your DB cluster (y/n)? ", "y") {
snapshotId := fmt.Sprintf("%v-%v", clusterName, scenario.helper.UniqueId())
log.Printf("Creating a snapshot named %v. This typically takes a few minutes.\n", snapshotId)
snapshot, err := scenario.dbClusters.CreateClusterSnapshot(ctx, clusterName, snapshotId)
if err != nil {
panic(err)
}
for *snapshot.Status != "available" {
scenario.helper.Pause(30)
snapshot, err = scenario.dbClusters.GetClusterSnapshot(ctx, snapshotId)
if err != nil {
panic(err)
}
}
log.Println("Snapshot data:")
log.Printf("\tDBClusterSnapshotIdentifier: %v\n", *snapshot.DBClusterSnapshotIdentifier)
log.Printf("\tARN: %v\n", *snapshot.DBClusterSnapshotArn)
log.Printf("\tStatus: %v\n", *snapshot.Status)
log.Printf("\tEngine: %v\n", *snapshot.Engine)
log.Printf("\tEngine version: %v\n", *snapshot.EngineVersion)
log.Printf("\tDBClusterIdentifier: %v\n", *snapshot.DBClusterIdentifier)
log.Printf("\tSnapshotCreateTime: %v\n", *snapshot.SnapshotCreateTime)
log.Println(strings.Repeat("-", 88))
}
}
// Cleanup shows how to clean up a DB instance, DB cluster, and DB cluster parameter group.
// Before the DB cluster parameter group can be deleted, all associated DB instances and
// DB clusters must first be deleted.
func (scenario GetStartedClusters) Cleanup(ctx context.Context, dbInstance *types.DBInstance, cluster *types.DBCluster,
parameterGroup *types.DBClusterParameterGroup) {
if scenario.questioner.AskBool(
"\nDo you want to delete the database instance, DB cluster, and parameter group (y/n)? ", "y") {
log.Printf("Deleting database instance %v.\n", *dbInstance.DBInstanceIdentifier)
err := scenario.dbClusters.DeleteInstance(ctx, *dbInstance.DBInstanceIdentifier)
if err != nil {
panic(err)
}
log.Printf("Deleting database cluster %v.\n", *cluster.DBClusterIdentifier)
err = scenario.dbClusters.DeleteDbCluster(ctx, *cluster.DBClusterIdentifier)
if err != nil {
panic(err)
}
log.Println(
"Waiting for the DB instance and DB cluster to delete. This typically takes several minutes.")
for dbInstance != nil || cluster != nil {
scenario.helper.Pause(30)
if dbInstance != nil {
dbInstance, err = scenario.dbClusters.GetInstance(ctx, *dbInstance.DBInstanceIdentifier)
if err != nil {
panic(err)
}
}
if cluster != nil {
cluster, err = scenario.dbClusters.GetDbCluster(ctx, *cluster.DBClusterIdentifier)
if err != nil {
panic(err)
}
}
}
log.Printf("Deleting parameter group %v.", *parameterGroup.DBClusterParameterGroupName)
err = scenario.dbClusters.DeleteParameterGroup(ctx, *parameterGroup.DBClusterParameterGroupName)
if err != nil {
panic(err)
}
}
}
// IScenarioHelper abstracts the function from a scenario so that it
// can be mocked for unit testing.
type IScenarioHelper interface {
Pause(secs int)
UniqueId() string
}
type ScenarioHelper struct{}
// Pause waits for the specified number of seconds.
func (helper ScenarioHelper) Pause(secs int) {
time.Sleep(time.Duration(secs) * time.Second)
}
// UniqueId returns a new UUID.
func (helper ScenarioHelper) UniqueId() string {
return uuid.New().String()
}
```
Définissez des fonctions appelées par le scénario pour gérer des actions Aurora.
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetParameterGroup gets a DB cluster parameter group by name.
func (clusters *DbClusters) GetParameterGroup(ctx context.Context, parameterGroupName string) (
*types.DBClusterParameterGroup, error) {
output, err := clusters.AuroraClient.DescribeDBClusterParameterGroups(
ctx, &rds.DescribeDBClusterParameterGroupsInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
})
if err != nil {
var notFoundError *types.DBParameterGroupNotFoundFault
if errors.As(err, ¬FoundError) {
log.Printf("Parameter group %v does not exist.\n", parameterGroupName)
err = nil
} else {
log.Printf("Error getting parameter group %v: %v\n", parameterGroupName, err)
}
return nil, err
} else {
return &output.DBClusterParameterGroups[0], err
}
}
// CreateParameterGroup creates a DB cluster parameter group that is based on the specified
// parameter group family.
func (clusters *DbClusters) CreateParameterGroup(
ctx context.Context, parameterGroupName string, parameterGroupFamily string, description string) (
*types.DBClusterParameterGroup, error) {
output, err := clusters.AuroraClient.CreateDBClusterParameterGroup(ctx,
&rds.CreateDBClusterParameterGroupInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
DBParameterGroupFamily: aws.String(parameterGroupFamily),
Description: aws.String(description),
})
if err != nil {
log.Printf("Couldn't create parameter group %v: %v\n", parameterGroupName, err)
return nil, err
} else {
return output.DBClusterParameterGroup, err
}
}
// DeleteParameterGroup deletes the named DB cluster parameter group.
func (clusters *DbClusters) DeleteParameterGroup(ctx context.Context, parameterGroupName string) error {
_, err := clusters.AuroraClient.DeleteDBClusterParameterGroup(ctx,
&rds.DeleteDBClusterParameterGroupInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
})
if err != nil {
log.Printf("Couldn't delete parameter group %v: %v\n", parameterGroupName, err)
return err
} else {
return nil
}
}
// GetParameters gets the parameters that are contained in a DB cluster parameter group.
func (clusters *DbClusters) GetParameters(ctx context.Context, parameterGroupName string, source string) (
[]types.Parameter, error) {
var output *rds.DescribeDBClusterParametersOutput
var params []types.Parameter
var err error
parameterPaginator := rds.NewDescribeDBClusterParametersPaginator(clusters.AuroraClient,
&rds.DescribeDBClusterParametersInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
Source: aws.String(source),
})
for parameterPaginator.HasMorePages() {
output, err = parameterPaginator.NextPage(ctx)
if err != nil {
log.Printf("Couldn't get paramaeters for %v: %v\n", parameterGroupName, err)
break
} else {
params = append(params, output.Parameters...)
}
}
return params, err
}
// UpdateParameters updates parameters in a named DB cluster parameter group.
func (clusters *DbClusters) UpdateParameters(ctx context.Context, parameterGroupName string, params []types.Parameter) error {
_, err := clusters.AuroraClient.ModifyDBClusterParameterGroup(ctx,
&rds.ModifyDBClusterParameterGroupInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
Parameters: params,
})
if err != nil {
log.Printf("Couldn't update parameters in %v: %v\n", parameterGroupName, err)
return err
} else {
return nil
}
}
// GetDbCluster gets data about an Aurora DB cluster.
func (clusters *DbClusters) GetDbCluster(ctx context.Context, clusterName string) (*types.DBCluster, error) {
output, err := clusters.AuroraClient.DescribeDBClusters(ctx,
&rds.DescribeDBClustersInput{
DBClusterIdentifier: aws.String(clusterName),
})
if err != nil {
var notFoundError *types.DBClusterNotFoundFault
if errors.As(err, ¬FoundError) {
log.Printf("DB cluster %v does not exist.\n", clusterName)
err = nil
} else {
log.Printf("Couldn't get DB cluster %v: %v\n", clusterName, err)
}
return nil, err
} else {
return &output.DBClusters[0], err
}
}
// CreateDbCluster creates a DB cluster that is configured to use the specified parameter group.
// The newly created DB cluster contains a database that uses the specified engine and
// engine version.
func (clusters *DbClusters) CreateDbCluster(ctx context.Context, clusterName string, parameterGroupName string,
dbName string, dbEngine string, dbEngineVersion string, adminName string, adminPassword string) (
*types.DBCluster, error) {
output, err := clusters.AuroraClient.CreateDBCluster(ctx, &rds.CreateDBClusterInput{
DBClusterIdentifier: aws.String(clusterName),
Engine: aws.String(dbEngine),
DBClusterParameterGroupName: aws.String(parameterGroupName),
DatabaseName: aws.String(dbName),
EngineVersion: aws.String(dbEngineVersion),
MasterUserPassword: aws.String(adminPassword),
MasterUsername: aws.String(adminName),
})
if err != nil {
log.Printf("Couldn't create DB cluster %v: %v\n", clusterName, err)
return nil, err
} else {
return output.DBCluster, err
}
}
// DeleteDbCluster deletes a DB cluster without keeping a final snapshot.
func (clusters *DbClusters) DeleteDbCluster(ctx context.Context, clusterName string) error {
_, err := clusters.AuroraClient.DeleteDBCluster(ctx, &rds.DeleteDBClusterInput{
DBClusterIdentifier: aws.String(clusterName),
SkipFinalSnapshot: aws.Bool(true),
})
if err != nil {
log.Printf("Couldn't delete DB cluster %v: %v\n", clusterName, err)
return err
} else {
return nil
}
}
// CreateClusterSnapshot creates a snapshot of a DB cluster.
func (clusters *DbClusters) CreateClusterSnapshot(ctx context.Context, clusterName string, snapshotName string) (
*types.DBClusterSnapshot, error) {
output, err := clusters.AuroraClient.CreateDBClusterSnapshot(ctx, &rds.CreateDBClusterSnapshotInput{
DBClusterIdentifier: aws.String(clusterName),
DBClusterSnapshotIdentifier: aws.String(snapshotName),
})
if err != nil {
log.Printf("Couldn't create snapshot %v: %v\n", snapshotName, err)
return nil, err
} else {
return output.DBClusterSnapshot, nil
}
}
// GetClusterSnapshot gets a DB cluster snapshot.
func (clusters *DbClusters) GetClusterSnapshot(ctx context.Context, snapshotName string) (*types.DBClusterSnapshot, error) {
output, err := clusters.AuroraClient.DescribeDBClusterSnapshots(ctx,
&rds.DescribeDBClusterSnapshotsInput{
DBClusterSnapshotIdentifier: aws.String(snapshotName),
})
if err != nil {
log.Printf("Couldn't get snapshot %v: %v\n", snapshotName, err)
return nil, err
} else {
return &output.DBClusterSnapshots[0], nil
}
}
// CreateInstanceInCluster creates a database instance in an existing DB cluster. The first database that is
// created defaults to a read-write DB instance.
func (clusters *DbClusters) CreateInstanceInCluster(ctx context.Context, clusterName string, instanceName string,
dbEngine string, dbInstanceClass string) (*types.DBInstance, error) {
output, err := clusters.AuroraClient.CreateDBInstance(ctx, &rds.CreateDBInstanceInput{
DBInstanceIdentifier: aws.String(instanceName),
DBClusterIdentifier: aws.String(clusterName),
Engine: aws.String(dbEngine),
DBInstanceClass: aws.String(dbInstanceClass),
})
if err != nil {
log.Printf("Couldn't create instance %v: %v\n", instanceName, err)
return nil, err
} else {
return output.DBInstance, nil
}
}
// GetInstance gets data about a DB instance.
func (clusters *DbClusters) GetInstance(ctx context.Context, instanceName string) (
*types.DBInstance, error) {
output, err := clusters.AuroraClient.DescribeDBInstances(ctx,
&rds.DescribeDBInstancesInput{
DBInstanceIdentifier: aws.String(instanceName),
})
if err != nil {
var notFoundError *types.DBInstanceNotFoundFault
if errors.As(err, ¬FoundError) {
log.Printf("DB instance %v does not exist.\n", instanceName)
err = nil
} else {
log.Printf("Couldn't get instance %v: %v\n", instanceName, err)
}
return nil, err
} else {
return &output.DBInstances[0], nil
}
}
// DeleteInstance deletes a DB instance.
func (clusters *DbClusters) DeleteInstance(ctx context.Context, instanceName string) error {
_, err := clusters.AuroraClient.DeleteDBInstance(ctx, &rds.DeleteDBInstanceInput{
DBInstanceIdentifier: aws.String(instanceName),
SkipFinalSnapshot: aws.Bool(true),
DeleteAutomatedBackups: aws.Bool(true),
})
if err != nil {
log.Printf("Couldn't delete instance %v: %v\n", instanceName, err)
return err
} else {
return nil
}
}
// GetEngineVersions gets database engine versions that are available for the specified engine
// and parameter group family.
func (clusters *DbClusters) GetEngineVersions(ctx context.Context, engine string, parameterGroupFamily string) (
[]types.DBEngineVersion, error) {
output, err := clusters.AuroraClient.DescribeDBEngineVersions(ctx,
&rds.DescribeDBEngineVersionsInput{
Engine: aws.String(engine),
DBParameterGroupFamily: aws.String(parameterGroupFamily),
})
if err != nil {
log.Printf("Couldn't get engine versions for %v: %v\n", engine, err)
return nil, err
} else {
return output.DBEngineVersions, nil
}
}
// GetOrderableInstances uses a paginator to get DB instance options that can be used to create DB instances that are
// compatible with a set of specifications.
func (clusters *DbClusters) GetOrderableInstances(ctx context.Context, engine string, engineVersion string) (
[]types.OrderableDBInstanceOption, error) {
var output *rds.DescribeOrderableDBInstanceOptionsOutput
var instances []types.OrderableDBInstanceOption
var err error
orderablePaginator := rds.NewDescribeOrderableDBInstanceOptionsPaginator(clusters.AuroraClient,
&rds.DescribeOrderableDBInstanceOptionsInput{
Engine: aws.String(engine),
EngineVersion: aws.String(engineVersion),
})
for orderablePaginator.HasMorePages() {
output, err = orderablePaginator.NextPage(ctx)
if err != nil {
log.Printf("Couldn't get orderable DB instances: %v\n", err)
break
} else {
instances = append(instances, output.OrderableDBInstanceOptions...)
}
}
return instances, err
}
```
+ Pour plus d’informations sur l’API consultez les rubriques suivantes dans la *référence de l’API AWS SDK pour Go *.
+ [CréerDBCluster](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBCluster)
+ [CréerDBClusterParameterGroup](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBClusterParameterGroup)
+ [Créer un DBCluster instantané](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBClusterSnapshot)
+ [CréerDBInstance](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBInstance)
+ [SuppressionDBCluster](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DeleteDBCluster)
+ [SuppressionDBClusterParameterGroup](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DeleteDBClusterParameterGroup)
+ [SuppressionDBInstance](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DeleteDBInstance)
+ [DécrireDBClusterParameterGroups](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusterParameterGroups)
+ [Décrire DBCluster les paramètres](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusterParameters)
+ [Décrire les DBCluster instantanés](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusterSnapshots)
+ [DécrireDBClusters](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusters)
+ [Décrire DBEngine les versions](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBEngineVersions)
+ [DécrireDBInstances](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeOrderableDBInstanceOptions)
+ [ModifyDBClusterParameterGroup](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.ModifyDBClusterParameterGroup)
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
/**
* Before running this Java (v2) 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-java/latest/developer-guide/get-started.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 details, see:
*
* https://docs.aws.amazon.com/secretsmanager/latest/userguide/integrating_how-services-use-secrets_RS.html
*
* This Java example performs the following tasks:
*
* 1. Gets available engine families for Amazon Aurora MySQL-Compatible Edition
* by calling the DescribeDbEngineVersions(Engine='aurora-mysql') method.
* 2. Selects an engine family and creates a custom DB cluster parameter group
* by invoking the describeDBClusterParameters method.
* 3. Gets the parameter groups by invoking the describeDBClusterParameterGroups
* method.
* 4. Gets parameters in the group by invoking the describeDBClusterParameters
* method.
* 5. Modifies the auto_increment_offset parameter by invoking the
* modifyDbClusterParameterGroupRequest method.
* 6. Gets and displays the updated parameters.
* 7. Gets a list of allowed engine versions by invoking the
* describeDbEngineVersions method.
* 8. Creates an Aurora DB cluster database cluster that contains a MySQL
* 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 DB instance to be ready.
* 13. Creates a snapshot.
* 14. Waits for DB snapshot to be ready.
* 15. Deletes the DB cluster.
* 16. Deletes the DB cluster group.
*/
public class AuroraScenario {
public static long sleepTime = 20;
public static final String DASHES = new String(new char[80]).replace("\0", "-");
public static void main(String[] args) throws InterruptedException {
final String usage = "\n" +
"Usage:\n" +
" "
+
"Where:\n" +
" dbClusterGroupName - The name of the DB cluster parameter group. \n" +
" dbParameterGroupFamily - The DB cluster parameter group family name (for example, aurora-mysql5.7). \n"
+
" dbInstanceClusterIdentifier - The instance cluster identifier value.\n" +
" dbInstanceIdentifier - The database instance identifier.\n" +
" dbName - The database name.\n" +
" dbSnapshotIdentifier - The snapshot identifier.\n" +
" secretName - The name of the AWS Secrets Manager secret that contains the database credentials\"\n";
;
if (args.length != 7) {
System.out.println(usage);
System.exit(1);
}
String dbClusterGroupName = args[0];
String dbParameterGroupFamily = args[1];
String dbInstanceClusterIdentifier = args[2];
String dbInstanceIdentifier = args[3];
String dbName = args[4];
String dbSnapshotIdentifier = args[5];
String secretName = args[6];
// Retrieve the database credentials using AWS Secrets Manager.
Gson gson = new Gson();
User user = gson.fromJson(String.valueOf(getSecretValues(secretName)), User.class);
String username = user.getUsername();
String userPassword = user.getPassword();
Region region = Region.US_WEST_2;
RdsClient rdsClient = RdsClient.builder()
.region(region)
.build();
System.out.println(DASHES);
System.out.println("Welcome to the Amazon Aurora example scenario.");
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("1. Return a list of the available DB engines");
describeDBEngines(rdsClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("2. Create a custom parameter group");
createDBClusterParameterGroup(rdsClient, dbClusterGroupName, dbParameterGroupFamily);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("3. Get the parameter group");
describeDbClusterParameterGroups(rdsClient, dbClusterGroupName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("4. Get the parameters in the group");
describeDbClusterParameters(rdsClient, dbClusterGroupName, 0);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("5. Modify the auto_increment_offset parameter");
modifyDBClusterParas(rdsClient, dbClusterGroupName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("6. Display the updated parameter value");
describeDbClusterParameters(rdsClient, dbClusterGroupName, -1);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("7. Get a list of allowed engine versions");
getAllowedEngines(rdsClient, dbParameterGroupFamily);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("8. Create an Aurora DB cluster database");
String arnClusterVal = createDBCluster(rdsClient, dbClusterGroupName, dbName, dbInstanceClusterIdentifier,
username, userPassword);
System.out.println("The ARN of the cluster is " + arnClusterVal);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("9. Wait for DB instance to be ready");
waitForInstanceReady(rdsClient, dbInstanceClusterIdentifier);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("10. Get a list of instance classes available for the selected engine");
String instanceClass = getListInstanceClasses(rdsClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("11. Create a database instance in the cluster.");
String clusterDBARN = createDBInstanceCluster(rdsClient, dbInstanceIdentifier, dbInstanceClusterIdentifier,
instanceClass);
System.out.println("The ARN of the database is " + clusterDBARN);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("12. Wait for DB instance to be ready");
waitDBInstanceReady(rdsClient, dbInstanceIdentifier);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("13. Create a snapshot");
createDBClusterSnapshot(rdsClient, dbInstanceClusterIdentifier, dbSnapshotIdentifier);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("14. Wait for DB snapshot to be ready");
waitForSnapshotReady(rdsClient, dbSnapshotIdentifier, dbInstanceClusterIdentifier);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("14. Delete the DB instance");
deleteDatabaseInstance(rdsClient, dbInstanceIdentifier);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("15. Delete the DB cluster");
deleteCluster(rdsClient, dbInstanceClusterIdentifier);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("16. Delete the DB cluster group");
deleteDBClusterGroup(rdsClient, dbClusterGroupName, clusterDBARN);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("The Scenario has successfully completed.");
System.out.println(DASHES);
rdsClient.close();
}
private static SecretsManagerClient getSecretClient() {
Region region = Region.US_WEST_2;
return SecretsManagerClient.builder()
.region(region)
.credentialsProvider(EnvironmentVariableCredentialsProvider.create())
.build();
}
private static String getSecretValues(String secretName) {
SecretsManagerClient secretClient = getSecretClient();
GetSecretValueRequest valueRequest = GetSecretValueRequest.builder()
.secretId(secretName)
.build();
GetSecretValueResponse valueResponse = secretClient.getSecretValue(valueRequest);
return valueResponse.secretString();
}
public static void deleteDBClusterGroup(RdsClient rdsClient, String dbClusterGroupName, String clusterDBARN)
throws InterruptedException {
try {
boolean isDataDel = false;
boolean didFind;
String instanceARN;
// Make sure that the database has been deleted.
while (!isDataDel) {
DescribeDbInstancesResponse response = rdsClient.describeDBInstances();
List instanceList = response.dbInstances();
int listSize = instanceList.size();
didFind = false;
int index = 1;
for (DBInstance instance : instanceList) {
instanceARN = instance.dbInstanceArn();
if (instanceARN.compareTo(clusterDBARN) == 0) {
System.out.println(clusterDBARN + " still exists");
didFind = true;
}
if ((index == listSize) && (!didFind)) {
// Went through the entire list and did not find the database ARN.
isDataDel = true;
}
Thread.sleep(sleepTime * 1000);
index++;
}
}
DeleteDbClusterParameterGroupRequest clusterParameterGroupRequest = DeleteDbClusterParameterGroupRequest
.builder()
.dbClusterParameterGroupName(dbClusterGroupName)
.build();
rdsClient.deleteDBClusterParameterGroup(clusterParameterGroupRequest);
System.out.println(dbClusterGroupName + " was deleted.");
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void deleteCluster(RdsClient rdsClient, String dbInstanceClusterIdentifier) {
try {
DeleteDbClusterRequest deleteDbClusterRequest = DeleteDbClusterRequest.builder()
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.skipFinalSnapshot(true)
.build();
rdsClient.deleteDBCluster(deleteDbClusterRequest);
System.out.println(dbInstanceClusterIdentifier + " was deleted!");
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void deleteDatabaseInstance(RdsClient rdsClient, String dbInstanceIdentifier) {
try {
DeleteDbInstanceRequest deleteDbInstanceRequest = DeleteDbInstanceRequest.builder()
.dbInstanceIdentifier(dbInstanceIdentifier)
.deleteAutomatedBackups(true)
.skipFinalSnapshot(true)
.build();
DeleteDbInstanceResponse response = rdsClient.deleteDBInstance(deleteDbInstanceRequest);
System.out.println("The status of the database is " + response.dbInstance().dbInstanceStatus());
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void waitForSnapshotReady(RdsClient rdsClient, String dbSnapshotIdentifier,
String dbInstanceClusterIdentifier) {
try {
boolean snapshotReady = false;
String snapshotReadyStr;
System.out.println("Waiting for the snapshot to become available.");
DescribeDbClusterSnapshotsRequest snapshotsRequest = DescribeDbClusterSnapshotsRequest.builder()
.dbClusterSnapshotIdentifier(dbSnapshotIdentifier)
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.build();
while (!snapshotReady) {
DescribeDbClusterSnapshotsResponse response = rdsClient.describeDBClusterSnapshots(snapshotsRequest);
List snapshotList = response.dbClusterSnapshots();
for (DBClusterSnapshot snapshot : snapshotList) {
snapshotReadyStr = snapshot.status();
if (snapshotReadyStr.contains("available")) {
snapshotReady = true;
} else {
System.out.println(".");
Thread.sleep(sleepTime * 5000);
}
}
}
System.out.println("The Snapshot is available!");
} catch (RdsException | InterruptedException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void createDBClusterSnapshot(RdsClient rdsClient, String dbInstanceClusterIdentifier,
String dbSnapshotIdentifier) {
try {
CreateDbClusterSnapshotRequest snapshotRequest = CreateDbClusterSnapshotRequest.builder()
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.dbClusterSnapshotIdentifier(dbSnapshotIdentifier)
.build();
CreateDbClusterSnapshotResponse response = rdsClient.createDBClusterSnapshot(snapshotRequest);
System.out.println("The Snapshot ARN is " + response.dbClusterSnapshot().dbClusterSnapshotArn());
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void waitDBInstanceReady(RdsClient rdsClient, String dbInstanceIdentifier) {
boolean instanceReady = false;
String instanceReadyStr;
System.out.println("Waiting for instance to become available.");
try {
DescribeDbInstancesRequest instanceRequest = DescribeDbInstancesRequest.builder()
.dbInstanceIdentifier(dbInstanceIdentifier)
.build();
String endpoint = "";
while (!instanceReady) {
DescribeDbInstancesResponse response = rdsClient.describeDBInstances(instanceRequest);
List instanceList = response.dbInstances();
for (DBInstance instance : instanceList) {
instanceReadyStr = instance.dbInstanceStatus();
if (instanceReadyStr.contains("available")) {
endpoint = instance.endpoint().address();
instanceReady = true;
} else {
System.out.print(".");
Thread.sleep(sleepTime * 1000);
}
}
}
System.out.println("Database instance is available! The connection endpoint is " + endpoint);
} catch (RdsException | InterruptedException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static String createDBInstanceCluster(RdsClient rdsClient,
String dbInstanceIdentifier,
String dbInstanceClusterIdentifier,
String instanceClass) {
try {
CreateDbInstanceRequest instanceRequest = CreateDbInstanceRequest.builder()
.dbInstanceIdentifier(dbInstanceIdentifier)
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.engine("aurora-mysql")
.dbInstanceClass(instanceClass)
.build();
CreateDbInstanceResponse response = rdsClient.createDBInstance(instanceRequest);
System.out.print("The status is " + response.dbInstance().dbInstanceStatus());
return response.dbInstance().dbInstanceArn();
} catch (RdsException e) {
System.err.println(e.getMessage());
System.exit(1);
}
return "";
}
public static String getListInstanceClasses(RdsClient rdsClient) {
try {
DescribeOrderableDbInstanceOptionsRequest optionsRequest = DescribeOrderableDbInstanceOptionsRequest
.builder()
.engine("aurora-mysql")
.maxRecords(20)
.build();
DescribeOrderableDbInstanceOptionsResponse response = rdsClient
.describeOrderableDBInstanceOptions(optionsRequest);
List instanceOptions = response.orderableDBInstanceOptions();
String instanceClass = "";
for (OrderableDBInstanceOption instanceOption : instanceOptions) {
instanceClass = instanceOption.dbInstanceClass();
System.out.println("The instance class is " + instanceOption.dbInstanceClass());
System.out.println("The engine version is " + instanceOption.engineVersion());
}
return instanceClass;
} catch (RdsException e) {
System.err.println(e.getMessage());
System.exit(1);
}
return "";
}
// Waits until the database instance is available.
public static void waitForInstanceReady(RdsClient rdsClient, String dbClusterIdentifier) {
boolean instanceReady = false;
String instanceReadyStr;
System.out.println("Waiting for instance to become available.");
try {
DescribeDbClustersRequest instanceRequest = DescribeDbClustersRequest.builder()
.dbClusterIdentifier(dbClusterIdentifier)
.build();
while (!instanceReady) {
DescribeDbClustersResponse response = rdsClient.describeDBClusters(instanceRequest);
List clusterList = response.dbClusters();
for (DBCluster cluster : clusterList) {
instanceReadyStr = cluster.status();
if (instanceReadyStr.contains("available")) {
instanceReady = true;
} else {
System.out.print(".");
Thread.sleep(sleepTime * 1000);
}
}
}
System.out.println("Database cluster is available!");
} catch (RdsException | InterruptedException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static String createDBCluster(RdsClient rdsClient, String dbParameterGroupFamily, String dbName,
String dbClusterIdentifier, String userName, String password) {
try {
CreateDbClusterRequest clusterRequest = CreateDbClusterRequest.builder()
.databaseName(dbName)
.dbClusterIdentifier(dbClusterIdentifier)
.dbClusterParameterGroupName(dbParameterGroupFamily)
.engine("aurora-mysql")
.masterUsername(userName)
.masterUserPassword(password)
.build();
CreateDbClusterResponse response = rdsClient.createDBCluster(clusterRequest);
return response.dbCluster().dbClusterArn();
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
// Get a list of allowed engine versions.
public static void getAllowedEngines(RdsClient rdsClient, String dbParameterGroupFamily) {
try {
DescribeDbEngineVersionsRequest versionsRequest = DescribeDbEngineVersionsRequest.builder()
.dbParameterGroupFamily(dbParameterGroupFamily)
.engine("aurora-mysql")
.build();
DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(versionsRequest);
List dbEngines = response.dbEngineVersions();
for (DBEngineVersion dbEngine : dbEngines) {
System.out.println("The engine version is " + dbEngine.engineVersion());
System.out.println("The engine description is " + dbEngine.dbEngineDescription());
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
// Modify the auto_increment_offset parameter.
public static void modifyDBClusterParas(RdsClient rdsClient, String dClusterGroupName) {
try {
Parameter parameter1 = Parameter.builder()
.parameterName("auto_increment_offset")
.applyMethod("immediate")
.parameterValue("5")
.build();
List paraList = new ArrayList<>();
paraList.add(parameter1);
ModifyDbClusterParameterGroupRequest groupRequest = ModifyDbClusterParameterGroupRequest.builder()
.dbClusterParameterGroupName(dClusterGroupName)
.parameters(paraList)
.build();
ModifyDbClusterParameterGroupResponse response = rdsClient.modifyDBClusterParameterGroup(groupRequest);
System.out.println(
"The parameter group " + response.dbClusterParameterGroupName() + " was successfully modified");
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void describeDbClusterParameters(RdsClient rdsClient, String dbCLusterGroupName, int flag) {
try {
DescribeDbClusterParametersRequest dbParameterGroupsRequest;
if (flag == 0) {
dbParameterGroupsRequest = DescribeDbClusterParametersRequest.builder()
.dbClusterParameterGroupName(dbCLusterGroupName)
.build();
} else {
dbParameterGroupsRequest = DescribeDbClusterParametersRequest.builder()
.dbClusterParameterGroupName(dbCLusterGroupName)
.source("user")
.build();
}
DescribeDbClusterParametersResponse response = rdsClient
.describeDBClusterParameters(dbParameterGroupsRequest);
List dbParameters = response.parameters();
String paraName;
for (Parameter para : dbParameters) {
// Only print out information about either auto_increment_offset or
// auto_increment_increment.
paraName = para.parameterName();
if ((paraName.compareTo("auto_increment_offset") == 0)
|| (paraName.compareTo("auto_increment_increment ") == 0)) {
System.out.println("*** The parameter name is " + paraName);
System.out.println("*** The parameter value is " + para.parameterValue());
System.out.println("*** The parameter data type is " + para.dataType());
System.out.println("*** The parameter description is " + para.description());
System.out.println("*** The parameter allowed values is " + para.allowedValues());
}
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void describeDbClusterParameterGroups(RdsClient rdsClient, String dbClusterGroupName) {
try {
DescribeDbClusterParameterGroupsRequest groupsRequest = DescribeDbClusterParameterGroupsRequest.builder()
.dbClusterParameterGroupName(dbClusterGroupName)
.maxRecords(20)
.build();
List groups = rdsClient.describeDBClusterParameterGroups(groupsRequest)
.dbClusterParameterGroups();
for (DBClusterParameterGroup group : groups) {
System.out.println("The group name is " + group.dbClusterParameterGroupName());
System.out.println("The group ARN is " + group.dbClusterParameterGroupArn());
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void createDBClusterParameterGroup(RdsClient rdsClient, String dbClusterGroupName,
String dbParameterGroupFamily) {
try {
CreateDbClusterParameterGroupRequest groupRequest = CreateDbClusterParameterGroupRequest.builder()
.dbClusterParameterGroupName(dbClusterGroupName)
.dbParameterGroupFamily(dbParameterGroupFamily)
.description("Created by using the AWS SDK for Java")
.build();
CreateDbClusterParameterGroupResponse response = rdsClient.createDBClusterParameterGroup(groupRequest);
System.out.println("The group name is " + response.dbClusterParameterGroup().dbClusterParameterGroupName());
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
public static void describeDBEngines(RdsClient rdsClient) {
try {
DescribeDbEngineVersionsRequest engineVersionsRequest = DescribeDbEngineVersionsRequest.builder()
.engine("aurora-mysql")
.defaultOnly(true)
.maxRecords(20)
.build();
DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(engineVersionsRequest);
List engines = response.dbEngineVersions();
// Get all DBEngineVersion objects.
for (DBEngineVersion engineOb : engines) {
System.out.println("The name of the DB parameter group family for the database engine is "
+ engineOb.dbParameterGroupFamily());
System.out.println("The name of the database engine " + engineOb.engine());
System.out.println("The version number of the database engine " + engineOb.engineVersion());
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
}
```
+ Pour plus de détails sur l’API, consultez les rubriques suivantes dans la *Référence des API du kit AWS SDK for Java 2.x *.
+ [CréerDBCluster](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBCluster)
+ [CréerDBClusterParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterParameterGroup)
+ [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterSnapshot)
+ [CréerDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBInstance)
+ [SuppressionDBCluster](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBCluster)
+ [SuppressionDBClusterParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBClusterParameterGroup)
+ [SuppressionDBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBInstance)
+ [DécrireDBClusterParameterGroups](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterParameterGroups)
+ [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterParameters)
+ [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterSnapshots)
+ [DécrireDBClusters](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusters)
+ [Décrire DBEngine les versions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBEngineVersions)
+ [DécrireDBInstances](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [ModifyDBClusterParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBClusterParameterGroup)
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
}
```
+ Pour plus de détails sur l’API, consultez les rubriques suivantes dans la *Référence des API du kit AWS SDK pour Kotlin*.
+ [CréerDBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CréerDBClusterParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Créer un DBCluster instantané](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CréerDBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [SuppressionDBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [SuppressionDBClusterParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [SuppressionDBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DécrireDBClusterParameterGroups](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Décrire DBCluster les paramètres](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Décrire les DBCluster instantanés](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DécrireDBClusters](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [Décrire DBEngine les versions](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DécrireDBInstances](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeOrderableDBInstanceOptions](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ModifyDBClusterParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
Exécutez un scénario interactif à une invite de commande.
```
class AuroraClusterScenario:
"""Runs a scenario that shows how to get started using Aurora DB clusters."""
def __init__(self, aurora_wrapper):
"""
:param aurora_wrapper: An object that wraps Aurora DB cluster actions.
"""
self.aurora_wrapper = aurora_wrapper
def create_parameter_group(self, db_engine, parameter_group_name):
"""
Shows how to get available engine versions for a specified database engine and
create a DB cluster parameter group that is compatible with a selected engine family.
:param db_engine: The database engine to use as a basis.
:param parameter_group_name: The name given to the newly created parameter group.
:return: The newly created parameter group.
"""
print(
f"Checking for an existing DB cluster parameter group named {parameter_group_name}."
)
parameter_group = self.aurora_wrapper.get_parameter_group(parameter_group_name)
if parameter_group is None:
print(f"Getting available database engine versions for {db_engine}.")
engine_versions = self.aurora_wrapper.get_engine_versions(db_engine)
families = list({ver["DBParameterGroupFamily"] for ver in engine_versions})
family_index = q.choose("Which family do you want to use? ", families)
print(f"Creating a DB cluster parameter group.")
self.aurora_wrapper.create_parameter_group(
parameter_group_name, families[family_index], "Example parameter group."
)
parameter_group = self.aurora_wrapper.get_parameter_group(
parameter_group_name
)
print(f"Parameter group {parameter_group['DBClusterParameterGroupName']}:")
pp(parameter_group)
print("-" * 88)
return parameter_group
def set_user_parameters(self, parameter_group_name):
"""
Shows how to get the parameters contained in a custom parameter group and
update some of the parameter values in the group.
:param parameter_group_name: The name of the parameter group to query and modify.
"""
print("Let's set some parameter values in your parameter group.")
auto_inc_parameters = self.aurora_wrapper.get_parameters(
parameter_group_name, name_prefix="auto_increment"
)
update_params = []
for auto_inc in auto_inc_parameters:
if auto_inc["IsModifiable"] and auto_inc["DataType"] == "integer":
print(f"The {auto_inc['ParameterName']} parameter is described as:")
print(f"\t{auto_inc['Description']}")
param_range = auto_inc["AllowedValues"].split("-")
auto_inc["ParameterValue"] = str(
q.ask(
f"Enter a value between {param_range[0]} and {param_range[1]}: ",
q.is_int,
q.in_range(int(param_range[0]), int(param_range[1])),
)
)
update_params.append(auto_inc)
self.aurora_wrapper.update_parameters(parameter_group_name, update_params)
print(
"You can get a list of parameters you've set by specifying a source of 'user'."
)
user_parameters = self.aurora_wrapper.get_parameters(
parameter_group_name, source="user"
)
pp(user_parameters)
print("-" * 88)
def create_cluster(self, cluster_name, db_engine, db_name, parameter_group):
"""
Shows how to create an Aurora DB cluster that contains a database of a specified
type. The database is also configured to use a custom DB cluster parameter group.
:param cluster_name: The name given to the newly created DB cluster.
:param db_engine: The engine of the created database.
:param db_name: The name given to the created database.
:param parameter_group: The parameter group that is associated with the DB cluster.
:return: The newly created DB cluster.
"""
print("Checking for an existing DB cluster.")
cluster = self.aurora_wrapper.get_db_cluster(cluster_name)
if cluster is None:
admin_username = q.ask(
"Enter an administrator user name for the database: ", q.non_empty
)
admin_password = q.ask(
"Enter a password for the administrator (at least 8 characters): ",
q.non_empty,
)
engine_versions = self.aurora_wrapper.get_engine_versions(
db_engine, parameter_group["DBParameterGroupFamily"]
)
engine_choices = [
ver["EngineVersionDescription"] for ver in engine_versions
]
print("The available engines for your parameter group are:")
engine_index = q.choose("Which engine do you want to use? ", engine_choices)
print(
f"Creating DB cluster {cluster_name} and database {db_name}.\n"
f"The DB cluster is configured to use\n"
f"your custom parameter group {parameter_group['DBClusterParameterGroupName']}\n"
f"and selected engine {engine_choices[engine_index]}.\n"
f"This typically takes several minutes."
)
cluster = self.aurora_wrapper.create_db_cluster(
cluster_name,
parameter_group["DBClusterParameterGroupName"],
db_name,
db_engine,
engine_versions[engine_index]["EngineVersion"],
admin_username,
admin_password,
)
while cluster.get("Status") != "available":
wait(30)
cluster = self.aurora_wrapper.get_db_cluster(cluster_name)
print("Cluster created and available.\n")
print("Cluster data:")
pp(cluster)
print("-" * 88)
return cluster
def create_instance(self, cluster):
"""
Shows how to create a DB instance in an existing Aurora DB cluster. A new DB cluster
contains no DB instances, so you must add one. The first DB instance that is added
to a DB cluster defaults to a read-write DB instance.
:param cluster: The DB cluster where the DB instance is added.
:return: The newly created DB instance.
"""
print("Checking for an existing database instance.")
cluster_name = cluster["DBClusterIdentifier"]
db_inst = self.aurora_wrapper.get_db_instance(cluster_name)
if db_inst is None:
print("Let's create a database instance in your DB cluster.")
print("First, choose a DB instance type:")
inst_opts = self.aurora_wrapper.get_orderable_instances(
cluster["Engine"], cluster["EngineVersion"]
)
inst_choices = list(
{
opt["DBInstanceClass"] + ", storage type: " + opt["StorageType"]
for opt in inst_opts
}
)
inst_index = q.choose(
"Which DB instance class do you want to use? ", inst_choices
)
print(
f"Creating a database instance. This typically takes several minutes."
)
db_inst = self.aurora_wrapper.create_instance_in_cluster(
cluster_name,
cluster_name,
cluster["Engine"],
inst_opts[inst_index]["DBInstanceClass"],
)
while db_inst.get("DBInstanceStatus") != "available":
wait(30)
db_inst = self.aurora_wrapper.get_db_instance(cluster_name)
print("Instance data:")
pp(db_inst)
print("-" * 88)
return db_inst
@staticmethod
def display_connection(cluster):
"""
Displays connection information about an Aurora DB cluster and tips on how to
connect to it.
:param cluster: The DB cluster to display.
"""
print(
"You can now connect to your database using your favorite MySql client.\n"
"One way to connect is by using the 'mysql' shell on an Amazon EC2 instance\n"
"that is running in the same VPC as your database cluster. Pass the endpoint,\n"
"port, and administrator user name to 'mysql' and enter your password\n"
"when prompted:\n"
)
print(
f"\n\tmysql -h {cluster['Endpoint']} -P {cluster['Port']} -u {cluster['MasterUsername']} -p\n"
)
print(
"For more information, see the User Guide for Aurora:\n"
"\thttps://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.CreatingConnecting.Aurora.html#CHAP_GettingStartedAurora.Aurora.Connect"
)
print("-" * 88)
def create_snapshot(self, cluster_name):
"""
Shows how to create a DB cluster snapshot and wait until it's available.
:param cluster_name: The name of a DB cluster to snapshot.
"""
if q.ask(
"Do you want to create a snapshot of your DB cluster (y/n)? ", q.is_yesno
):
snapshot_id = f"{cluster_name}-{uuid.uuid4()}"
print(
f"Creating a snapshot named {snapshot_id}. This typically takes a few minutes."
)
snapshot = self.aurora_wrapper.create_cluster_snapshot(
snapshot_id, cluster_name
)
while snapshot.get("Status") != "available":
wait(30)
snapshot = self.aurora_wrapper.get_cluster_snapshot(snapshot_id)
pp(snapshot)
print("-" * 88)
def cleanup(self, db_inst, cluster, parameter_group):
"""
Shows how to clean up a DB instance, DB cluster, and DB cluster parameter group.
Before the DB cluster parameter group can be deleted, all associated DB instances and
DB clusters must first be deleted.
:param db_inst: The DB instance to delete.
:param cluster: The DB cluster to delete.
:param parameter_group: The DB cluster parameter group to delete.
"""
cluster_name = cluster["DBClusterIdentifier"]
parameter_group_name = parameter_group["DBClusterParameterGroupName"]
if q.ask(
"\nDo you want to delete the database instance, DB cluster, and parameter "
"group (y/n)? ",
q.is_yesno,
):
print(f"Deleting database instance {db_inst['DBInstanceIdentifier']}.")
self.aurora_wrapper.delete_db_instance(db_inst["DBInstanceIdentifier"])
print(f"Deleting database cluster {cluster_name}.")
self.aurora_wrapper.delete_db_cluster(cluster_name)
print(
"Waiting for the DB instance and DB cluster to delete.\n"
"This typically takes several minutes."
)
while db_inst is not None or cluster is not None:
wait(30)
if db_inst is not None:
db_inst = self.aurora_wrapper.get_db_instance(
db_inst["DBInstanceIdentifier"]
)
if cluster is not None:
cluster = self.aurora_wrapper.get_db_cluster(
cluster["DBClusterIdentifier"]
)
print(f"Deleting parameter group {parameter_group_name}.")
self.aurora_wrapper.delete_parameter_group(parameter_group_name)
def run_scenario(self, db_engine, parameter_group_name, cluster_name, db_name):
print("-" * 88)
print(
"Welcome to the Amazon Relational Database Service (Amazon RDS) get started\n"
"with Aurora DB clusters demo."
)
print("-" * 88)
parameter_group = self.create_parameter_group(db_engine, parameter_group_name)
self.set_user_parameters(parameter_group_name)
cluster = self.create_cluster(cluster_name, db_engine, db_name, parameter_group)
wait(5)
db_inst = self.create_instance(cluster)
self.display_connection(cluster)
self.create_snapshot(cluster_name)
self.cleanup(db_inst, cluster, parameter_group)
print("\nThanks for watching!")
print("-" * 88)
if __name__ == "__main__":
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
try:
scenario = AuroraClusterScenario(AuroraWrapper.from_client())
scenario.run_scenario(
"aurora-mysql",
"doc-example-cluster-parameter-group",
"doc-example-aurora",
"docexampledb",
)
except Exception:
logging.exception("Something went wrong with the demo.")
```
Définissez des fonctions appelées par le scénario pour gérer des actions Aurora.
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def get_parameter_group(self, parameter_group_name):
"""
Gets a DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to retrieve.
:return: The requested parameter group.
"""
try:
response = self.rds_client.describe_db_cluster_parameter_groups(
DBClusterParameterGroupName=parameter_group_name
)
parameter_group = response["DBClusterParameterGroups"][0]
except ClientError as err:
if err.response["Error"]["Code"] == "DBParameterGroupNotFound":
logger.info("Parameter group %s does not exist.", parameter_group_name)
else:
logger.error(
"Couldn't get parameter group %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return parameter_group
def create_parameter_group(
self, parameter_group_name, parameter_group_family, description
):
"""
Creates a DB cluster parameter group that is based on the specified parameter group
family.
:param parameter_group_name: The name of the newly created parameter group.
:param parameter_group_family: The family that is used as the basis of the new
parameter group.
:param description: A description given to the parameter group.
:return: Data about the newly created parameter group.
"""
try:
response = self.rds_client.create_db_cluster_parameter_group(
DBClusterParameterGroupName=parameter_group_name,
DBParameterGroupFamily=parameter_group_family,
Description=description,
)
except ClientError as err:
logger.error(
"Couldn't create parameter group %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
def delete_parameter_group(self, parameter_group_name):
"""
Deletes a DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to delete.
:return: Data about the parameter group.
"""
try:
response = self.rds_client.delete_db_cluster_parameter_group(
DBClusterParameterGroupName=parameter_group_name
)
except ClientError as err:
logger.error(
"Couldn't delete parameter group %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
def get_parameters(self, parameter_group_name, name_prefix="", source=None):
"""
Gets the parameters that are contained in a DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to query.
:param name_prefix: When specified, the retrieved list of parameters is filtered
to contain only parameters that start with this prefix.
:param source: When specified, only parameters from this source are retrieved.
For example, a source of 'user' retrieves only parameters that
were set by a user.
:return: The list of requested parameters.
"""
try:
kwargs = {"DBClusterParameterGroupName": parameter_group_name}
if source is not None:
kwargs["Source"] = source
parameters = []
paginator = self.rds_client.get_paginator("describe_db_cluster_parameters")
for page in paginator.paginate(**kwargs):
parameters += [
p
for p in page["Parameters"]
if p["ParameterName"].startswith(name_prefix)
]
except ClientError as err:
logger.error(
"Couldn't get parameters for %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return parameters
def update_parameters(self, parameter_group_name, update_parameters):
"""
Updates parameters in a custom DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to update.
:param update_parameters: The parameters to update in the group.
:return: Data about the modified parameter group.
"""
try:
response = self.rds_client.modify_db_cluster_parameter_group(
DBClusterParameterGroupName=parameter_group_name,
Parameters=update_parameters,
)
except ClientError as err:
logger.error(
"Couldn't update parameters in %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
def get_db_cluster(self, cluster_name):
"""
Gets data about an Aurora DB cluster.
:param cluster_name: The name of the DB cluster to retrieve.
:return: The retrieved DB cluster.
"""
try:
response = self.rds_client.describe_db_clusters(
DBClusterIdentifier=cluster_name
)
cluster = response["DBClusters"][0]
except ClientError as err:
if err.response["Error"]["Code"] == "DBClusterNotFoundFault":
logger.info("Cluster %s does not exist.", cluster_name)
else:
logger.error(
"Couldn't verify the existence of DB cluster %s. Here's why: %s: %s",
cluster_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return cluster
def create_db_cluster(
self,
cluster_name,
parameter_group_name,
db_name,
db_engine,
db_engine_version,
admin_name,
admin_password,
):
"""
Creates a DB cluster that is configured to use the specified parameter group.
The newly created DB cluster contains a database that uses the specified engine and
engine version.
:param cluster_name: The name of the DB cluster to create.
:param parameter_group_name: The name of the parameter group to associate with
the DB cluster.
:param db_name: The name of the database to create.
:param db_engine: The database engine of the database that is created, such as MySql.
:param db_engine_version: The version of the database engine.
:param admin_name: The user name of the database administrator.
:param admin_password: The password of the database administrator.
:return: The newly created DB cluster.
"""
try:
response = self.rds_client.create_db_cluster(
DatabaseName=db_name,
DBClusterIdentifier=cluster_name,
DBClusterParameterGroupName=parameter_group_name,
Engine=db_engine,
EngineVersion=db_engine_version,
MasterUsername=admin_name,
MasterUserPassword=admin_password,
)
cluster = response["DBCluster"]
except ClientError as err:
logger.error(
"Couldn't create database %s. Here's why: %s: %s",
db_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return cluster
def delete_db_cluster(self, cluster_name):
"""
Deletes a DB cluster.
:param cluster_name: The name of the DB cluster to delete.
"""
try:
self.rds_client.delete_db_cluster(
DBClusterIdentifier=cluster_name, SkipFinalSnapshot=True
)
logger.info("Deleted DB cluster %s.", cluster_name)
except ClientError:
logger.exception("Couldn't delete DB cluster %s.", cluster_name)
raise
def create_cluster_snapshot(self, snapshot_id, cluster_id):
"""
Creates a snapshot of a DB cluster.
:param snapshot_id: The ID to give the created snapshot.
:param cluster_id: The DB cluster to snapshot.
:return: Data about the newly created snapshot.
"""
try:
response = self.rds_client.create_db_cluster_snapshot(
DBClusterSnapshotIdentifier=snapshot_id, DBClusterIdentifier=cluster_id
)
snapshot = response["DBClusterSnapshot"]
except ClientError as err:
logger.error(
"Couldn't create snapshot of %s. Here's why: %s: %s",
cluster_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return snapshot
def get_cluster_snapshot(self, snapshot_id):
"""
Gets a DB cluster snapshot.
:param snapshot_id: The ID of the snapshot to retrieve.
:return: The retrieved snapshot.
"""
try:
response = self.rds_client.describe_db_cluster_snapshots(
DBClusterSnapshotIdentifier=snapshot_id
)
snapshot = response["DBClusterSnapshots"][0]
except ClientError as err:
logger.error(
"Couldn't get DB cluster snapshot %s. Here's why: %s: %s",
snapshot_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return snapshot
def create_instance_in_cluster(
self, instance_id, cluster_id, db_engine, instance_class
):
"""
Creates a database instance in an existing DB cluster. The first database that is
created defaults to a read-write DB instance.
:param instance_id: The ID to give the newly created DB instance.
:param cluster_id: The ID of the DB cluster where the DB instance is created.
:param db_engine: The database engine of a database to create in the DB instance.
This must be compatible with the configured parameter group
of the DB cluster.
:param instance_class: The DB instance class for the newly created DB instance.
:return: Data about the newly created DB instance.
"""
try:
response = self.rds_client.create_db_instance(
DBInstanceIdentifier=instance_id,
DBClusterIdentifier=cluster_id,
Engine=db_engine,
DBInstanceClass=instance_class,
)
db_inst = response["DBInstance"]
except ClientError as err:
logger.error(
"Couldn't create DB instance %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return db_inst
def get_engine_versions(self, engine, parameter_group_family=None):
"""
Gets database engine versions that are available for the specified engine
and parameter group family.
:param engine: The database engine to look up.
:param parameter_group_family: When specified, restricts the returned list of
engine versions to those that are compatible with
this parameter group family.
:return: The list of database engine versions.
"""
try:
kwargs = {"Engine": engine}
if parameter_group_family is not None:
kwargs["DBParameterGroupFamily"] = parameter_group_family
response = self.rds_client.describe_db_engine_versions(**kwargs)
versions = response["DBEngineVersions"]
except ClientError as err:
logger.error(
"Couldn't get engine versions for %s. Here's why: %s: %s",
engine,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return versions
def get_orderable_instances(self, db_engine, db_engine_version):
"""
Gets DB instance options that can be used to create DB instances that are
compatible with a set of specifications.
:param db_engine: The database engine that must be supported by the DB instance.
:param db_engine_version: The engine version that must be supported by the DB instance.
:return: The list of DB instance options that can be used to create a compatible DB instance.
"""
try:
inst_opts = []
paginator = self.rds_client.get_paginator(
"describe_orderable_db_instance_options"
)
for page in paginator.paginate(
Engine=db_engine, EngineVersion=db_engine_version
):
inst_opts += page["OrderableDBInstanceOptions"]
except ClientError as err:
logger.error(
"Couldn't get orderable DB instances. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return inst_opts
def get_db_instance(self, instance_id):
"""
Gets data about a DB instance.
:param instance_id: The ID of the DB instance to retrieve.
:return: The retrieved DB instance.
"""
try:
response = self.rds_client.describe_db_instances(
DBInstanceIdentifier=instance_id
)
db_inst = response["DBInstances"][0]
except ClientError as err:
if err.response["Error"]["Code"] == "DBInstanceNotFound":
logger.info("Instance %s does not exist.", instance_id)
else:
logger.error(
"Couldn't get DB instance %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return db_inst
def delete_db_instance(self, instance_id):
"""
Deletes a DB instance.
:param instance_id: The ID of the DB instance to delete.
:return: Data about the deleted DB instance.
"""
try:
response = self.rds_client.delete_db_instance(
DBInstanceIdentifier=instance_id,
SkipFinalSnapshot=True,
DeleteAutomatedBackups=True,
)
db_inst = response["DBInstance"]
except ClientError as err:
logger.error(
"Couldn't delete DB instance %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return db_inst
```
+ Pour plus d’informations sur l’API, consultez les rubriques suivantes dans *AWS SDK for Python (Boto3) API Reference*.
+ [CréerDBCluster](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBCluster)
+ [CréerDBClusterParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterParameterGroup)
+ [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterSnapshot)
+ [CréerDBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBInstance)
+ [SuppressionDBCluster](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBCluster)
+ [SuppressionDBClusterParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBClusterParameterGroup)
+ [SuppressionDBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBInstance)
+ [DécrireDBClusterParameterGroups](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterParameterGroups)
+ [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterParameters)
+ [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterSnapshots)
+ [DécrireDBClusters](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusters)
+ [Décrire DBEngine les versions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBEngineVersions)
+ [DécrireDBInstances](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [ModifyDBClusterParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBClusterParameterGroup)
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
Une bibliothèque contenant les fonctions spécifiques au scénario Aurora.
```
use phf::{phf_set, Set};
use secrecy::SecretString;
use std::{collections::HashMap, fmt::Display, time::Duration};
use aws_sdk_rds::{
error::ProvideErrorMetadata,
operation::create_db_cluster_parameter_group::CreateDbClusterParameterGroupOutput,
types::{DbCluster, DbClusterParameterGroup, DbClusterSnapshot, DbInstance, Parameter},
};
use sdk_examples_test_utils::waiter::Waiter;
use tracing::{info, trace, warn};
const DB_ENGINE: &str = "aurora-mysql";
const DB_CLUSTER_PARAMETER_GROUP_NAME: &str = "RustSDKCodeExamplesDBParameterGroup";
const DB_CLUSTER_PARAMETER_GROUP_DESCRIPTION: &str =
"Parameter Group created by Rust SDK Code Example";
const DB_CLUSTER_IDENTIFIER: &str = "RustSDKCodeExamplesDBCluster";
const DB_INSTANCE_IDENTIFIER: &str = "RustSDKCodeExamplesDBInstance";
static FILTER_PARAMETER_NAMES: Set<&'static str> = phf_set! {
"auto_increment_offset",
"auto_increment_increment",
};
#[derive(Debug, PartialEq, Eq)]
struct MetadataError {
message: Option,
code: Option,
}
impl MetadataError {
fn from(err: &dyn ProvideErrorMetadata) -> Self {
MetadataError {
message: err.message().map(String::from),
code: err.code().map(String::from),
}
}
}
impl Display for MetadataError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let display = match (&self.message, &self.code) {
(None, None) => "Unknown".to_string(),
(None, Some(code)) => format!("({code})"),
(Some(message), None) => message.to_string(),
(Some(message), Some(code)) => format!("{message} ({code})"),
};
write!(f, "{display}")
}
}
#[derive(Debug, PartialEq, Eq)]
pub struct ScenarioError {
message: String,
context: Option,
}
impl ScenarioError {
pub fn with(message: impl Into) -> Self {
ScenarioError {
message: message.into(),
context: None,
}
}
pub fn new(message: impl Into, err: &dyn ProvideErrorMetadata) -> Self {
ScenarioError {
message: message.into(),
context: Some(MetadataError::from(err)),
}
}
}
impl std::error::Error for ScenarioError {}
impl Display for ScenarioError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match &self.context {
Some(c) => write!(f, "{}: {}", self.message, c),
None => write!(f, "{}", self.message),
}
}
}
// Parse the ParameterName, Description, and AllowedValues values and display them.
#[derive(Debug)]
pub struct AuroraScenarioParameter {
name: String,
allowed_values: String,
current_value: String,
}
impl Display for AuroraScenarioParameter {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}: {} (allowed: {})",
self.name, self.current_value, self.allowed_values
)
}
}
impl From for AuroraScenarioParameter {
fn from(value: aws_sdk_rds::types::Parameter) -> Self {
AuroraScenarioParameter {
name: value.parameter_name.unwrap_or_default(),
allowed_values: value.allowed_values.unwrap_or_default(),
current_value: value.parameter_value.unwrap_or_default(),
}
}
}
pub struct AuroraScenario {
rds: crate::rds::Rds,
engine_family: Option,
engine_version: Option,
instance_class: Option,
db_cluster_parameter_group: Option,
db_cluster_identifier: Option,
db_instance_identifier: Option,
username: Option,
password: Option,
}
impl AuroraScenario {
pub fn new(client: crate::rds::Rds) -> Self {
AuroraScenario {
rds: client,
engine_family: None,
engine_version: None,
instance_class: None,
db_cluster_parameter_group: None,
db_cluster_identifier: None,
db_instance_identifier: None,
username: None,
password: None,
}
}
// Get available engine families for Aurora MySql. rds.DescribeDbEngineVersions(Engine='aurora-mysql') and build a set of the 'DBParameterGroupFamily' field values. I get {aurora-mysql8.0, aurora-mysql5.7}.
pub async fn get_engines(&self) -> Result>, ScenarioError> {
let describe_db_engine_versions = self.rds.describe_db_engine_versions(DB_ENGINE).await;
trace!(versions=?describe_db_engine_versions, "full list of versions");
if let Err(err) = describe_db_engine_versions {
return Err(ScenarioError::new(
"Failed to retrieve DB Engine Versions",
&err,
));
};
let version_count = describe_db_engine_versions
.as_ref()
.map(|o| o.db_engine_versions().len())
.unwrap_or_default();
info!(version_count, "got list of versions");
// Create a map of engine families to their available versions.
let mut versions = HashMap::>::new();
describe_db_engine_versions
.unwrap()
.db_engine_versions()
.iter()
.filter_map(
|v| match (&v.db_parameter_group_family, &v.engine_version) {
(Some(family), Some(version)) => Some((family.clone(), version.clone())),
_ => None,
},
)
.for_each(|(family, version)| versions.entry(family).or_default().push(version));
Ok(versions)
}
pub async fn get_instance_classes(&self) -> Result, ScenarioError> {
let describe_orderable_db_instance_options_items = self
.rds
.describe_orderable_db_instance_options(
DB_ENGINE,
self.engine_version
.as_ref()
.expect("engine version for db instance options")
.as_str(),
)
.await;
describe_orderable_db_instance_options_items
.map(|options| {
options
.iter()
.filter(|o| o.storage_type() == Some("aurora"))
.map(|o| o.db_instance_class().unwrap_or_default().to_string())
.collect::>()
})
.map_err(|err| ScenarioError::new("Could not get available instance classes", &err))
}
// Select an engine family and create a custom DB cluster parameter group. rds.CreateDbClusterParameterGroup(DBParameterGroupFamily='aurora-mysql8.0')
pub async fn set_engine(&mut self, engine: &str, version: &str) -> Result<(), ScenarioError> {
self.engine_family = Some(engine.to_string());
self.engine_version = Some(version.to_string());
let create_db_cluster_parameter_group = self
.rds
.create_db_cluster_parameter_group(
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_PARAMETER_GROUP_DESCRIPTION,
engine,
)
.await;
match create_db_cluster_parameter_group {
Ok(CreateDbClusterParameterGroupOutput {
db_cluster_parameter_group: None,
..
}) => {
return Err(ScenarioError::with(
"CreateDBClusterParameterGroup had empty response",
));
}
Err(error) => {
if error.code() == Some("DBParameterGroupAlreadyExists") {
info!("Cluster Parameter Group already exists, nothing to do");
} else {
return Err(ScenarioError::new(
"Could not create Cluster Parameter Group",
&error,
));
}
}
_ => {
info!("Created Cluster Parameter Group");
}
}
Ok(())
}
pub fn set_instance_class(&mut self, instance_class: Option) {
self.instance_class = instance_class;
}
pub fn set_login(&mut self, username: Option, password: Option) {
self.username = username;
self.password = password;
}
pub async fn connection_string(&self) -> Result {
let cluster = self.get_cluster().await?;
let endpoint = cluster.endpoint().unwrap_or_default();
let port = cluster.port().unwrap_or_default();
let username = cluster.master_username().unwrap_or_default();
Ok(format!("mysql -h {endpoint} -P {port} -u {username} -p"))
}
pub async fn get_cluster(&self) -> Result {
let describe_db_clusters_output = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_ref()
.expect("cluster identifier")
.as_str(),
)
.await;
if let Err(err) = describe_db_clusters_output {
return Err(ScenarioError::new("Failed to get cluster", &err));
}
let db_cluster = describe_db_clusters_output
.unwrap()
.db_clusters
.and_then(|output| output.first().cloned());
db_cluster.ok_or_else(|| ScenarioError::with("Did not find the cluster"))
}
// Get the parameter group. rds.DescribeDbClusterParameterGroups
// Get parameters in the group. This is a long list so you will have to paginate. Find the auto_increment_offset and auto_increment_increment parameters (by ParameterName). rds.DescribeDbClusterParameters
// Parse the ParameterName, Description, and AllowedValues values and display them.
pub async fn cluster_parameters(&self) -> Result, ScenarioError> {
let parameters_output = self
.rds
.describe_db_cluster_parameters(DB_CLUSTER_PARAMETER_GROUP_NAME)
.await;
if let Err(err) = parameters_output {
return Err(ScenarioError::new(
format!("Failed to retrieve parameters for {DB_CLUSTER_PARAMETER_GROUP_NAME}"),
&err,
));
}
let parameters = parameters_output
.unwrap()
.into_iter()
.flat_map(|p| p.parameters.unwrap_or_default().into_iter())
.filter(|p| FILTER_PARAMETER_NAMES.contains(p.parameter_name().unwrap_or_default()))
.map(AuroraScenarioParameter::from)
.collect::>();
Ok(parameters)
}
// Modify both the auto_increment_offset and auto_increment_increment parameters in one call in the custom parameter group. Set their ParameterValue fields to a new allowable value. rds.ModifyDbClusterParameterGroup.
pub async fn update_auto_increment(
&self,
offset: u8,
increment: u8,
) -> Result<(), ScenarioError> {
let modify_db_cluster_parameter_group = self
.rds
.modify_db_cluster_parameter_group(
DB_CLUSTER_PARAMETER_GROUP_NAME,
vec![
Parameter::builder()
.parameter_name("auto_increment_offset")
.parameter_value(format!("{offset}"))
.apply_method(aws_sdk_rds::types::ApplyMethod::Immediate)
.build(),
Parameter::builder()
.parameter_name("auto_increment_increment")
.parameter_value(format!("{increment}"))
.apply_method(aws_sdk_rds::types::ApplyMethod::Immediate)
.build(),
],
)
.await;
if let Err(error) = modify_db_cluster_parameter_group {
return Err(ScenarioError::new(
"Failed to modify cluster parameter group",
&error,
));
}
Ok(())
}
// Get a list of allowed engine versions. rds.DescribeDbEngineVersions(Engine='aurora-mysql', DBParameterGroupFamily=)
// Create an Aurora DB cluster database cluster that contains a MySql database and uses the parameter group you created.
// Wait for DB cluster to be ready. Call rds.DescribeDBClusters and check for Status == 'available'.
// Get a list of instance classes available for the selected engine and engine version. rds.DescribeOrderableDbInstanceOptions(Engine='mysql', EngineVersion=).
// Create a database instance in the cluster.
// Wait for DB instance to be ready. Call rds.DescribeDbInstances and check for DBInstanceStatus == 'available'.
pub async fn start_cluster_and_instance(&mut self) -> Result<(), ScenarioError> {
if self.password.is_none() {
return Err(ScenarioError::with(
"Must set Secret Password before starting a cluster",
));
}
let create_db_cluster = self
.rds
.create_db_cluster(
DB_CLUSTER_IDENTIFIER,
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_ENGINE,
self.engine_version.as_deref().expect("engine version"),
self.username.as_deref().expect("username"),
self.password
.replace(SecretString::new("".to_string()))
.expect("password"),
)
.await;
if let Err(err) = create_db_cluster {
return Err(ScenarioError::new(
"Failed to create DB Cluster with cluster group",
&err,
));
}
self.db_cluster_identifier = create_db_cluster
.unwrap()
.db_cluster
.and_then(|c| c.db_cluster_identifier);
if self.db_cluster_identifier.is_none() {
return Err(ScenarioError::with("Created DB Cluster missing Identifier"));
}
info!(
"Started a db cluster: {}",
self.db_cluster_identifier
.as_deref()
.unwrap_or("Missing ARN")
);
let create_db_instance = self
.rds
.create_db_instance(
self.db_cluster_identifier.as_deref().expect("cluster name"),
DB_INSTANCE_IDENTIFIER,
self.instance_class.as_deref().expect("instance class"),
DB_ENGINE,
)
.await;
if let Err(err) = create_db_instance {
return Err(ScenarioError::new(
"Failed to create Instance in DB Cluster",
&err,
));
}
self.db_instance_identifier = create_db_instance
.unwrap()
.db_instance
.and_then(|i| i.db_instance_identifier);
// Cluster creation can take up to 20 minutes to become available
let cluster_max_wait = Duration::from_secs(20 * 60);
let waiter = Waiter::builder().max(cluster_max_wait).build();
while waiter.sleep().await.is_ok() {
let cluster = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = cluster {
warn!(?err, "Failed to describe cluster while waiting for ready");
continue;
}
let instance = self
.rds
.describe_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = instance {
return Err(ScenarioError::new(
"Failed to find instance for cluster",
&err,
));
}
let instances_available = instance
.unwrap()
.db_instances()
.iter()
.all(|instance| instance.db_instance_status() == Some("Available"));
let endpoints = self
.rds
.describe_db_cluster_endpoints(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = endpoints {
return Err(ScenarioError::new(
"Failed to find endpoint for cluster",
&err,
));
}
let endpoints_available = endpoints
.unwrap()
.db_cluster_endpoints()
.iter()
.all(|endpoint| endpoint.status() == Some("available"));
if instances_available && endpoints_available {
return Ok(());
}
}
Err(ScenarioError::with("timed out waiting for cluster"))
}
// Create a snapshot of the DB cluster. rds.CreateDbClusterSnapshot.
// Wait for the snapshot to create. rds.DescribeDbClusterSnapshots until Status == 'available'.
pub async fn snapshot(&self, name: &str) -> Result {
let id = self.db_cluster_identifier.as_deref().unwrap_or_default();
let snapshot = self
.rds
.snapshot_cluster(id, format!("{id}_{name}").as_str())
.await;
match snapshot {
Ok(output) => match output.db_cluster_snapshot {
Some(snapshot) => Ok(snapshot),
None => Err(ScenarioError::with("Missing Snapshot")),
},
Err(err) => Err(ScenarioError::new("Failed to create snapshot", &err)),
}
}
pub async fn clean_up(self) -> Result<(), Vec> {
let mut clean_up_errors: Vec = vec![];
// Delete the instance. rds.DeleteDbInstance.
let delete_db_instance = self
.rds
.delete_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = delete_db_instance {
let identifier = self
.db_instance_identifier
.as_deref()
.unwrap_or("Missing Instance Identifier");
let message = format!("failed to delete db instance {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance to delete
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_instances = self.rds.describe_db_instances().await;
if let Err(err) = describe_db_instances {
clean_up_errors.push(ScenarioError::new(
"Failed to check instance state during deletion",
&err,
));
break;
}
let db_instances = describe_db_instances
.unwrap()
.db_instances()
.iter()
.filter(|instance| instance.db_cluster_identifier == self.db_cluster_identifier)
.cloned()
.collect::>();
if db_instances.is_empty() {
trace!("Delete Instance waited and no instances were found");
break;
}
match db_instances.first().unwrap().db_instance_status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but instances is in {status}");
continue;
}
None => {
warn!("No status for DB instance");
break;
}
}
}
}
// Delete the DB cluster. rds.DeleteDbCluster.
let delete_db_cluster = self
.rds
.delete_db_cluster(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = delete_db_cluster {
let identifier = self
.db_cluster_identifier
.as_deref()
.unwrap_or("Missing DB Cluster Identifier");
let message = format!("failed to delete db cluster {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance and cluster to fully delete. rds.DescribeDbInstances and rds.DescribeDbClusters until both are not found.
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_clusters = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = describe_db_clusters {
clean_up_errors.push(ScenarioError::new(
"Failed to check cluster state during deletion",
&err,
));
break;
}
let describe_db_clusters = describe_db_clusters.unwrap();
let db_clusters = describe_db_clusters.db_clusters();
if db_clusters.is_empty() {
trace!("Delete cluster waited and no clusters were found");
break;
}
match db_clusters.first().unwrap().status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but clusters is in {status}");
continue;
}
None => {
warn!("No status for DB cluster");
break;
}
}
}
}
// Delete the DB cluster parameter group. rds.DeleteDbClusterParameterGroup.
let delete_db_cluster_parameter_group = self
.rds
.delete_db_cluster_parameter_group(
self.db_cluster_parameter_group
.map(|g| {
g.db_cluster_parameter_group_name
.unwrap_or_else(|| DB_CLUSTER_PARAMETER_GROUP_NAME.to_string())
})
.as_deref()
.expect("cluster parameter group name"),
)
.await;
if let Err(error) = delete_db_cluster_parameter_group {
clean_up_errors.push(ScenarioError::new(
"Failed to delete the db cluster parameter group",
&error,
))
}
if clean_up_errors.is_empty() {
Ok(())
} else {
Err(clean_up_errors)
}
}
}
#[cfg(test)]
pub mod tests;
```
Teste la bibliothèque à l’aide de simulations automatiques autour de l’encapsuleur du client RDS.
```
use crate::rds::MockRdsImpl;
use super::*;
use std::io::{Error, ErrorKind};
use assert_matches::assert_matches;
use aws_sdk_rds::{
error::SdkError,
operation::{
create_db_cluster::{CreateDBClusterError, CreateDbClusterOutput},
create_db_cluster_parameter_group::CreateDBClusterParameterGroupError,
create_db_cluster_snapshot::{CreateDBClusterSnapshotError, CreateDbClusterSnapshotOutput},
create_db_instance::{CreateDBInstanceError, CreateDbInstanceOutput},
delete_db_cluster::DeleteDbClusterOutput,
delete_db_cluster_parameter_group::DeleteDbClusterParameterGroupOutput,
delete_db_instance::DeleteDbInstanceOutput,
describe_db_cluster_endpoints::DescribeDbClusterEndpointsOutput,
describe_db_cluster_parameters::{
DescribeDBClusterParametersError, DescribeDbClusterParametersOutput,
},
describe_db_clusters::{DescribeDBClustersError, DescribeDbClustersOutput},
describe_db_engine_versions::{
DescribeDBEngineVersionsError, DescribeDbEngineVersionsOutput,
},
describe_db_instances::{DescribeDBInstancesError, DescribeDbInstancesOutput},
describe_orderable_db_instance_options::DescribeOrderableDBInstanceOptionsError,
modify_db_cluster_parameter_group::{
ModifyDBClusterParameterGroupError, ModifyDbClusterParameterGroupOutput,
},
},
types::{
error::DbParameterGroupAlreadyExistsFault, DbClusterEndpoint, DbEngineVersion,
OrderableDbInstanceOption,
},
};
use aws_smithy_runtime_api::http::{Response, StatusCode};
use aws_smithy_types::body::SdkBody;
use mockall::predicate::eq;
use secrecy::ExposeSecret;
#[tokio::test]
async fn test_scenario_set_engine() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.with(
eq("RustSDKCodeExamplesDBParameterGroup"),
eq("Parameter Group created by Rust SDK Code Example"),
eq("aurora-mysql"),
)
.return_once(|_, _, _| {
Ok(CreateDbClusterParameterGroupOutput::builder()
.db_cluster_parameter_group(DbClusterParameterGroup::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
let set_engine = scenario.set_engine("aurora-mysql", "aurora-mysql8.0").await;
assert_eq!(set_engine, Ok(()));
assert_eq!(Some("aurora-mysql"), scenario.engine_family.as_deref());
assert_eq!(Some("aurora-mysql8.0"), scenario.engine_version.as_deref());
}
#[tokio::test]
async fn test_scenario_set_engine_not_create() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.with(
eq("RustSDKCodeExamplesDBParameterGroup"),
eq("Parameter Group created by Rust SDK Code Example"),
eq("aurora-mysql"),
)
.return_once(|_, _, _| Ok(CreateDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
let set_engine = scenario.set_engine("aurora-mysql", "aurora-mysql8.0").await;
assert!(set_engine.is_err());
}
#[tokio::test]
async fn test_scenario_set_engine_param_group_exists() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.withf(|_, _, _| true)
.return_once(|_, _, _| {
Err(SdkError::service_error(
CreateDBClusterParameterGroupError::DbParameterGroupAlreadyExistsFault(
DbParameterGroupAlreadyExistsFault::builder().build(),
),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
let set_engine = scenario.set_engine("aurora-mysql", "aurora-mysql8.0").await;
assert!(set_engine.is_err());
}
#[tokio::test]
async fn test_scenario_get_engines() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_engine_versions()
.with(eq("aurora-mysql"))
.return_once(|_| {
Ok(DescribeDbEngineVersionsOutput::builder()
.db_engine_versions(
DbEngineVersion::builder()
.db_parameter_group_family("f1")
.engine_version("f1a")
.build(),
)
.db_engine_versions(
DbEngineVersion::builder()
.db_parameter_group_family("f1")
.engine_version("f1b")
.build(),
)
.db_engine_versions(
DbEngineVersion::builder()
.db_parameter_group_family("f2")
.engine_version("f2a")
.build(),
)
.db_engine_versions(DbEngineVersion::builder().build())
.build())
});
let scenario = AuroraScenario::new(mock_rds);
let versions_map = scenario.get_engines().await;
assert_eq!(
versions_map,
Ok(HashMap::from([
("f1".into(), vec!["f1a".into(), "f1b".into()]),
("f2".into(), vec!["f2a".into()])
]))
);
}
#[tokio::test]
async fn test_scenario_get_engines_failed() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_engine_versions()
.with(eq("aurora-mysql"))
.return_once(|_| {
Err(SdkError::service_error(
DescribeDBEngineVersionsError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe_db_engine_versions error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let scenario = AuroraScenario::new(mock_rds);
let versions_map = scenario.get_engines().await;
assert_matches!(
versions_map,
Err(ScenarioError { message, context: _ }) if message == "Failed to retrieve DB Engine Versions"
);
}
#[tokio::test]
async fn test_scenario_get_instance_classes() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.return_once(|_, _, _| {
Ok(CreateDbClusterParameterGroupOutput::builder()
.db_cluster_parameter_group(DbClusterParameterGroup::builder().build())
.build())
});
mock_rds
.expect_describe_orderable_db_instance_options()
.with(eq("aurora-mysql"), eq("aurora-mysql8.0"))
.return_once(|_, _| {
Ok(vec![
OrderableDbInstanceOption::builder()
.db_instance_class("t1")
.storage_type("aurora")
.build(),
OrderableDbInstanceOption::builder()
.db_instance_class("t1")
.storage_type("aurora-iopt1")
.build(),
OrderableDbInstanceOption::builder()
.db_instance_class("t2")
.storage_type("aurora")
.build(),
OrderableDbInstanceOption::builder()
.db_instance_class("t3")
.storage_type("aurora")
.build(),
])
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario
.set_engine("aurora-mysql", "aurora-mysql8.0")
.await
.expect("set engine");
let instance_classes = scenario.get_instance_classes().await;
assert_eq!(
instance_classes,
Ok(vec!["t1".into(), "t2".into(), "t3".into()])
);
}
#[tokio::test]
async fn test_scenario_get_instance_classes_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_orderable_db_instance_options()
.with(eq("aurora-mysql"), eq("aurora-mysql8.0"))
.return_once(|_, _| {
Err(SdkError::service_error(
DescribeOrderableDBInstanceOptionsError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe_orderable_db_instance_options_error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_family = Some("aurora-mysql".into());
scenario.engine_version = Some("aurora-mysql8.0".into());
let instance_classes = scenario.get_instance_classes().await;
assert_matches!(
instance_classes,
Err(ScenarioError {message, context: _}) if message == "Could not get available instance classes"
);
}
#[tokio::test]
async fn test_scenario_get_cluster() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let cluster = scenario.get_cluster().await;
assert!(cluster.is_ok());
}
#[tokio::test]
async fn test_scenario_get_cluster_missing_cluster() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.return_once(|_, _, _| {
Ok(CreateDbClusterParameterGroupOutput::builder()
.db_cluster_parameter_group(DbClusterParameterGroup::builder().build())
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| Ok(DescribeDbClustersOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let cluster = scenario.get_cluster().await;
assert_matches!(cluster, Err(ScenarioError { message, context: _ }) if message == "Did not find the cluster");
}
#[tokio::test]
async fn test_scenario_get_cluster_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.return_once(|_, _, _| {
Ok(CreateDbClusterParameterGroupOutput::builder()
.db_cluster_parameter_group(DbClusterParameterGroup::builder().build())
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe_db_clusters_error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let cluster = scenario.get_cluster().await;
assert_matches!(cluster, Err(ScenarioError { message, context: _ }) if message == "Failed to get cluster");
}
#[tokio::test]
async fn test_scenario_connection_string() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.endpoint("test_endpoint")
.port(3306)
.master_username("test_username")
.build(),
)
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let connection_string = scenario.connection_string().await;
assert_eq!(
connection_string,
Ok("mysql -h test_endpoint -P 3306 -u test_username -p".into())
);
}
#[tokio::test]
async fn test_scenario_cluster_parameters() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_cluster_parameters()
.with(eq("RustSDKCodeExamplesDBParameterGroup"))
.return_once(|_| {
Ok(vec![DescribeDbClusterParametersOutput::builder()
.parameters(Parameter::builder().parameter_name("a").build())
.parameters(Parameter::builder().parameter_name("b").build())
.parameters(
Parameter::builder()
.parameter_name("auto_increment_offset")
.build(),
)
.parameters(Parameter::builder().parameter_name("c").build())
.parameters(
Parameter::builder()
.parameter_name("auto_increment_increment")
.build(),
)
.parameters(Parameter::builder().parameter_name("d").build())
.build()])
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let params = scenario.cluster_parameters().await.expect("cluster params");
let names: Vec = params.into_iter().map(|p| p.name).collect();
assert_eq!(
names,
vec!["auto_increment_offset", "auto_increment_increment"]
);
}
#[tokio::test]
async fn test_scenario_cluster_parameters_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_cluster_parameters()
.with(eq("RustSDKCodeExamplesDBParameterGroup"))
.return_once(|_| {
Err(SdkError::service_error(
DescribeDBClusterParametersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe_db_cluster_parameters_error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let params = scenario.cluster_parameters().await;
assert_matches!(params, Err(ScenarioError { message, context: _ }) if message == "Failed to retrieve parameters for RustSDKCodeExamplesDBParameterGroup");
}
#[tokio::test]
async fn test_scenario_update_auto_increment() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_modify_db_cluster_parameter_group()
.withf(|name, params| {
assert_eq!(name, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(
params,
&vec![
Parameter::builder()
.parameter_name("auto_increment_offset")
.parameter_value("10")
.apply_method(aws_sdk_rds::types::ApplyMethod::Immediate)
.build(),
Parameter::builder()
.parameter_name("auto_increment_increment")
.parameter_value("20")
.apply_method(aws_sdk_rds::types::ApplyMethod::Immediate)
.build(),
]
);
true
})
.return_once(|_, _| Ok(ModifyDbClusterParameterGroupOutput::builder().build()));
let scenario = AuroraScenario::new(mock_rds);
scenario
.update_auto_increment(10, 20)
.await
.expect("update auto increment");
}
#[tokio::test]
async fn test_scenario_update_auto_increment_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_modify_db_cluster_parameter_group()
.return_once(|_, _| {
Err(SdkError::service_error(
ModifyDBClusterParameterGroupError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"modify_db_cluster_parameter_group_error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let scenario = AuroraScenario::new(mock_rds);
let update = scenario.update_auto_increment(10, 20).await;
assert_matches!(update, Err(ScenarioError { message, context: _}) if message == "Failed to modify cluster parameter group");
}
#[tokio::test]
async fn test_start_cluster_and_instance() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_describe_db_instance()
.with(eq("RustSDKCodeExamplesDBInstance"))
.return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
assert!(scenario
.password
.replace(SecretString::new("BAD SECRET".into()))
.unwrap()
.expose_secret()
.is_empty());
assert_eq!(
scenario.db_cluster_identifier,
Some("RustSDKCodeExamplesDBCluster".into())
);
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Err(SdkError::service_error(
CreateDBClusterError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _}) if message == "Failed to create DB Cluster with cluster group")
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_missing_id() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context:_ }) if message == "Created DB Cluster missing Identifier");
}
#[tokio::test]
async fn test_start_cluster_and_instance_instance_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.return_once(|_, _, _, _| {
Err(SdkError::service_error(
CreateDBInstanceError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db instance error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _ }) if message == "Failed to create Instance in DB Cluster")
}
#[tokio::test]
async fn test_start_cluster_and_instance_wait_hiccup() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
})
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds.expect_describe_db_instance().return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_scenario_clean_up() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| Ok(DescribeDbInstancesOutput::builder().build()));
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| Ok(DescribeDbClustersOutput::builder().build()));
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_scenario_clean_up_errors() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| {
Err(SdkError::service_error(
DescribeDBInstancesError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db instances error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db clusters error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_err());
let errs = clean_up.unwrap_err();
assert_eq!(errs.len(), 2);
assert_matches!(errs.first(), Some(ScenarioError {message, context: _}) if message == "Failed to check instance state during deletion");
assert_matches!(errs.get(1), Some(ScenarioError {message, context: _}) if message == "Failed to check cluster state during deletion");
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_scenario_snapshot() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_snapshot_cluster()
.with(eq("MockCluster"), eq("MockCluster_MockSnapshot"))
.times(1)
.return_once(|_, _| {
Ok(CreateDbClusterSnapshotOutput::builder()
.db_cluster_snapshot(
DbClusterSnapshot::builder()
.db_cluster_identifier("MockCluster")
.db_cluster_snapshot_identifier("MockCluster_MockSnapshot")
.build(),
)
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("MockCluster".into());
let create_snapshot = scenario.snapshot("MockSnapshot").await;
assert!(create_snapshot.is_ok());
}
#[tokio::test]
async fn test_scenario_snapshot_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_snapshot_cluster()
.with(eq("MockCluster"), eq("MockCluster_MockSnapshot"))
.times(1)
.return_once(|_, _| {
Err(SdkError::service_error(
CreateDBClusterSnapshotError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create snapshot error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("MockCluster".into());
let create_snapshot = scenario.snapshot("MockSnapshot").await;
assert_matches!(create_snapshot, Err(ScenarioError { message, context: _}) if message == "Failed to create snapshot");
}
#[tokio::test]
async fn test_scenario_snapshot_invalid() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_snapshot_cluster()
.with(eq("MockCluster"), eq("MockCluster_MockSnapshot"))
.times(1)
.return_once(|_, _| Ok(CreateDbClusterSnapshotOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("MockCluster".into());
let create_snapshot = scenario.snapshot("MockSnapshot").await;
assert_matches!(create_snapshot, Err(ScenarioError { message, context: _}) if message == "Missing Snapshot");
}
```
Un binaire pour exécuter le scénario de bout en bout, en utilisant Inquirer pour que l’utilisateur puisse prendre des décisions.
```
use std::fmt::Display;
use anyhow::anyhow;
use aurora_code_examples::{
aurora_scenario::{AuroraScenario, ScenarioError},
rds::Rds as RdsClient,
};
use aws_sdk_rds::Client;
use inquire::{validator::StringValidator, CustomUserError};
use secrecy::SecretString;
use tracing::warn;
#[derive(Default, Debug)]
struct Warnings(Vec);
impl Warnings {
fn new() -> Self {
Warnings(Vec::with_capacity(5))
}
fn push(&mut self, warning: &str, error: ScenarioError) {
let formatted = format!("{warning}: {error}");
warn!("{formatted}");
self.0.push(formatted);
}
fn is_empty(&self) -> bool {
self.0.is_empty()
}
}
impl Display for Warnings {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "Warnings:")?;
for warning in &self.0 {
writeln!(f, "{: >4}- {warning}", "")?;
}
Ok(())
}
}
fn select(
prompt: &str,
choices: Vec,
error_message: &str,
) -> Result {
inquire::Select::new(prompt, choices)
.prompt()
.map_err(|error| anyhow!("{error_message}: {error}"))
}
// Prepare the Aurora Scenario. Prompt for several settings that are optional to the Scenario, but that the user should choose for the demo.
// This includes the engine, engine version, and instance class.
async fn prepare_scenario(rds: RdsClient) -> Result {
let mut scenario = AuroraScenario::new(rds);
// Get available engine families for Aurora MySql. rds.DescribeDbEngineVersions(Engine='aurora-mysql') and build a set of the 'DBParameterGroupFamily' field values. I get {aurora-mysql8.0, aurora-mysql5.7}.
let available_engines = scenario.get_engines().await;
if let Err(error) = available_engines {
return Err(anyhow!("Failed to get available engines: {}", error));
}
let available_engines = available_engines.unwrap();
// Select an engine family and create a custom DB cluster parameter group. rds.CreateDbClusterParameterGroup(DBParameterGroupFamily='aurora-mysql8.0')
let engine = select(
"Select an Aurora engine family",
available_engines.keys().cloned().collect::>(),
"Invalid engine selection",
)?;
let version = select(
format!("Select an Aurora engine version for {engine}").as_str(),
available_engines.get(&engine).cloned().unwrap_or_default(),
"Invalid engine version selection",
)?;
let set_engine = scenario.set_engine(engine.as_str(), version.as_str()).await;
if let Err(error) = set_engine {
return Err(anyhow!("Could not set engine: {}", error));
}
let instance_classes = scenario.get_instance_classes().await;
match instance_classes {
Ok(classes) => {
let instance_class = select(
format!("Select an Aurora instance class for {engine}").as_str(),
classes,
"Invalid instance class selection",
)?;
scenario.set_instance_class(Some(instance_class))
}
Err(err) => return Err(anyhow!("Failed to get instance classes for engine: {err}")),
}
Ok(scenario)
}
// Prepare the cluster, creating a custom parameter group overriding some group parameters based on user input.
async fn prepare_cluster(scenario: &mut AuroraScenario, warnings: &mut Warnings) -> Result<(), ()> {
show_parameters(scenario, warnings).await;
let offset = prompt_number_or_default(warnings, "auto_increment_offset", 5);
let increment = prompt_number_or_default(warnings, "auto_increment_increment", 3);
// Modify both the auto_increment_offset and auto_increment_increment parameters in one call in the custom parameter group. Set their ParameterValue fields to a new allowable value. rds.ModifyDbClusterParameterGroup.
let update_auto_increment = scenario.update_auto_increment(offset, increment).await;
if let Err(error) = update_auto_increment {
warnings.push("Failed to update auto increment", error);
return Err(());
}
// Get and display the updated parameters. Specify Source of 'user' to get just the modified parameters. rds.DescribeDbClusterParameters(Source='user')
show_parameters(scenario, warnings).await;
let username = inquire::Text::new("Username for the database (default 'testuser')")
.with_default("testuser")
.with_initial_value("testuser")
.prompt();
if let Err(error) = username {
warnings.push(
"Failed to get username, using default",
ScenarioError::with(format!("Error from inquirer: {error}")),
);
return Err(());
}
let username = username.unwrap();
let password = inquire::Text::new("Password for the database (minimum 8 characters)")
.with_validator(|i: &str| {
if i.len() >= 8 {
Ok(inquire::validator::Validation::Valid)
} else {
Ok(inquire::validator::Validation::Invalid(
"Password must be at least 8 characters".into(),
))
}
})
.prompt();
let password: Option = match password {
Ok(password) => Some(SecretString::from(password)),
Err(error) => {
warnings.push(
"Failed to get password, using none (and not starting a DB)",
ScenarioError::with(format!("Error from inquirer: {error}")),
);
return Err(());
}
};
scenario.set_login(Some(username), password);
Ok(())
}
// Start a single instance in the cluster,
async fn run_instance(scenario: &mut AuroraScenario) -> Result<(), ScenarioError> {
// Create an Aurora DB cluster database cluster that contains a MySql database and uses the parameter group you created.
// Create a database instance in the cluster.
// Wait for DB instance to be ready. Call rds.DescribeDbInstances and check for DBInstanceStatus == 'available'.
scenario.start_cluster_and_instance().await?;
let connection_string = scenario.connection_string().await?;
println!("Database ready: {connection_string}",);
let _ = inquire::Text::new("Use the database with the connection string. When you're finished, press enter key to continue.").prompt();
// Create a snapshot of the DB cluster. rds.CreateDbClusterSnapshot.
// Wait for the snapshot to create. rds.DescribeDbClusterSnapshots until Status == 'available'.
let snapshot_name = inquire::Text::new("Provide a name for the snapshot")
.prompt()
.unwrap_or(String::from("ScenarioRun"));
let snapshot = scenario.snapshot(snapshot_name.as_str()).await?;
println!(
"Snapshot is available: {}",
snapshot.db_cluster_snapshot_arn().unwrap_or("Missing ARN")
);
Ok(())
}
#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
tracing_subscriber::fmt::init();
let sdk_config = aws_config::from_env().load().await;
let client = Client::new(&sdk_config);
let rds = RdsClient::new(client);
let mut scenario = prepare_scenario(rds).await?;
// At this point, the scenario has things in AWS and needs to get cleaned up.
let mut warnings = Warnings::new();
if prepare_cluster(&mut scenario, &mut warnings).await.is_ok() {
println!("Configured database cluster, starting an instance.");
if let Err(err) = run_instance(&mut scenario).await {
warnings.push("Problem running instance", err);
}
}
// Clean up the instance, cluster, and parameter group, waiting for the instance and cluster to delete before moving on.
let clean_up = scenario.clean_up().await;
if let Err(errors) = clean_up {
for error in errors {
warnings.push("Problem cleaning up scenario", error);
}
}
if warnings.is_empty() {
Ok(())
} else {
println!("There were problems running the scenario:");
println!("{warnings}");
Err(anyhow!("There were problems running the scenario"))
}
}
#[derive(Clone)]
struct U8Validator {}
impl StringValidator for U8Validator {
fn validate(&self, input: &str) -> Result {
if input.parse::().is_err() {
Ok(inquire::validator::Validation::Invalid(
"Can't parse input as number".into(),
))
} else {
Ok(inquire::validator::Validation::Valid)
}
}
}
async fn show_parameters(scenario: &AuroraScenario, warnings: &mut Warnings) {
let parameters = scenario.cluster_parameters().await;
match parameters {
Ok(parameters) => {
println!("Current parameters");
for parameter in parameters {
println!("\t{parameter}");
}
}
Err(error) => warnings.push("Could not find cluster parameters", error),
}
}
fn prompt_number_or_default(warnings: &mut Warnings, name: &str, default: u8) -> u8 {
let input = inquire::Text::new(format!("Updated {name}:").as_str())
.with_validator(U8Validator {})
.prompt();
match input {
Ok(increment) => match increment.parse::() {
Ok(increment) => increment,
Err(error) => {
warnings.push(
format!("Invalid updated {name} (using {default} instead)").as_str(),
ScenarioError::with(format!("{error}")),
);
default
}
},
Err(error) => {
warnings.push(
format!("Invalid updated {name} (using {default} instead)").as_str(),
ScenarioError::with(format!("{error}")),
);
default
}
}
}
```
Un encapsuleur autour du service Amazon RDS qui permet d’autosimuler les tests.
```
use aws_sdk_rds::{
error::SdkError,
operation::{
create_db_cluster::{CreateDBClusterError, CreateDbClusterOutput},
create_db_cluster_parameter_group::CreateDBClusterParameterGroupError,
create_db_cluster_parameter_group::CreateDbClusterParameterGroupOutput,
create_db_cluster_snapshot::{CreateDBClusterSnapshotError, CreateDbClusterSnapshotOutput},
create_db_instance::{CreateDBInstanceError, CreateDbInstanceOutput},
delete_db_cluster::{DeleteDBClusterError, DeleteDbClusterOutput},
delete_db_cluster_parameter_group::{
DeleteDBClusterParameterGroupError, DeleteDbClusterParameterGroupOutput,
},
delete_db_instance::{DeleteDBInstanceError, DeleteDbInstanceOutput},
describe_db_cluster_endpoints::{
DescribeDBClusterEndpointsError, DescribeDbClusterEndpointsOutput,
},
describe_db_cluster_parameters::{
DescribeDBClusterParametersError, DescribeDbClusterParametersOutput,
},
describe_db_clusters::{DescribeDBClustersError, DescribeDbClustersOutput},
describe_db_engine_versions::{
DescribeDBEngineVersionsError, DescribeDbEngineVersionsOutput,
},
describe_db_instances::{DescribeDBInstancesError, DescribeDbInstancesOutput},
describe_orderable_db_instance_options::DescribeOrderableDBInstanceOptionsError,
modify_db_cluster_parameter_group::{
ModifyDBClusterParameterGroupError, ModifyDbClusterParameterGroupOutput,
},
},
types::{OrderableDbInstanceOption, Parameter},
Client as RdsClient,
};
use secrecy::{ExposeSecret, SecretString};
#[cfg(test)]
use mockall::automock;
#[cfg(test)]
pub use MockRdsImpl as Rds;
#[cfg(not(test))]
pub use RdsImpl as Rds;
pub struct RdsImpl {
pub inner: RdsClient,
}
#[cfg_attr(test, automock)]
impl RdsImpl {
pub fn new(inner: RdsClient) -> Self {
RdsImpl { inner }
}
pub async fn describe_db_engine_versions(
&self,
engine: &str,
) -> Result> {
self.inner
.describe_db_engine_versions()
.engine(engine)
.send()
.await
}
pub async fn describe_orderable_db_instance_options(
&self,
engine: &str,
engine_version: &str,
) -> Result, SdkError>
{
self.inner
.describe_orderable_db_instance_options()
.engine(engine)
.engine_version(engine_version)
.into_paginator()
.items()
.send()
.try_collect()
.await
}
pub async fn create_db_cluster_parameter_group(
&self,
name: &str,
description: &str,
family: &str,
) -> Result>
{
self.inner
.create_db_cluster_parameter_group()
.db_cluster_parameter_group_name(name)
.description(description)
.db_parameter_group_family(family)
.send()
.await
}
pub async fn describe_db_clusters(
&self,
id: &str,
) -> Result> {
self.inner
.describe_db_clusters()
.db_cluster_identifier(id)
.send()
.await
}
pub async fn describe_db_cluster_parameters(
&self,
name: &str,
) -> Result, SdkError>
{
self.inner
.describe_db_cluster_parameters()
.db_cluster_parameter_group_name(name)
.into_paginator()
.send()
.try_collect()
.await
}
pub async fn modify_db_cluster_parameter_group(
&self,
name: &str,
parameters: Vec,
) -> Result>
{
self.inner
.modify_db_cluster_parameter_group()
.db_cluster_parameter_group_name(name)
.set_parameters(Some(parameters))
.send()
.await
}
pub async fn create_db_cluster(
&self,
name: &str,
parameter_group: &str,
engine: &str,
version: &str,
username: &str,
password: SecretString,
) -> Result> {
self.inner
.create_db_cluster()
.db_cluster_identifier(name)
.db_cluster_parameter_group_name(parameter_group)
.engine(engine)
.engine_version(version)
.master_username(username)
.master_user_password(password.expose_secret())
.send()
.await
}
pub async fn create_db_instance(
&self,
cluster_name: &str,
instance_name: &str,
instance_class: &str,
engine: &str,
) -> Result> {
self.inner
.create_db_instance()
.db_cluster_identifier(cluster_name)
.db_instance_identifier(instance_name)
.db_instance_class(instance_class)
.engine(engine)
.send()
.await
}
pub async fn describe_db_instance(
&self,
instance_identifier: &str,
) -> Result> {
self.inner
.describe_db_instances()
.db_instance_identifier(instance_identifier)
.send()
.await
}
pub async fn snapshot_cluster(
&self,
db_cluster_identifier: &str,
snapshot_name: &str,
) -> Result> {
self.inner
.create_db_cluster_snapshot()
.db_cluster_identifier(db_cluster_identifier)
.db_cluster_snapshot_identifier(snapshot_name)
.send()
.await
}
pub async fn describe_db_instances(
&self,
) -> Result> {
self.inner.describe_db_instances().send().await
}
pub async fn describe_db_cluster_endpoints(
&self,
cluster_identifier: &str,
) -> Result> {
self.inner
.describe_db_cluster_endpoints()
.db_cluster_identifier(cluster_identifier)
.send()
.await
}
pub async fn delete_db_instance(
&self,
instance_identifier: &str,
) -> Result> {
self.inner
.delete_db_instance()
.db_instance_identifier(instance_identifier)
.skip_final_snapshot(true)
.send()
.await
}
pub async fn delete_db_cluster(
&self,
cluster_identifier: &str,
) -> Result> {
self.inner
.delete_db_cluster()
.db_cluster_identifier(cluster_identifier)
.skip_final_snapshot(true)
.send()
.await
}
pub async fn delete_db_cluster_parameter_group(
&self,
name: &str,
) -> Result>
{
self.inner
.delete_db_cluster_parameter_group()
.db_cluster_parameter_group_name(name)
.send()
.await
}
}
```
Le fichier Cargo.toml avec les dépendances utilisées dans ce scénario.
```
[package]
name = "aurora-code-examples"
authors = [
"David Souther ",
]
edition = "2021"
version = "0.1.0"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
anyhow = "1.0.75"
assert_matches = "1.5.0"
aws-config = { version = "1.0.1", features = ["behavior-version-latest"] }
aws-smithy-types = { version = "1.0.1" }
aws-smithy-runtime-api = { version = "1.0.1" }
aws-sdk-rds = { version = "1.3.0" }
inquire = "0.6.2"
mockall = "0.11.4"
phf = { version = "0.11.2", features = ["std", "macros"] }
sdk-examples-test-utils = { path = "../../test-utils" }
secrecy = "0.8.0"
tokio = { version = "1.20.1", features = ["full", "test-util"] }
tracing = "0.1.37"
tracing-subscriber = { version = "0.3.15", features = ["env-filter"] }
```
+ Pour plus de détails sur l’API, consultez les rubriques suivantes dans la *Référence des API du kit AWS SDK pour Rust*.
+ [CréerDBCluster](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_cluster)
+ [CréerDBClusterParameterGroup](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_cluster_parameter_group)
+ [Créer un DBCluster instantané](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_cluster_snapshot)
+ [CréerDBInstance](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_instance)
+ [SuppressionDBCluster](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.delete_db_cluster)
+ [SuppressionDBClusterParameterGroup](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.delete_db_cluster_parameter_group)
+ [SuppressionDBInstance](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.delete_db_instance)
+ [DécrireDBClusterParameterGroups](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_cluster_parameter_groups)
+ [Décrire DBCluster les paramètres](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_cluster_parameters)
+ [Décrire les DBCluster instantanés](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_cluster_snapshots)
+ [DécrireDBClusters](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_clusters)
+ [Décrire DBEngine les versions](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_engine_versions)
+ [DécrireDBInstances](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_instances)
+ [DescribeOrderableDBInstanceOptions](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_orderable_db_instance_options)
+ [ModifyDBClusterParameterGroup](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.modify_db_cluster_parameter_group)
------
# Actions pour Aurora utilisant AWS SDKs
Les exemples de code suivants montrent comment effectuer des actions Aurora individuelles avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Ces extraits appellent l’API Aurora et sont des extraits de code de programmes plus volumineux qui doivent être exécutés en contexte. Vous pouvez voir les actions dans leur contexte dans [Scénarios d'utilisation d'Aurora AWS SDKs](aurora_code_examples_scenarios.md).
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez la [Référence des API Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/Welcome.html).
**Topics**
+ [`CreateDBCluster`](aurora_example_aurora_CreateDBCluster_section.md)
+ [`CreateDBClusterParameterGroup`](aurora_example_aurora_CreateDBClusterParameterGroup_section.md)
+ [`CreateDBClusterSnapshot`](aurora_example_aurora_CreateDBClusterSnapshot_section.md)
+ [`CreateDBInstance`](aurora_example_aurora_CreateDBInstance_section.md)
+ [`DeleteDBCluster`](aurora_example_aurora_DeleteDBCluster_section.md)
+ [`DeleteDBClusterParameterGroup`](aurora_example_aurora_DeleteDBClusterParameterGroup_section.md)
+ [`DeleteDBInstance`](aurora_example_aurora_DeleteDBInstance_section.md)
+ [`DescribeDBClusterParameterGroups`](aurora_example_aurora_DescribeDBClusterParameterGroups_section.md)
+ [`DescribeDBClusterParameters`](aurora_example_aurora_DescribeDBClusterParameters_section.md)
+ [`DescribeDBClusterSnapshots`](aurora_example_aurora_DescribeDBClusterSnapshots_section.md)
+ [`DescribeDBClusters`](aurora_example_aurora_DescribeDBClusters_section.md)
+ [`DescribeDBEngineVersions`](aurora_example_aurora_DescribeDBEngineVersions_section.md)
+ [`DescribeDBInstances`](aurora_example_aurora_DescribeDBInstances_section.md)
+ [`DescribeOrderableDBInstanceOptions`](aurora_example_aurora_DescribeOrderableDBInstanceOptions_section.md)
+ [`ModifyDBClusterParameterGroup`](aurora_example_aurora_ModifyDBClusterParameterGroup_section.md)
# Utilisation `CreateDBCluster` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `CreateDBCluster`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Create a new cluster and database.
///
/// The name of the new database.
/// The identifier of the cluster.
/// The name of the parameter group.
/// The engine to use for the new cluster.
/// The version of the engine to use.
/// The admin username.
/// The primary admin password.
/// The cluster object.
public async Task CreateDBClusterWithAdminAsync(
string dbName,
string clusterIdentifier,
string parameterGroupName,
string dbEngine,
string dbEngineVersion,
string adminName,
string adminPassword)
{
var request = new CreateDBClusterRequest
{
DatabaseName = dbName,
DBClusterIdentifier = clusterIdentifier,
DBClusterParameterGroupName = parameterGroupName,
Engine = dbEngine,
EngineVersion = dbEngineVersion,
MasterUsername = adminName,
MasterUserPassword = adminPassword,
};
var response = await _amazonRDS.CreateDBClusterAsync(request);
return response.DBCluster;
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBCluster) in *AWS SDK pour .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::CreateDBClusterRequest request;
request.SetDBClusterIdentifier(DB_CLUSTER_IDENTIFIER);
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
request.SetEngine(engineName);
request.SetEngineVersion(engineVersionName);
request.SetMasterUsername(administratorName);
request.SetMasterUserPassword(administratorPassword);
Aws::RDS::Model::CreateDBClusterOutcome outcome =
client.CreateDBCluster(request);
if (outcome.IsSuccess()) {
std::cout << "The DB cluster creation has started."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::CreateDBCluster. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, "", "", client);
return false;
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBCluster) in *AWS SDK pour C\$1\$1 API Reference*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// CreateDbCluster creates a DB cluster that is configured to use the specified parameter group.
// The newly created DB cluster contains a database that uses the specified engine and
// engine version.
func (clusters *DbClusters) CreateDbCluster(ctx context.Context, clusterName string, parameterGroupName string,
dbName string, dbEngine string, dbEngineVersion string, adminName string, adminPassword string) (
*types.DBCluster, error) {
output, err := clusters.AuroraClient.CreateDBCluster(ctx, &rds.CreateDBClusterInput{
DBClusterIdentifier: aws.String(clusterName),
Engine: aws.String(dbEngine),
DBClusterParameterGroupName: aws.String(parameterGroupName),
DatabaseName: aws.String(dbName),
EngineVersion: aws.String(dbEngineVersion),
MasterUserPassword: aws.String(adminPassword),
MasterUsername: aws.String(adminName),
})
if err != nil {
log.Printf("Couldn't create DB cluster %v: %v\n", clusterName, err)
return nil, err
} else {
return output.DBCluster, err
}
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBCluster) in *AWS SDK pour Go API Reference*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static String createDBCluster(RdsClient rdsClient, String dbParameterGroupFamily, String dbName,
String dbClusterIdentifier, String userName, String password) {
try {
CreateDbClusterRequest clusterRequest = CreateDbClusterRequest.builder()
.databaseName(dbName)
.dbClusterIdentifier(dbClusterIdentifier)
.dbClusterParameterGroupName(dbParameterGroupFamily)
.engine("aurora-mysql")
.masterUsername(userName)
.masterUserPassword(password)
.build();
CreateDbClusterResponse response = rdsClient.createDBCluster(clusterRequest);
return response.dbCluster().dbClusterArn();
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
return "";
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBCluster) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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
}
}
```
+ Pour plus de détails sur l'API, voir [Create DBCluster](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def create_db_cluster(
self,
cluster_name,
parameter_group_name,
db_name,
db_engine,
db_engine_version,
admin_name,
admin_password,
):
"""
Creates a DB cluster that is configured to use the specified parameter group.
The newly created DB cluster contains a database that uses the specified engine and
engine version.
:param cluster_name: The name of the DB cluster to create.
:param parameter_group_name: The name of the parameter group to associate with
the DB cluster.
:param db_name: The name of the database to create.
:param db_engine: The database engine of the database that is created, such as MySql.
:param db_engine_version: The version of the database engine.
:param admin_name: The user name of the database administrator.
:param admin_password: The password of the database administrator.
:return: The newly created DB cluster.
"""
try:
response = self.rds_client.create_db_cluster(
DatabaseName=db_name,
DBClusterIdentifier=cluster_name,
DBClusterParameterGroupName=parameter_group_name,
Engine=db_engine,
EngineVersion=db_engine_version,
MasterUsername=admin_name,
MasterUserPassword=admin_password,
)
cluster = response["DBCluster"]
except ClientError as err:
logger.error(
"Couldn't create database %s. Here's why: %s: %s",
db_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return cluster
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Create DBCluster](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBCluster) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Get a list of allowed engine versions. rds.DescribeDbEngineVersions(Engine='aurora-mysql', DBParameterGroupFamily=)
// Create an Aurora DB cluster database cluster that contains a MySql database and uses the parameter group you created.
// Wait for DB cluster to be ready. Call rds.DescribeDBClusters and check for Status == 'available'.
// Get a list of instance classes available for the selected engine and engine version. rds.DescribeOrderableDbInstanceOptions(Engine='mysql', EngineVersion=).
// Create a database instance in the cluster.
// Wait for DB instance to be ready. Call rds.DescribeDbInstances and check for DBInstanceStatus == 'available'.
pub async fn start_cluster_and_instance(&mut self) -> Result<(), ScenarioError> {
if self.password.is_none() {
return Err(ScenarioError::with(
"Must set Secret Password before starting a cluster",
));
}
let create_db_cluster = self
.rds
.create_db_cluster(
DB_CLUSTER_IDENTIFIER,
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_ENGINE,
self.engine_version.as_deref().expect("engine version"),
self.username.as_deref().expect("username"),
self.password
.replace(SecretString::new("".to_string()))
.expect("password"),
)
.await;
if let Err(err) = create_db_cluster {
return Err(ScenarioError::new(
"Failed to create DB Cluster with cluster group",
&err,
));
}
self.db_cluster_identifier = create_db_cluster
.unwrap()
.db_cluster
.and_then(|c| c.db_cluster_identifier);
if self.db_cluster_identifier.is_none() {
return Err(ScenarioError::with("Created DB Cluster missing Identifier"));
}
info!(
"Started a db cluster: {}",
self.db_cluster_identifier
.as_deref()
.unwrap_or("Missing ARN")
);
let create_db_instance = self
.rds
.create_db_instance(
self.db_cluster_identifier.as_deref().expect("cluster name"),
DB_INSTANCE_IDENTIFIER,
self.instance_class.as_deref().expect("instance class"),
DB_ENGINE,
)
.await;
if let Err(err) = create_db_instance {
return Err(ScenarioError::new(
"Failed to create Instance in DB Cluster",
&err,
));
}
self.db_instance_identifier = create_db_instance
.unwrap()
.db_instance
.and_then(|i| i.db_instance_identifier);
// Cluster creation can take up to 20 minutes to become available
let cluster_max_wait = Duration::from_secs(20 * 60);
let waiter = Waiter::builder().max(cluster_max_wait).build();
while waiter.sleep().await.is_ok() {
let cluster = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = cluster {
warn!(?err, "Failed to describe cluster while waiting for ready");
continue;
}
let instance = self
.rds
.describe_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = instance {
return Err(ScenarioError::new(
"Failed to find instance for cluster",
&err,
));
}
let instances_available = instance
.unwrap()
.db_instances()
.iter()
.all(|instance| instance.db_instance_status() == Some("Available"));
let endpoints = self
.rds
.describe_db_cluster_endpoints(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = endpoints {
return Err(ScenarioError::new(
"Failed to find endpoint for cluster",
&err,
));
}
let endpoints_available = endpoints
.unwrap()
.db_cluster_endpoints()
.iter()
.all(|endpoint| endpoint.status() == Some("available"));
if instances_available && endpoints_available {
return Ok(());
}
}
Err(ScenarioError::with("timed out waiting for cluster"))
}
pub async fn create_db_cluster(
&self,
name: &str,
parameter_group: &str,
engine: &str,
version: &str,
username: &str,
password: SecretString,
) -> Result> {
self.inner
.create_db_cluster()
.db_cluster_identifier(name)
.db_cluster_parameter_group_name(parameter_group)
.engine(engine)
.engine_version(version)
.master_username(username)
.master_user_password(password.expose_secret())
.send()
.await
}
#[tokio::test]
async fn test_start_cluster_and_instance() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_describe_db_instance()
.with(eq("RustSDKCodeExamplesDBInstance"))
.return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
assert!(scenario
.password
.replace(SecretString::new("BAD SECRET".into()))
.unwrap()
.expose_secret()
.is_empty());
assert_eq!(
scenario.db_cluster_identifier,
Some("RustSDKCodeExamplesDBCluster".into())
);
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Err(SdkError::service_error(
CreateDBClusterError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _}) if message == "Failed to create DB Cluster with cluster group")
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_missing_id() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context:_ }) if message == "Created DB Cluster missing Identifier");
}
#[tokio::test]
async fn test_start_cluster_and_instance_instance_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.return_once(|_, _, _, _| {
Err(SdkError::service_error(
CreateDBInstanceError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db instance error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _ }) if message == "Failed to create Instance in DB Cluster")
}
#[tokio::test]
async fn test_start_cluster_and_instance_wait_hiccup() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
})
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds.expect_describe_db_instance().return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, voir [Create DBCluster](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_cluster) in *AWS SDK for Rust API reference*.
------
# Utilisation `CreateDBClusterParameterGroup` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `CreateDBClusterParameterGroup`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Create a custom cluster parameter group.
///
/// The family of the parameter group.
/// The name for the new parameter group.
/// A description for the new parameter group.
/// The new parameter group object.
public async Task CreateCustomClusterParameterGroupAsync(
string parameterGroupFamily,
string groupName,
string description)
{
var request = new CreateDBClusterParameterGroupRequest
{
DBParameterGroupFamily = parameterGroupFamily,
DBClusterParameterGroupName = groupName,
Description = description,
};
var response = await _amazonRDS.CreateDBClusterParameterGroupAsync(request);
return response.DBClusterParameterGroup;
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster ParameterGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterParameterGroup) in *AWS SDK pour .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::CreateDBClusterParameterGroupRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
request.SetDBParameterGroupFamily(dbParameterGroupFamily);
request.SetDescription("Example cluster parameter group.");
Aws::RDS::Model::CreateDBClusterParameterGroupOutcome outcome =
client.CreateDBClusterParameterGroup(request);
if (outcome.IsSuccess()) {
std::cout << "The DB cluster parameter group was successfully created."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::CreateDBClusterParameterGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster ParameterGroup](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterParameterGroup) in *AWS SDK pour C\$1\$1 API Reference*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// CreateParameterGroup creates a DB cluster parameter group that is based on the specified
// parameter group family.
func (clusters *DbClusters) CreateParameterGroup(
ctx context.Context, parameterGroupName string, parameterGroupFamily string, description string) (
*types.DBClusterParameterGroup, error) {
output, err := clusters.AuroraClient.CreateDBClusterParameterGroup(ctx,
&rds.CreateDBClusterParameterGroupInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
DBParameterGroupFamily: aws.String(parameterGroupFamily),
Description: aws.String(description),
})
if err != nil {
log.Printf("Couldn't create parameter group %v: %v\n", parameterGroupName, err)
return nil, err
} else {
return output.DBClusterParameterGroup, err
}
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster ParameterGroup](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBClusterParameterGroup) in *AWS SDK pour Go API Reference*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void createDBClusterParameterGroup(RdsClient rdsClient, String dbClusterGroupName,
String dbParameterGroupFamily) {
try {
CreateDbClusterParameterGroupRequest groupRequest = CreateDbClusterParameterGroupRequest.builder()
.dbClusterParameterGroupName(dbClusterGroupName)
.dbParameterGroupFamily(dbParameterGroupFamily)
.description("Created by using the AWS SDK for Java")
.build();
CreateDbClusterParameterGroupResponse response = rdsClient.createDBClusterParameterGroup(groupRequest);
System.out.println("The group name is " + response.dbClusterParameterGroup().dbClusterParameterGroupName());
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, consultez [Create DBCluster ParameterGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterParameterGroup) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
```
+ Pour plus de détails sur l'API, voir [Create DBCluster ParameterGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def create_parameter_group(
self, parameter_group_name, parameter_group_family, description
):
"""
Creates a DB cluster parameter group that is based on the specified parameter group
family.
:param parameter_group_name: The name of the newly created parameter group.
:param parameter_group_family: The family that is used as the basis of the new
parameter group.
:param description: A description given to the parameter group.
:return: Data about the newly created parameter group.
"""
try:
response = self.rds_client.create_db_cluster_parameter_group(
DBClusterParameterGroupName=parameter_group_name,
DBParameterGroupFamily=parameter_group_family,
Description=description,
)
except ClientError as err:
logger.error(
"Couldn't create parameter group %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Create DBCluster ParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterParameterGroup) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Select an engine family and create a custom DB cluster parameter group. rds.CreateDbClusterParameterGroup(DBParameterGroupFamily='aurora-mysql8.0')
pub async fn set_engine(&mut self, engine: &str, version: &str) -> Result<(), ScenarioError> {
self.engine_family = Some(engine.to_string());
self.engine_version = Some(version.to_string());
let create_db_cluster_parameter_group = self
.rds
.create_db_cluster_parameter_group(
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_PARAMETER_GROUP_DESCRIPTION,
engine,
)
.await;
match create_db_cluster_parameter_group {
Ok(CreateDbClusterParameterGroupOutput {
db_cluster_parameter_group: None,
..
}) => {
return Err(ScenarioError::with(
"CreateDBClusterParameterGroup had empty response",
));
}
Err(error) => {
if error.code() == Some("DBParameterGroupAlreadyExists") {
info!("Cluster Parameter Group already exists, nothing to do");
} else {
return Err(ScenarioError::new(
"Could not create Cluster Parameter Group",
&error,
));
}
}
_ => {
info!("Created Cluster Parameter Group");
}
}
Ok(())
}
pub async fn create_db_cluster_parameter_group(
&self,
name: &str,
description: &str,
family: &str,
) -> Result>
{
self.inner
.create_db_cluster_parameter_group()
.db_cluster_parameter_group_name(name)
.description(description)
.db_parameter_group_family(family)
.send()
.await
}
#[tokio::test]
async fn test_scenario_set_engine() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.with(
eq("RustSDKCodeExamplesDBParameterGroup"),
eq("Parameter Group created by Rust SDK Code Example"),
eq("aurora-mysql"),
)
.return_once(|_, _, _| {
Ok(CreateDbClusterParameterGroupOutput::builder()
.db_cluster_parameter_group(DbClusterParameterGroup::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
let set_engine = scenario.set_engine("aurora-mysql", "aurora-mysql8.0").await;
assert_eq!(set_engine, Ok(()));
assert_eq!(Some("aurora-mysql"), scenario.engine_family.as_deref());
assert_eq!(Some("aurora-mysql8.0"), scenario.engine_version.as_deref());
}
#[tokio::test]
async fn test_scenario_set_engine_not_create() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.with(
eq("RustSDKCodeExamplesDBParameterGroup"),
eq("Parameter Group created by Rust SDK Code Example"),
eq("aurora-mysql"),
)
.return_once(|_, _, _| Ok(CreateDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
let set_engine = scenario.set_engine("aurora-mysql", "aurora-mysql8.0").await;
assert!(set_engine.is_err());
}
#[tokio::test]
async fn test_scenario_set_engine_param_group_exists() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster_parameter_group()
.withf(|_, _, _| true)
.return_once(|_, _, _| {
Err(SdkError::service_error(
CreateDBClusterParameterGroupError::DbParameterGroupAlreadyExistsFault(
DbParameterGroupAlreadyExistsFault::builder().build(),
),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
let set_engine = scenario.set_engine("aurora-mysql", "aurora-mysql8.0").await;
assert!(set_engine.is_err());
}
```
+ Pour plus de détails sur l'API, voir [Create DBCluster ParameterGroup](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_cluster_parameter_group) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/rds#code-examples).
```
TRY.
DATA(lo_output) = lo_rds->createdbclusterparamgroup(
iv_dbclusterparamgroupname = iv_param_group_name
iv_dbparametergroupfamily = iv_param_group_family
iv_description = iv_description
).
oo_result = lo_output->get_dbclusterparametergroup( ).
CATCH /aws1/cx_rdsdbparmgralrexfault.
" Re-raise exception - parameter group already exists
RAISE EXCEPTION TYPE /aws1/cx_rdsdbparmgralrexfault.
CATCH /aws1/cx_rdsdbprmgrquotaexcd00.
" Re-raise exception - quota exceeded
RAISE EXCEPTION TYPE /aws1/cx_rdsdbprmgrquotaexcd00.
ENDTRY.
```
+ Pour plus de détails sur l'API, consultez la section de référence sur l'*API [Create DBCluster ParameterGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in AWS SDK for SAP ABAP*.
------
# Utilisation `CreateDBClusterSnapshot` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `CreateDBClusterSnapshot`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Create a snapshot of a cluster.
///
/// DB cluster identifier.
/// Identifier for the snapshot.
/// DB snapshot object.
public async Task CreateClusterSnapshotByIdentifierAsync(string dbClusterIdentifier, string snapshotIdentifier)
{
var response = await _amazonRDS.CreateDBClusterSnapshotAsync(
new CreateDBClusterSnapshotRequest()
{
DBClusterIdentifier = dbClusterIdentifier,
DBClusterSnapshotIdentifier = snapshotIdentifier,
});
return response.DBClusterSnapshot;
}
```
+ Pour plus de détails sur l'API, voir [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterSnapshot) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::CreateDBClusterSnapshotRequest request;
request.SetDBClusterIdentifier(DB_CLUSTER_IDENTIFIER);
request.SetDBClusterSnapshotIdentifier(snapshotID);
Aws::RDS::Model::CreateDBClusterSnapshotOutcome outcome =
client.CreateDBClusterSnapshot(request);
if (outcome.IsSuccess()) {
std::cout << "Snapshot creation has started."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::CreateDBClusterSnapshot. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
```
+ Pour plus de détails sur l'API, voir [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterSnapshot) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// CreateClusterSnapshot creates a snapshot of a DB cluster.
func (clusters *DbClusters) CreateClusterSnapshot(ctx context.Context, clusterName string, snapshotName string) (
*types.DBClusterSnapshot, error) {
output, err := clusters.AuroraClient.CreateDBClusterSnapshot(ctx, &rds.CreateDBClusterSnapshotInput{
DBClusterIdentifier: aws.String(clusterName),
DBClusterSnapshotIdentifier: aws.String(snapshotName),
})
if err != nil {
log.Printf("Couldn't create snapshot %v: %v\n", snapshotName, err)
return nil, err
} else {
return output.DBClusterSnapshot, nil
}
}
```
+ Pour plus de détails sur l'API, voir [Créer un DBCluster instantané](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBClusterSnapshot) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void createDBClusterSnapshot(RdsClient rdsClient, String dbInstanceClusterIdentifier,
String dbSnapshotIdentifier) {
try {
CreateDbClusterSnapshotRequest snapshotRequest = CreateDbClusterSnapshotRequest.builder()
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.dbClusterSnapshotIdentifier(dbSnapshotIdentifier)
.build();
CreateDbClusterSnapshotResponse response = rdsClient.createDBClusterSnapshot(snapshotRequest);
System.out.println("The Snapshot ARN is " + response.dbClusterSnapshot().dbClusterSnapshotArn());
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, voir [Créer un DBCluster instantané](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterSnapshot) dans le manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
```
+ Pour plus de détails sur l'API, voir [Créer un DBCluster instantané](https://sdk.amazonaws.com/kotlin/api/latest/index.html) dans le *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def create_cluster_snapshot(self, snapshot_id, cluster_id):
"""
Creates a snapshot of a DB cluster.
:param snapshot_id: The ID to give the created snapshot.
:param cluster_id: The DB cluster to snapshot.
:return: Data about the newly created snapshot.
"""
try:
response = self.rds_client.create_db_cluster_snapshot(
DBClusterSnapshotIdentifier=snapshot_id, DBClusterIdentifier=cluster_id
)
snapshot = response["DBClusterSnapshot"]
except ClientError as err:
logger.error(
"Couldn't create snapshot of %s. Here's why: %s: %s",
cluster_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return snapshot
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Create DBCluster Snapshot](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterSnapshot) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Get a list of allowed engine versions. rds.DescribeDbEngineVersions(Engine='aurora-mysql', DBParameterGroupFamily=)
// Create an Aurora DB cluster database cluster that contains a MySql database and uses the parameter group you created.
// Wait for DB cluster to be ready. Call rds.DescribeDBClusters and check for Status == 'available'.
// Get a list of instance classes available for the selected engine and engine version. rds.DescribeOrderableDbInstanceOptions(Engine='mysql', EngineVersion=).
// Create a database instance in the cluster.
// Wait for DB instance to be ready. Call rds.DescribeDbInstances and check for DBInstanceStatus == 'available'.
pub async fn start_cluster_and_instance(&mut self) -> Result<(), ScenarioError> {
if self.password.is_none() {
return Err(ScenarioError::with(
"Must set Secret Password before starting a cluster",
));
}
let create_db_cluster = self
.rds
.create_db_cluster(
DB_CLUSTER_IDENTIFIER,
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_ENGINE,
self.engine_version.as_deref().expect("engine version"),
self.username.as_deref().expect("username"),
self.password
.replace(SecretString::new("".to_string()))
.expect("password"),
)
.await;
if let Err(err) = create_db_cluster {
return Err(ScenarioError::new(
"Failed to create DB Cluster with cluster group",
&err,
));
}
self.db_cluster_identifier = create_db_cluster
.unwrap()
.db_cluster
.and_then(|c| c.db_cluster_identifier);
if self.db_cluster_identifier.is_none() {
return Err(ScenarioError::with("Created DB Cluster missing Identifier"));
}
info!(
"Started a db cluster: {}",
self.db_cluster_identifier
.as_deref()
.unwrap_or("Missing ARN")
);
let create_db_instance = self
.rds
.create_db_instance(
self.db_cluster_identifier.as_deref().expect("cluster name"),
DB_INSTANCE_IDENTIFIER,
self.instance_class.as_deref().expect("instance class"),
DB_ENGINE,
)
.await;
if let Err(err) = create_db_instance {
return Err(ScenarioError::new(
"Failed to create Instance in DB Cluster",
&err,
));
}
self.db_instance_identifier = create_db_instance
.unwrap()
.db_instance
.and_then(|i| i.db_instance_identifier);
// Cluster creation can take up to 20 minutes to become available
let cluster_max_wait = Duration::from_secs(20 * 60);
let waiter = Waiter::builder().max(cluster_max_wait).build();
while waiter.sleep().await.is_ok() {
let cluster = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = cluster {
warn!(?err, "Failed to describe cluster while waiting for ready");
continue;
}
let instance = self
.rds
.describe_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = instance {
return Err(ScenarioError::new(
"Failed to find instance for cluster",
&err,
));
}
let instances_available = instance
.unwrap()
.db_instances()
.iter()
.all(|instance| instance.db_instance_status() == Some("Available"));
let endpoints = self
.rds
.describe_db_cluster_endpoints(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = endpoints {
return Err(ScenarioError::new(
"Failed to find endpoint for cluster",
&err,
));
}
let endpoints_available = endpoints
.unwrap()
.db_cluster_endpoints()
.iter()
.all(|endpoint| endpoint.status() == Some("available"));
if instances_available && endpoints_available {
return Ok(());
}
}
Err(ScenarioError::with("timed out waiting for cluster"))
}
pub async fn snapshot_cluster(
&self,
db_cluster_identifier: &str,
snapshot_name: &str,
) -> Result> {
self.inner
.create_db_cluster_snapshot()
.db_cluster_identifier(db_cluster_identifier)
.db_cluster_snapshot_identifier(snapshot_name)
.send()
.await
}
#[tokio::test]
async fn test_start_cluster_and_instance() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_describe_db_instance()
.with(eq("RustSDKCodeExamplesDBInstance"))
.return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
assert!(scenario
.password
.replace(SecretString::new("BAD SECRET".into()))
.unwrap()
.expose_secret()
.is_empty());
assert_eq!(
scenario.db_cluster_identifier,
Some("RustSDKCodeExamplesDBCluster".into())
);
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Err(SdkError::service_error(
CreateDBClusterError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _}) if message == "Failed to create DB Cluster with cluster group")
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_missing_id() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context:_ }) if message == "Created DB Cluster missing Identifier");
}
#[tokio::test]
async fn test_start_cluster_and_instance_instance_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.return_once(|_, _, _, _| {
Err(SdkError::service_error(
CreateDBInstanceError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db instance error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _ }) if message == "Failed to create Instance in DB Cluster")
}
#[tokio::test]
async fn test_start_cluster_and_instance_wait_hiccup() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
})
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds.expect_describe_db_instance().return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, voir [Create DBCluster Snapshot](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_cluster_snapshot) in *AWS SDK for Rust API reference*.
------
# Utilisation `CreateDBInstance` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `CreateDBInstance`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Create an Amazon Relational Database Service (Amazon RDS) DB instance
/// with a particular set of properties. Use the action DescribeDBInstancesAsync
/// to determine when the DB instance is ready to use.
///
/// DB instance identifier.
/// DB cluster identifier.
/// The engine for the DB instance.
/// Version for the DB instance.
/// Class for the DB instance.
/// DB instance object.
public async Task CreateDBInstanceInClusterAsync(
string dbClusterIdentifier,
string dbInstanceIdentifier,
string dbEngine,
string dbEngineVersion,
string instanceClass)
{
// When creating the instance within a cluster, do not specify the name or size.
var response = await _amazonRDS.CreateDBInstanceAsync(
new CreateDBInstanceRequest()
{
DBClusterIdentifier = dbClusterIdentifier,
DBInstanceIdentifier = dbInstanceIdentifier,
Engine = dbEngine,
EngineVersion = dbEngineVersion,
DBInstanceClass = instanceClass
});
return response.DBInstance;
}
```
+ Pour plus de détails sur l'API, consultez [Create DBInstance](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBInstance) in *AWS SDK pour .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::CreateDBInstanceRequest request;
request.SetDBInstanceIdentifier(DB_INSTANCE_IDENTIFIER);
request.SetDBClusterIdentifier(DB_CLUSTER_IDENTIFIER);
request.SetEngine(engineName);
request.SetDBInstanceClass(dbInstanceClass);
Aws::RDS::Model::CreateDBInstanceOutcome outcome =
client.CreateDBInstance(request);
if (outcome.IsSuccess()) {
std::cout << "The DB instance creation has started."
<< std::endl;
}
else {
std::cerr << "Error with RDS::CreateDBInstance. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME, DB_CLUSTER_IDENTIFIER, "",
client);
return false;
}
```
+ Pour plus de détails sur l'API, consultez [Create DBInstance](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBInstance) in *AWS SDK pour C\$1\$1 API Reference*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// CreateInstanceInCluster creates a database instance in an existing DB cluster. The first database that is
// created defaults to a read-write DB instance.
func (clusters *DbClusters) CreateInstanceInCluster(ctx context.Context, clusterName string, instanceName string,
dbEngine string, dbInstanceClass string) (*types.DBInstance, error) {
output, err := clusters.AuroraClient.CreateDBInstance(ctx, &rds.CreateDBInstanceInput{
DBInstanceIdentifier: aws.String(instanceName),
DBClusterIdentifier: aws.String(clusterName),
Engine: aws.String(dbEngine),
DBInstanceClass: aws.String(dbInstanceClass),
})
if err != nil {
log.Printf("Couldn't create instance %v: %v\n", instanceName, err)
return nil, err
} else {
return output.DBInstance, nil
}
}
```
+ Pour plus de détails sur l'API, consultez [Create DBInstance](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.CreateDBInstance) in *AWS SDK pour Go API Reference*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static String createDBInstanceCluster(RdsClient rdsClient,
String dbInstanceIdentifier,
String dbInstanceClusterIdentifier,
String instanceClass) {
try {
CreateDbInstanceRequest instanceRequest = CreateDbInstanceRequest.builder()
.dbInstanceIdentifier(dbInstanceIdentifier)
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.engine("aurora-mysql")
.dbInstanceClass(instanceClass)
.build();
CreateDbInstanceResponse response = rdsClient.createDBInstance(instanceRequest);
System.out.print("The status is " + response.dbInstance().dbInstanceStatus());
return response.dbInstance().dbInstanceArn();
} catch (RdsException e) {
System.err.println(e.getMessage());
System.exit(1);
}
return "";
}
```
+ Pour plus de détails sur l'API, consultez [Create DBInstance](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBInstance) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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
}
}
```
+ Pour plus de détails sur l'API, voir [Create DBInstance](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def create_instance_in_cluster(
self, instance_id, cluster_id, db_engine, instance_class
):
"""
Creates a database instance in an existing DB cluster. The first database that is
created defaults to a read-write DB instance.
:param instance_id: The ID to give the newly created DB instance.
:param cluster_id: The ID of the DB cluster where the DB instance is created.
:param db_engine: The database engine of a database to create in the DB instance.
This must be compatible with the configured parameter group
of the DB cluster.
:param instance_class: The DB instance class for the newly created DB instance.
:return: Data about the newly created DB instance.
"""
try:
response = self.rds_client.create_db_instance(
DBInstanceIdentifier=instance_id,
DBClusterIdentifier=cluster_id,
Engine=db_engine,
DBInstanceClass=instance_class,
)
db_inst = response["DBInstance"]
except ClientError as err:
logger.error(
"Couldn't create DB instance %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return db_inst
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Create DBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBInstance) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Get a list of allowed engine versions. rds.DescribeDbEngineVersions(Engine='aurora-mysql', DBParameterGroupFamily=)
// Create an Aurora DB cluster database cluster that contains a MySql database and uses the parameter group you created.
// Wait for DB cluster to be ready. Call rds.DescribeDBClusters and check for Status == 'available'.
// Get a list of instance classes available for the selected engine and engine version. rds.DescribeOrderableDbInstanceOptions(Engine='mysql', EngineVersion=).
// Create a database instance in the cluster.
// Wait for DB instance to be ready. Call rds.DescribeDbInstances and check for DBInstanceStatus == 'available'.
pub async fn start_cluster_and_instance(&mut self) -> Result<(), ScenarioError> {
if self.password.is_none() {
return Err(ScenarioError::with(
"Must set Secret Password before starting a cluster",
));
}
let create_db_cluster = self
.rds
.create_db_cluster(
DB_CLUSTER_IDENTIFIER,
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_ENGINE,
self.engine_version.as_deref().expect("engine version"),
self.username.as_deref().expect("username"),
self.password
.replace(SecretString::new("".to_string()))
.expect("password"),
)
.await;
if let Err(err) = create_db_cluster {
return Err(ScenarioError::new(
"Failed to create DB Cluster with cluster group",
&err,
));
}
self.db_cluster_identifier = create_db_cluster
.unwrap()
.db_cluster
.and_then(|c| c.db_cluster_identifier);
if self.db_cluster_identifier.is_none() {
return Err(ScenarioError::with("Created DB Cluster missing Identifier"));
}
info!(
"Started a db cluster: {}",
self.db_cluster_identifier
.as_deref()
.unwrap_or("Missing ARN")
);
let create_db_instance = self
.rds
.create_db_instance(
self.db_cluster_identifier.as_deref().expect("cluster name"),
DB_INSTANCE_IDENTIFIER,
self.instance_class.as_deref().expect("instance class"),
DB_ENGINE,
)
.await;
if let Err(err) = create_db_instance {
return Err(ScenarioError::new(
"Failed to create Instance in DB Cluster",
&err,
));
}
self.db_instance_identifier = create_db_instance
.unwrap()
.db_instance
.and_then(|i| i.db_instance_identifier);
// Cluster creation can take up to 20 minutes to become available
let cluster_max_wait = Duration::from_secs(20 * 60);
let waiter = Waiter::builder().max(cluster_max_wait).build();
while waiter.sleep().await.is_ok() {
let cluster = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = cluster {
warn!(?err, "Failed to describe cluster while waiting for ready");
continue;
}
let instance = self
.rds
.describe_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = instance {
return Err(ScenarioError::new(
"Failed to find instance for cluster",
&err,
));
}
let instances_available = instance
.unwrap()
.db_instances()
.iter()
.all(|instance| instance.db_instance_status() == Some("Available"));
let endpoints = self
.rds
.describe_db_cluster_endpoints(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = endpoints {
return Err(ScenarioError::new(
"Failed to find endpoint for cluster",
&err,
));
}
let endpoints_available = endpoints
.unwrap()
.db_cluster_endpoints()
.iter()
.all(|endpoint| endpoint.status() == Some("available"));
if instances_available && endpoints_available {
return Ok(());
}
}
Err(ScenarioError::with("timed out waiting for cluster"))
}
pub async fn create_db_instance(
&self,
cluster_name: &str,
instance_name: &str,
instance_class: &str,
engine: &str,
) -> Result> {
self.inner
.create_db_instance()
.db_cluster_identifier(cluster_name)
.db_instance_identifier(instance_name)
.db_instance_class(instance_class)
.engine(engine)
.send()
.await
}
#[tokio::test]
async fn test_start_cluster_and_instance() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_describe_db_instance()
.with(eq("RustSDKCodeExamplesDBInstance"))
.return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
assert!(scenario
.password
.replace(SecretString::new("BAD SECRET".into()))
.unwrap()
.expose_secret()
.is_empty());
assert_eq!(
scenario.db_cluster_identifier,
Some("RustSDKCodeExamplesDBCluster".into())
);
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Err(SdkError::service_error(
CreateDBClusterError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _}) if message == "Failed to create DB Cluster with cluster group")
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_missing_id() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context:_ }) if message == "Created DB Cluster missing Identifier");
}
#[tokio::test]
async fn test_start_cluster_and_instance_instance_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.return_once(|_, _, _, _| {
Err(SdkError::service_error(
CreateDBInstanceError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db instance error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _ }) if message == "Failed to create Instance in DB Cluster")
}
#[tokio::test]
async fn test_start_cluster_and_instance_wait_hiccup() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
})
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds.expect_describe_db_instance().return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, voir [Create DBInstance](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.create_db_instance) in *AWS SDK for Rust API reference*.
------
# Utilisation `DeleteDBCluster` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DeleteDBCluster`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Delete a particular DB cluster.
///
/// DB cluster identifier.
/// DB cluster object.
public async Task DeleteDBClusterByIdentifierAsync(string dbClusterIdentifier)
{
var response = await _amazonRDS.DeleteDBClusterAsync(
new DeleteDBClusterRequest()
{
DBClusterIdentifier = dbClusterIdentifier,
SkipFinalSnapshot = true
});
return response.DBCluster;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster dans le](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBCluster) manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::DeleteDBClusterRequest request;
request.SetDBClusterIdentifier(dbClusterIdentifier);
request.SetSkipFinalSnapshot(true);
Aws::RDS::Model::DeleteDBClusterOutcome outcome =
client.DeleteDBCluster(request);
if (outcome.IsSuccess()) {
std::cout << "DB cluster deletion has started."
<< std::endl;
clusterDeleting = true;
std::cout
<< "Waiting for DB cluster to delete before deleting the parameter group."
<< std::endl;
std::cout << "This may take a while." << std::endl;
}
else {
std::cerr << "Error with Aurora::DeleteDBCluster. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster dans le](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBCluster) manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// DeleteDbCluster deletes a DB cluster without keeping a final snapshot.
func (clusters *DbClusters) DeleteDbCluster(ctx context.Context, clusterName string) error {
_, err := clusters.AuroraClient.DeleteDBCluster(ctx, &rds.DeleteDBClusterInput{
DBClusterIdentifier: aws.String(clusterName),
SkipFinalSnapshot: aws.Bool(true),
})
if err != nil {
log.Printf("Couldn't delete DB cluster %v: %v\n", clusterName, err)
return err
} else {
return nil
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster dans le](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DeleteDBCluster) manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void deleteCluster(RdsClient rdsClient, String dbInstanceClusterIdentifier) {
try {
DeleteDbClusterRequest deleteDbClusterRequest = DeleteDbClusterRequest.builder()
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.skipFinalSnapshot(true)
.build();
rdsClient.deleteDBCluster(deleteDbClusterRequest);
System.out.println(dbInstanceClusterIdentifier + " was deleted!");
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster dans le](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBCluster) manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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!")
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster dans le AWS](https://sdk.amazonaws.com/kotlin/api/latest/index.html) *SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def delete_db_cluster(self, cluster_name):
"""
Deletes a DB cluster.
:param cluster_name: The name of the DB cluster to delete.
"""
try:
self.rds_client.delete_db_cluster(
DBClusterIdentifier=cluster_name, SkipFinalSnapshot=True
)
logger.info("Deleted DB cluster %s.", cluster_name)
except ClientError:
logger.exception("Couldn't delete DB cluster %s.", cluster_name)
raise
```
+ Pour plus de détails sur l'API, consultez [le manuel de référence de l'API Delete DBCluster](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBCluster) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
pub async fn clean_up(self) -> Result<(), Vec> {
let mut clean_up_errors: Vec = vec![];
// Delete the instance. rds.DeleteDbInstance.
let delete_db_instance = self
.rds
.delete_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = delete_db_instance {
let identifier = self
.db_instance_identifier
.as_deref()
.unwrap_or("Missing Instance Identifier");
let message = format!("failed to delete db instance {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance to delete
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_instances = self.rds.describe_db_instances().await;
if let Err(err) = describe_db_instances {
clean_up_errors.push(ScenarioError::new(
"Failed to check instance state during deletion",
&err,
));
break;
}
let db_instances = describe_db_instances
.unwrap()
.db_instances()
.iter()
.filter(|instance| instance.db_cluster_identifier == self.db_cluster_identifier)
.cloned()
.collect::>();
if db_instances.is_empty() {
trace!("Delete Instance waited and no instances were found");
break;
}
match db_instances.first().unwrap().db_instance_status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but instances is in {status}");
continue;
}
None => {
warn!("No status for DB instance");
break;
}
}
}
}
// Delete the DB cluster. rds.DeleteDbCluster.
let delete_db_cluster = self
.rds
.delete_db_cluster(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = delete_db_cluster {
let identifier = self
.db_cluster_identifier
.as_deref()
.unwrap_or("Missing DB Cluster Identifier");
let message = format!("failed to delete db cluster {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance and cluster to fully delete. rds.DescribeDbInstances and rds.DescribeDbClusters until both are not found.
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_clusters = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = describe_db_clusters {
clean_up_errors.push(ScenarioError::new(
"Failed to check cluster state during deletion",
&err,
));
break;
}
let describe_db_clusters = describe_db_clusters.unwrap();
let db_clusters = describe_db_clusters.db_clusters();
if db_clusters.is_empty() {
trace!("Delete cluster waited and no clusters were found");
break;
}
match db_clusters.first().unwrap().status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but clusters is in {status}");
continue;
}
None => {
warn!("No status for DB cluster");
break;
}
}
}
}
// Delete the DB cluster parameter group. rds.DeleteDbClusterParameterGroup.
let delete_db_cluster_parameter_group = self
.rds
.delete_db_cluster_parameter_group(
self.db_cluster_parameter_group
.map(|g| {
g.db_cluster_parameter_group_name
.unwrap_or_else(|| DB_CLUSTER_PARAMETER_GROUP_NAME.to_string())
})
.as_deref()
.expect("cluster parameter group name"),
)
.await;
if let Err(error) = delete_db_cluster_parameter_group {
clean_up_errors.push(ScenarioError::new(
"Failed to delete the db cluster parameter group",
&error,
))
}
if clean_up_errors.is_empty() {
Ok(())
} else {
Err(clean_up_errors)
}
}
pub async fn delete_db_cluster(
&self,
cluster_identifier: &str,
) -> Result> {
self.inner
.delete_db_cluster()
.db_cluster_identifier(cluster_identifier)
.skip_final_snapshot(true)
.send()
.await
}
#[tokio::test]
async fn test_scenario_clean_up() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| Ok(DescribeDbInstancesOutput::builder().build()));
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| Ok(DescribeDbClustersOutput::builder().build()));
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_scenario_clean_up_errors() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| {
Err(SdkError::service_error(
DescribeDBInstancesError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db instances error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db clusters error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_err());
let errs = clean_up.unwrap_err();
assert_eq!(errs.len(), 2);
assert_matches!(errs.first(), Some(ScenarioError {message, context: _}) if message == "Failed to check instance state during deletion");
assert_matches!(errs.get(1), Some(ScenarioError {message, context: _}) if message == "Failed to check cluster state during deletion");
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster dans le AWS](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.delete_db_cluster) *SDK pour la référence de l'API Rust*.
------
# Utilisation `DeleteDBClusterParameterGroup` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DeleteDBClusterParameterGroup`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Delete a particular parameter group by name.
///
/// The name of the parameter group.
/// True if successful.
public async Task DeleteClusterParameterGroupByNameAsync(string groupName)
{
var request = new DeleteDBClusterParameterGroupRequest
{
DBClusterParameterGroupName = groupName,
};
var response = await _amazonRDS.DeleteDBClusterParameterGroupAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBClusterParameterGroup) manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::DeleteDBClusterParameterGroupRequest request;
request.SetDBClusterParameterGroupName(parameterGroupName);
Aws::RDS::Model::DeleteDBClusterParameterGroupOutcome outcome =
client.DeleteDBClusterParameterGroup(request);
if (outcome.IsSuccess()) {
std::cout << "The DB parameter group was successfully deleted."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::DeleteDBClusterParameterGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBClusterParameterGroup) manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// DeleteParameterGroup deletes the named DB cluster parameter group.
func (clusters *DbClusters) DeleteParameterGroup(ctx context.Context, parameterGroupName string) error {
_, err := clusters.AuroraClient.DeleteDBClusterParameterGroup(ctx,
&rds.DeleteDBClusterParameterGroupInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
})
if err != nil {
log.Printf("Couldn't delete parameter group %v: %v\n", parameterGroupName, err)
return err
} else {
return nil
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DeleteDBClusterParameterGroup) manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void deleteDBClusterGroup(RdsClient rdsClient, String dbClusterGroupName, String clusterDBARN)
throws InterruptedException {
try {
boolean isDataDel = false;
boolean didFind;
String instanceARN;
// Make sure that the database has been deleted.
while (!isDataDel) {
DescribeDbInstancesResponse response = rdsClient.describeDBInstances();
List instanceList = response.dbInstances();
int listSize = instanceList.size();
didFind = false;
int index = 1;
for (DBInstance instance : instanceList) {
instanceARN = instance.dbInstanceArn();
if (instanceARN.compareTo(clusterDBARN) == 0) {
System.out.println(clusterDBARN + " still exists");
didFind = true;
}
if ((index == listSize) && (!didFind)) {
// Went through the entire list and did not find the database ARN.
isDataDel = true;
}
Thread.sleep(sleepTime * 1000);
index++;
}
}
DeleteDbClusterParameterGroupRequest clusterParameterGroupRequest = DeleteDbClusterParameterGroupRequest
.builder()
.dbClusterParameterGroupName(dbClusterGroupName)
.build();
rdsClient.deleteDBClusterParameterGroup(clusterParameterGroupRequest);
System.out.println(dbClusterGroupName + " was deleted.");
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBClusterParameterGroup) manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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.")
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le AWS](https://sdk.amazonaws.com/kotlin/api/latest/index.html) *SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def delete_parameter_group(self, parameter_group_name):
"""
Deletes a DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to delete.
:return: Data about the parameter group.
"""
try:
response = self.rds_client.delete_db_cluster_parameter_group(
DBClusterParameterGroupName=parameter_group_name
)
except ClientError as err:
logger.error(
"Couldn't delete parameter group %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
```
+ Pour plus de détails sur l'API, consultez [le manuel de référence de l'API Delete DBCluster ParameterGroup](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBClusterParameterGroup) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
pub async fn clean_up(self) -> Result<(), Vec> {
let mut clean_up_errors: Vec = vec![];
// Delete the instance. rds.DeleteDbInstance.
let delete_db_instance = self
.rds
.delete_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = delete_db_instance {
let identifier = self
.db_instance_identifier
.as_deref()
.unwrap_or("Missing Instance Identifier");
let message = format!("failed to delete db instance {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance to delete
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_instances = self.rds.describe_db_instances().await;
if let Err(err) = describe_db_instances {
clean_up_errors.push(ScenarioError::new(
"Failed to check instance state during deletion",
&err,
));
break;
}
let db_instances = describe_db_instances
.unwrap()
.db_instances()
.iter()
.filter(|instance| instance.db_cluster_identifier == self.db_cluster_identifier)
.cloned()
.collect::>();
if db_instances.is_empty() {
trace!("Delete Instance waited and no instances were found");
break;
}
match db_instances.first().unwrap().db_instance_status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but instances is in {status}");
continue;
}
None => {
warn!("No status for DB instance");
break;
}
}
}
}
// Delete the DB cluster. rds.DeleteDbCluster.
let delete_db_cluster = self
.rds
.delete_db_cluster(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = delete_db_cluster {
let identifier = self
.db_cluster_identifier
.as_deref()
.unwrap_or("Missing DB Cluster Identifier");
let message = format!("failed to delete db cluster {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance and cluster to fully delete. rds.DescribeDbInstances and rds.DescribeDbClusters until both are not found.
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_clusters = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = describe_db_clusters {
clean_up_errors.push(ScenarioError::new(
"Failed to check cluster state during deletion",
&err,
));
break;
}
let describe_db_clusters = describe_db_clusters.unwrap();
let db_clusters = describe_db_clusters.db_clusters();
if db_clusters.is_empty() {
trace!("Delete cluster waited and no clusters were found");
break;
}
match db_clusters.first().unwrap().status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but clusters is in {status}");
continue;
}
None => {
warn!("No status for DB cluster");
break;
}
}
}
}
// Delete the DB cluster parameter group. rds.DeleteDbClusterParameterGroup.
let delete_db_cluster_parameter_group = self
.rds
.delete_db_cluster_parameter_group(
self.db_cluster_parameter_group
.map(|g| {
g.db_cluster_parameter_group_name
.unwrap_or_else(|| DB_CLUSTER_PARAMETER_GROUP_NAME.to_string())
})
.as_deref()
.expect("cluster parameter group name"),
)
.await;
if let Err(error) = delete_db_cluster_parameter_group {
clean_up_errors.push(ScenarioError::new(
"Failed to delete the db cluster parameter group",
&error,
))
}
if clean_up_errors.is_empty() {
Ok(())
} else {
Err(clean_up_errors)
}
}
pub async fn delete_db_cluster_parameter_group(
&self,
name: &str,
) -> Result>
{
self.inner
.delete_db_cluster_parameter_group()
.db_cluster_parameter_group_name(name)
.send()
.await
}
#[tokio::test]
async fn test_scenario_clean_up() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| Ok(DescribeDbInstancesOutput::builder().build()));
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| Ok(DescribeDbClustersOutput::builder().build()));
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_scenario_clean_up_errors() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| {
Err(SdkError::service_error(
DescribeDBInstancesError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db instances error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db clusters error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_err());
let errs = clean_up.unwrap_err();
assert_eq!(errs.len(), 2);
assert_matches!(errs.first(), Some(ScenarioError {message, context: _}) if message == "Failed to check instance state during deletion");
assert_matches!(errs.get(1), Some(ScenarioError {message, context: _}) if message == "Failed to check cluster state during deletion");
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le AWS](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.delete_db_cluster_parameter_group) *SDK pour la référence de l'API Rust*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/rds#code-examples).
```
TRY.
lo_rds->deletedbclusterparamgroup(
iv_dbclusterparamgroupname = iv_param_group_name
).
CATCH /aws1/cx_rdsdbprmgrnotfndfault.
" Re-raise exception - parameter group not found
RAISE EXCEPTION TYPE /aws1/cx_rdsdbprmgrnotfndfault.
CATCH /aws1/cx_rdsinvdbprmgrstatef00.
" Re-raise exception - invalid state
RAISE EXCEPTION TYPE /aws1/cx_rdsinvdbprmgrstatef00.
ENDTRY.
```
+ Pour plus de détails sur l'API, voir [Supprimer DBCluster ParameterGroup dans le AWS](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) *SDK pour la référence de l'API SAP ABAP*.
------
# Utilisation `DeleteDBInstance` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DeleteDBInstance`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Delete a particular DB instance.
///
/// DB instance identifier.
/// DB instance object.
public async Task DeleteDBInstanceByIdentifierAsync(string dbInstanceIdentifier)
{
var response = await _amazonRDS.DeleteDBInstanceAsync(
new DeleteDBInstanceRequest()
{
DBInstanceIdentifier = dbInstanceIdentifier,
SkipFinalSnapshot = true,
DeleteAutomatedBackups = true
});
return response.DBInstance;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBInstance dans le](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBInstance) manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::DeleteDBInstanceRequest request;
request.SetDBInstanceIdentifier(dbInstanceIdentifier);
request.SetSkipFinalSnapshot(true);
request.SetDeleteAutomatedBackups(true);
Aws::RDS::Model::DeleteDBInstanceOutcome outcome =
client.DeleteDBInstance(request);
if (outcome.IsSuccess()) {
std::cout << "DB instance deletion has started."
<< std::endl;
instanceDeleting = true;
std::cout
<< "Waiting for DB instance to delete before deleting the parameter group."
<< std::endl;
}
else {
std::cerr << "Error with Aurora::DeleteDBInstance. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBInstance dans le](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBInstance) manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// DeleteInstance deletes a DB instance.
func (clusters *DbClusters) DeleteInstance(ctx context.Context, instanceName string) error {
_, err := clusters.AuroraClient.DeleteDBInstance(ctx, &rds.DeleteDBInstanceInput{
DBInstanceIdentifier: aws.String(instanceName),
SkipFinalSnapshot: aws.Bool(true),
DeleteAutomatedBackups: aws.Bool(true),
})
if err != nil {
log.Printf("Couldn't delete instance %v: %v\n", instanceName, err)
return err
} else {
return nil
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBInstance dans le](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DeleteDBInstance) manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void deleteDatabaseInstance(RdsClient rdsClient, String dbInstanceIdentifier) {
try {
DeleteDbInstanceRequest deleteDbInstanceRequest = DeleteDbInstanceRequest.builder()
.dbInstanceIdentifier(dbInstanceIdentifier)
.deleteAutomatedBackups(true)
.skipFinalSnapshot(true)
.build();
DeleteDbInstanceResponse response = rdsClient.deleteDBInstance(deleteDbInstanceRequest);
System.out.println("The status of the database is " + response.dbInstance().dbInstanceStatus());
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBInstance dans le](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBInstance) manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBInstance dans le AWS](https://sdk.amazonaws.com/kotlin/api/latest/index.html) *SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def delete_db_instance(self, instance_id):
"""
Deletes a DB instance.
:param instance_id: The ID of the DB instance to delete.
:return: Data about the deleted DB instance.
"""
try:
response = self.rds_client.delete_db_instance(
DBInstanceIdentifier=instance_id,
SkipFinalSnapshot=True,
DeleteAutomatedBackups=True,
)
db_inst = response["DBInstance"]
except ClientError as err:
logger.error(
"Couldn't delete DB instance %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return db_inst
```
+ Pour plus de détails sur l'API, consultez [le manuel de référence de l'API Delete DBInstance](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBInstance) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
pub async fn clean_up(self) -> Result<(), Vec> {
let mut clean_up_errors: Vec = vec![];
// Delete the instance. rds.DeleteDbInstance.
let delete_db_instance = self
.rds
.delete_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = delete_db_instance {
let identifier = self
.db_instance_identifier
.as_deref()
.unwrap_or("Missing Instance Identifier");
let message = format!("failed to delete db instance {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance to delete
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_instances = self.rds.describe_db_instances().await;
if let Err(err) = describe_db_instances {
clean_up_errors.push(ScenarioError::new(
"Failed to check instance state during deletion",
&err,
));
break;
}
let db_instances = describe_db_instances
.unwrap()
.db_instances()
.iter()
.filter(|instance| instance.db_cluster_identifier == self.db_cluster_identifier)
.cloned()
.collect::>();
if db_instances.is_empty() {
trace!("Delete Instance waited and no instances were found");
break;
}
match db_instances.first().unwrap().db_instance_status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but instances is in {status}");
continue;
}
None => {
warn!("No status for DB instance");
break;
}
}
}
}
// Delete the DB cluster. rds.DeleteDbCluster.
let delete_db_cluster = self
.rds
.delete_db_cluster(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = delete_db_cluster {
let identifier = self
.db_cluster_identifier
.as_deref()
.unwrap_or("Missing DB Cluster Identifier");
let message = format!("failed to delete db cluster {identifier}");
clean_up_errors.push(ScenarioError::new(message, &err));
} else {
// Wait for the instance and cluster to fully delete. rds.DescribeDbInstances and rds.DescribeDbClusters until both are not found.
let waiter = Waiter::default();
while waiter.sleep().await.is_ok() {
let describe_db_clusters = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = describe_db_clusters {
clean_up_errors.push(ScenarioError::new(
"Failed to check cluster state during deletion",
&err,
));
break;
}
let describe_db_clusters = describe_db_clusters.unwrap();
let db_clusters = describe_db_clusters.db_clusters();
if db_clusters.is_empty() {
trace!("Delete cluster waited and no clusters were found");
break;
}
match db_clusters.first().unwrap().status() {
Some("Deleting") => continue,
Some(status) => {
info!("Attempting to delete but clusters is in {status}");
continue;
}
None => {
warn!("No status for DB cluster");
break;
}
}
}
}
// Delete the DB cluster parameter group. rds.DeleteDbClusterParameterGroup.
let delete_db_cluster_parameter_group = self
.rds
.delete_db_cluster_parameter_group(
self.db_cluster_parameter_group
.map(|g| {
g.db_cluster_parameter_group_name
.unwrap_or_else(|| DB_CLUSTER_PARAMETER_GROUP_NAME.to_string())
})
.as_deref()
.expect("cluster parameter group name"),
)
.await;
if let Err(error) = delete_db_cluster_parameter_group {
clean_up_errors.push(ScenarioError::new(
"Failed to delete the db cluster parameter group",
&error,
))
}
if clean_up_errors.is_empty() {
Ok(())
} else {
Err(clean_up_errors)
}
}
pub async fn delete_db_instance(
&self,
instance_identifier: &str,
) -> Result> {
self.inner
.delete_db_instance()
.db_instance_identifier(instance_identifier)
.skip_final_snapshot(true)
.send()
.await
}
#[tokio::test]
async fn test_scenario_clean_up() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| Ok(DescribeDbInstancesOutput::builder().build()));
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| Ok(DescribeDbClustersOutput::builder().build()));
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_scenario_clean_up_errors() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_delete_db_instance()
.with(eq("MockInstance"))
.return_once(|_| Ok(DeleteDbInstanceOutput::builder().build()));
mock_rds
.expect_describe_db_instances()
.with()
.times(1)
.returning(|| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_cluster_identifier("MockCluster")
.db_instance_status("Deleting")
.build(),
)
.build())
})
.with()
.times(1)
.returning(|| {
Err(SdkError::service_error(
DescribeDBInstancesError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db instances error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster()
.with(eq("MockCluster"))
.return_once(|_| Ok(DeleteDbClusterOutput::builder().build()));
mock_rds
.expect_describe_db_clusters()
.with(eq("MockCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(
DbCluster::builder()
.db_cluster_identifier(id)
.status("Deleting")
.build(),
)
.build())
})
.with(eq("MockCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe db clusters error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
mock_rds
.expect_delete_db_cluster_parameter_group()
.with(eq("MockParamGroup"))
.return_once(|_| Ok(DeleteDbClusterParameterGroupOutput::builder().build()));
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some(String::from("MockCluster"));
scenario.db_instance_identifier = Some(String::from("MockInstance"));
scenario.db_cluster_parameter_group = Some(
DbClusterParameterGroup::builder()
.db_cluster_parameter_group_name("MockParamGroup")
.build(),
);
tokio::time::pause();
let assertions = tokio::spawn(async move {
let clean_up = scenario.clean_up().await;
assert!(clean_up.is_err());
let errs = clean_up.unwrap_err();
assert_eq!(errs.len(), 2);
assert_matches!(errs.first(), Some(ScenarioError {message, context: _}) if message == "Failed to check instance state during deletion");
assert_matches!(errs.get(1), Some(ScenarioError {message, context: _}) if message == "Failed to check cluster state during deletion");
});
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Instances
tokio::time::advance(Duration::from_secs(1)).await; // Wait for first Describe Cluster
tokio::time::advance(Duration::from_secs(1)).await; // Wait for second Describe Cluster
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, voir [Supprimer DBInstance dans le AWS](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.delete_db_instance) *SDK pour la référence de l'API Rust*.
------
# Utilisation `DescribeDBClusterParameterGroups` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DescribeDBClusterParameterGroups`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Get the description of a DB cluster parameter group by name.
///
/// The name of the DB parameter group to describe.
/// The parameter group description.
public async Task DescribeCustomDBClusterParameterGroupAsync(string name)
{
var response = await _amazonRDS.DescribeDBClusterParameterGroupsAsync(
new DescribeDBClusterParameterGroupsRequest()
{
DBClusterParameterGroupName = name
});
return response.DBClusterParameterGroups.FirstOrDefault();
}
```
+ Pour plus de détails sur l'API, voir [Description DBCluster ParameterGroups](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterParameterGroups) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::DescribeDBClusterParameterGroupsRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
Aws::RDS::Model::DescribeDBClusterParameterGroupsOutcome outcome =
client.DescribeDBClusterParameterGroups(request);
if (outcome.IsSuccess()) {
std::cout << "DB cluster parameter group named '" <<
CLUSTER_PARAMETER_GROUP_NAME << "' already exists." << std::endl;
dbParameterGroupFamily = outcome.GetResult().GetDBClusterParameterGroups()[0].GetDBParameterGroupFamily();
}
else {
std::cerr << "Error with Aurora::DescribeDBClusterParameterGroups. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
```
+ Pour plus de détails sur l'API, voir [Description DBCluster ParameterGroups](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterParameterGroups) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetParameterGroup gets a DB cluster parameter group by name.
func (clusters *DbClusters) GetParameterGroup(ctx context.Context, parameterGroupName string) (
*types.DBClusterParameterGroup, error) {
output, err := clusters.AuroraClient.DescribeDBClusterParameterGroups(
ctx, &rds.DescribeDBClusterParameterGroupsInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
})
if err != nil {
var notFoundError *types.DBParameterGroupNotFoundFault
if errors.As(err, ¬FoundError) {
log.Printf("Parameter group %v does not exist.\n", parameterGroupName)
err = nil
} else {
log.Printf("Error getting parameter group %v: %v\n", parameterGroupName, err)
}
return nil, err
} else {
return &output.DBClusterParameterGroups[0], err
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBCluster ParameterGroups](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusterParameterGroups) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void describeDbClusterParameterGroups(RdsClient rdsClient, String dbClusterGroupName) {
try {
DescribeDbClusterParameterGroupsRequest groupsRequest = DescribeDbClusterParameterGroupsRequest.builder()
.dbClusterParameterGroupName(dbClusterGroupName)
.maxRecords(20)
.build();
List groups = rdsClient.describeDBClusterParameterGroups(groupsRequest)
.dbClusterParameterGroups();
for (DBClusterParameterGroup group : groups) {
System.out.println("The group name is " + group.dbClusterParameterGroupName());
System.out.println("The group ARN is " + group.dbClusterParameterGroupArn());
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBCluster ParameterGroups](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterParameterGroups) dans le manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBCluster ParameterGroups](https://sdk.amazonaws.com/kotlin/api/latest/index.html) dans le *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def get_parameter_group(self, parameter_group_name):
"""
Gets a DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to retrieve.
:return: The requested parameter group.
"""
try:
response = self.rds_client.describe_db_cluster_parameter_groups(
DBClusterParameterGroupName=parameter_group_name
)
parameter_group = response["DBClusterParameterGroups"][0]
except ClientError as err:
if err.response["Error"]["Code"] == "DBParameterGroupNotFound":
logger.info("Parameter group %s does not exist.", parameter_group_name)
else:
logger.error(
"Couldn't get parameter group %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return parameter_group
```
+ Pour plus de détails sur l'API, voir [AWS Describe DBCluster ParameterGroups](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterParameterGroups) *in SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/rds#code-examples).
```
TRY.
DATA(lo_output) = lo_rds->describedbclusterparamgroups(
iv_dbclusterparamgroupname = iv_param_group_name
).
DATA(lt_param_groups) = lo_output->get_dbclusterparametergroups( ).
IF lines( lt_param_groups ) > 0.
oo_result = lt_param_groups[ 1 ].
ENDIF.
CATCH /aws1/cx_rdsdbprmgrnotfndfault.
ENDTRY.
```
+ Pour plus de détails sur l'API, consultez la section [Description DBCluster ParameterGroups](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) dans le *AWS SDK pour la référence de l'API SAP ABAP*.
------
# Utilisation `DescribeDBClusterParameters` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DescribeDBClusterParameters`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Describe the cluster parameters in a parameter group.
///
/// The name of the parameter group.
/// The optional name of the source filter.
/// The collection of parameters.
public async Task> DescribeDBClusterParametersInGroupAsync(string groupName, string? source = null)
{
var paramList = new List();
DescribeDBClusterParametersResponse response;
var request = new DescribeDBClusterParametersRequest
{
DBClusterParameterGroupName = groupName,
Source = source,
};
// Get the full list if there are multiple pages.
do
{
response = await _amazonRDS.DescribeDBClusterParametersAsync(request);
paramList.AddRange(response.Parameters);
request.Marker = response.Marker;
}
while (response.Marker is not null);
return paramList;
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterParameters) dans le *AWS SDK pour .NET manuel de référence des API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
//! Routine which gets DB parameters using the 'DescribeDBClusterParameters' api.
/*!
\sa getDBCLusterParameters()
\param parameterGroupName: The name of the cluster parameter group.
\param namePrefix: Prefix string to filter results by parameter name.
\param source: A source such as 'user', ignored if empty.
\param parametersResult: Vector of 'Parameter' objects returned by the routine.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::getDBCLusterParameters(const Aws::String ¶meterGroupName,
const Aws::String &namePrefix,
const Aws::String &source,
Aws::Vector ¶metersResult,
const Aws::RDS::RDSClient &client) {
Aws::String marker; // The marker is used for pagination.
do {
Aws::RDS::Model::DescribeDBClusterParametersRequest request;
request.SetDBClusterParameterGroupName(CLUSTER_PARAMETER_GROUP_NAME);
if (!marker.empty()) {
request.SetMarker(marker);
}
if (!source.empty()) {
request.SetSource(source);
}
Aws::RDS::Model::DescribeDBClusterParametersOutcome outcome =
client.DescribeDBClusterParameters(request);
if (outcome.IsSuccess()) {
const Aws::Vector ¶meters =
outcome.GetResult().GetParameters();
for (const Aws::RDS::Model::Parameter ¶meter: parameters) {
if (!namePrefix.empty()) {
if (parameter.GetParameterName().find(namePrefix) == 0) {
parametersResult.push_back(parameter);
}
}
else {
parametersResult.push_back(parameter);
}
}
marker = outcome.GetResult().GetMarker();
}
else {
std::cerr << "Error with Aurora::DescribeDBClusterParameters. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
} while (!marker.empty());
return true;
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterParameters) dans le *AWS SDK pour C\$1\$1 manuel de référence des API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetParameters gets the parameters that are contained in a DB cluster parameter group.
func (clusters *DbClusters) GetParameters(ctx context.Context, parameterGroupName string, source string) (
[]types.Parameter, error) {
var output *rds.DescribeDBClusterParametersOutput
var params []types.Parameter
var err error
parameterPaginator := rds.NewDescribeDBClusterParametersPaginator(clusters.AuroraClient,
&rds.DescribeDBClusterParametersInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
Source: aws.String(source),
})
for parameterPaginator.HasMorePages() {
output, err = parameterPaginator.NextPage(ctx)
if err != nil {
log.Printf("Couldn't get paramaeters for %v: %v\n", parameterGroupName, err)
break
} else {
params = append(params, output.Parameters...)
}
}
return params, err
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire DBCluster les paramètres](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusterParameters) dans le *AWS SDK pour Go manuel de référence des API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void describeDbClusterParameters(RdsClient rdsClient, String dbCLusterGroupName, int flag) {
try {
DescribeDbClusterParametersRequest dbParameterGroupsRequest;
if (flag == 0) {
dbParameterGroupsRequest = DescribeDbClusterParametersRequest.builder()
.dbClusterParameterGroupName(dbCLusterGroupName)
.build();
} else {
dbParameterGroupsRequest = DescribeDbClusterParametersRequest.builder()
.dbClusterParameterGroupName(dbCLusterGroupName)
.source("user")
.build();
}
DescribeDbClusterParametersResponse response = rdsClient
.describeDBClusterParameters(dbParameterGroupsRequest);
List dbParameters = response.parameters();
String paraName;
for (Parameter para : dbParameters) {
// Only print out information about either auto_increment_offset or
// auto_increment_increment.
paraName = para.parameterName();
if ((paraName.compareTo("auto_increment_offset") == 0)
|| (paraName.compareTo("auto_increment_increment ") == 0)) {
System.out.println("*** The parameter name is " + paraName);
System.out.println("*** The parameter value is " + para.parameterValue());
System.out.println("*** The parameter data type is " + para.dataType());
System.out.println("*** The parameter description is " + para.description());
System.out.println("*** The parameter allowed values is " + para.allowedValues());
}
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire DBCluster les paramètres](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterParameters) dans le *AWS SDK for Java 2.x manuel de référence des API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
}
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBCluster des paramètres](https://sdk.amazonaws.com/kotlin/api/latest/index.html) dans le *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def get_parameters(self, parameter_group_name, name_prefix="", source=None):
"""
Gets the parameters that are contained in a DB cluster parameter group.
:param parameter_group_name: The name of the parameter group to query.
:param name_prefix: When specified, the retrieved list of parameters is filtered
to contain only parameters that start with this prefix.
:param source: When specified, only parameters from this source are retrieved.
For example, a source of 'user' retrieves only parameters that
were set by a user.
:return: The list of requested parameters.
"""
try:
kwargs = {"DBClusterParameterGroupName": parameter_group_name}
if source is not None:
kwargs["Source"] = source
parameters = []
paginator = self.rds_client.get_paginator("describe_db_cluster_parameters")
for page in paginator.paginate(**kwargs):
parameters += [
p
for p in page["Parameters"]
if p["ParameterName"].startswith(name_prefix)
]
except ClientError as err:
logger.error(
"Couldn't get parameters for %s. Here's why: %s: %s",
parameter_group_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return parameters
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Describe DBCluster Parameters](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterParameters) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Get the parameter group. rds.DescribeDbClusterParameterGroups
// Get parameters in the group. This is a long list so you will have to paginate. Find the auto_increment_offset and auto_increment_increment parameters (by ParameterName). rds.DescribeDbClusterParameters
// Parse the ParameterName, Description, and AllowedValues values and display them.
pub async fn cluster_parameters(&self) -> Result, ScenarioError> {
let parameters_output = self
.rds
.describe_db_cluster_parameters(DB_CLUSTER_PARAMETER_GROUP_NAME)
.await;
if let Err(err) = parameters_output {
return Err(ScenarioError::new(
format!("Failed to retrieve parameters for {DB_CLUSTER_PARAMETER_GROUP_NAME}"),
&err,
));
}
let parameters = parameters_output
.unwrap()
.into_iter()
.flat_map(|p| p.parameters.unwrap_or_default().into_iter())
.filter(|p| FILTER_PARAMETER_NAMES.contains(p.parameter_name().unwrap_or_default()))
.map(AuroraScenarioParameter::from)
.collect::>();
Ok(parameters)
}
pub async fn describe_db_cluster_parameters(
&self,
name: &str,
) -> Result, SdkError>
{
self.inner
.describe_db_cluster_parameters()
.db_cluster_parameter_group_name(name)
.into_paginator()
.send()
.try_collect()
.await
}
#[tokio::test]
async fn test_scenario_cluster_parameters() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_cluster_parameters()
.with(eq("RustSDKCodeExamplesDBParameterGroup"))
.return_once(|_| {
Ok(vec![DescribeDbClusterParametersOutput::builder()
.parameters(Parameter::builder().parameter_name("a").build())
.parameters(Parameter::builder().parameter_name("b").build())
.parameters(
Parameter::builder()
.parameter_name("auto_increment_offset")
.build(),
)
.parameters(Parameter::builder().parameter_name("c").build())
.parameters(
Parameter::builder()
.parameter_name("auto_increment_increment")
.build(),
)
.parameters(Parameter::builder().parameter_name("d").build())
.build()])
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let params = scenario.cluster_parameters().await.expect("cluster params");
let names: Vec = params.into_iter().map(|p| p.name).collect();
assert_eq!(
names,
vec!["auto_increment_offset", "auto_increment_increment"]
);
}
#[tokio::test]
async fn test_scenario_cluster_parameters_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_cluster_parameters()
.with(eq("RustSDKCodeExamplesDBParameterGroup"))
.return_once(|_| {
Err(SdkError::service_error(
DescribeDBClusterParametersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe_db_cluster_parameters_error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.db_cluster_identifier = Some("RustSDKCodeExamplesDBCluster".into());
let params = scenario.cluster_parameters().await;
assert_matches!(params, Err(ScenarioError { message, context: _ }) if message == "Failed to retrieve parameters for RustSDKCodeExamplesDBParameterGroup");
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBCluster des paramètres](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_cluster_parameters) dans le *AWS SDK pour la référence de l'API Rust*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/rds#code-examples).
```
TRY.
DATA lv_marker TYPE /aws1/rdsstring VALUE ''.
DATA lt_all_parameters TYPE /aws1/cl_rdsparameter=>tt_parameterslist.
DO.
DATA(lo_output) = lo_rds->describedbclusterparameters(
iv_dbclusterparamgroupname = iv_param_group_name
iv_source = iv_source
iv_marker = lv_marker
).
LOOP AT lo_output->get_parameters( ) INTO DATA(lo_param).
IF iv_name_prefix IS INITIAL OR
lo_param->get_parametername( ) CP |{ iv_name_prefix }*|.
APPEND lo_param TO lt_all_parameters.
ENDIF.
ENDLOOP.
lv_marker = lo_output->get_marker( ).
IF lv_marker IS INITIAL.
EXIT.
ENDIF.
ENDDO.
ot_parameters = lt_all_parameters.
CATCH /aws1/cx_rdsdbprmgrnotfndfault.
" Re-raise exception - parameter group not found
RAISE EXCEPTION TYPE /aws1/cx_rdsdbprmgrnotfndfault.
ENDTRY.
```
+ Pour plus de détails sur l'API, consultez la section [Description DBCluster des paramètres](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) dans le *AWS SDK pour la référence de l'API SAP ABAP*.
------
# Utilisation `DescribeDBClusterSnapshots` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DescribeDBClusterSnapshots`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Return a list of DB snapshots for a particular DB cluster.
///
/// DB cluster identifier.
/// List of DB snapshots.
public async Task> DescribeDBClusterSnapshotsByIdentifierAsync(string dbClusterIdentifier)
{
var results = new List();
DescribeDBClusterSnapshotsResponse response;
DescribeDBClusterSnapshotsRequest request = new DescribeDBClusterSnapshotsRequest
{
DBClusterIdentifier = dbClusterIdentifier
};
// Get the full list if there are multiple pages.
do
{
response = await _amazonRDS.DescribeDBClusterSnapshotsAsync(request);
results.AddRange(response.DBClusterSnapshots);
request.Marker = response.Marker;
}
while (response.Marker is not null);
return results;
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterSnapshots) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
Aws::RDS::Model::DescribeDBClusterSnapshotsRequest request;
request.SetDBClusterSnapshotIdentifier(snapshotID);
Aws::RDS::Model::DescribeDBClusterSnapshotsOutcome outcome =
client.DescribeDBClusterSnapshots(request);
if (outcome.IsSuccess()) {
snapshot = outcome.GetResult().GetDBClusterSnapshots()[0];
}
else {
std::cerr << "Error with Aurora::DescribeDBClusterSnapshots. "
<< outcome.GetError().GetMessage()
<< std::endl;
cleanUpResources(CLUSTER_PARAMETER_GROUP_NAME,
DB_CLUSTER_IDENTIFIER, DB_INSTANCE_IDENTIFIER, client);
return false;
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterSnapshots) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetClusterSnapshot gets a DB cluster snapshot.
func (clusters *DbClusters) GetClusterSnapshot(ctx context.Context, snapshotName string) (*types.DBClusterSnapshot, error) {
output, err := clusters.AuroraClient.DescribeDBClusterSnapshots(ctx,
&rds.DescribeDBClusterSnapshotsInput{
DBClusterSnapshotIdentifier: aws.String(snapshotName),
})
if err != nil {
log.Printf("Couldn't get snapshot %v: %v\n", snapshotName, err)
return nil, err
} else {
return &output.DBClusterSnapshots[0], nil
}
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire les DBCluster instantanés](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusterSnapshots) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void waitForSnapshotReady(RdsClient rdsClient, String dbSnapshotIdentifier,
String dbInstanceClusterIdentifier) {
try {
boolean snapshotReady = false;
String snapshotReadyStr;
System.out.println("Waiting for the snapshot to become available.");
DescribeDbClusterSnapshotsRequest snapshotsRequest = DescribeDbClusterSnapshotsRequest.builder()
.dbClusterSnapshotIdentifier(dbSnapshotIdentifier)
.dbClusterIdentifier(dbInstanceClusterIdentifier)
.build();
while (!snapshotReady) {
DescribeDbClusterSnapshotsResponse response = rdsClient.describeDBClusterSnapshots(snapshotsRequest);
List snapshotList = response.dbClusterSnapshots();
for (DBClusterSnapshot snapshot : snapshotList) {
snapshotReadyStr = snapshot.status();
if (snapshotReadyStr.contains("available")) {
snapshotReady = true;
} else {
System.out.println(".");
Thread.sleep(sleepTime * 5000);
}
}
}
System.out.println("The Snapshot is available!");
} catch (RdsException | InterruptedException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, consultez la section [Décrire les DBCluster instantanés](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterSnapshots) dans le manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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!")
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBCluster des instantanés](https://sdk.amazonaws.com/kotlin/api/latest/index.html) dans le *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def get_cluster_snapshot(self, snapshot_id):
"""
Gets a DB cluster snapshot.
:param snapshot_id: The ID of the snapshot to retrieve.
:return: The retrieved snapshot.
"""
try:
response = self.rds_client.describe_db_cluster_snapshots(
DBClusterSnapshotIdentifier=snapshot_id
)
snapshot = response["DBClusterSnapshots"][0]
except ClientError as err:
logger.error(
"Couldn't get DB cluster snapshot %s. Here's why: %s: %s",
snapshot_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return snapshot
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Describe DBCluster Snapshots](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterSnapshots) in *AWS SDK for Python (Boto3*).
------
# Utilisation `DescribeDBClusters` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DescribeDBClusters`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Returns a list of DB clusters.
///
/// Optional name of a specific DB cluster.
/// List of DB clusters.
public async Task> DescribeDBClustersPagedAsync(string? dbClusterIdentifier = null)
{
var results = new List();
DescribeDBClustersResponse response;
DescribeDBClustersRequest request = new DescribeDBClustersRequest
{
DBClusterIdentifier = dbClusterIdentifier
};
// Get the full list if there are multiple pages.
do
{
response = await _amazonRDS.DescribeDBClustersAsync(request);
if (response.DBClusters != null)
{
results.AddRange(response.DBClusters);
}
request.Marker = response.Marker;
}
while (response.Marker is not null);
return results;
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
//! Routine which gets a DB cluster description.
/*!
\sa describeDBCluster()
\param dbClusterIdentifier: A DB cluster identifier.
\param clusterResult: The 'DBCluster' object containing the description.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::describeDBCluster(const Aws::String &dbClusterIdentifier,
Aws::RDS::Model::DBCluster &clusterResult,
const Aws::RDS::RDSClient &client) {
Aws::RDS::Model::DescribeDBClustersRequest request;
request.SetDBClusterIdentifier(dbClusterIdentifier);
Aws::RDS::Model::DescribeDBClustersOutcome outcome =
client.DescribeDBClusters(request);
bool result = true;
if (outcome.IsSuccess()) {
clusterResult = outcome.GetResult().GetDBClusters()[0];
}
else if (outcome.GetError().GetErrorType() !=
Aws::RDS::RDSErrors::D_B_CLUSTER_NOT_FOUND_FAULT) {
result = false;
std::cerr << "Error with Aurora::GDescribeDBClusters. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
// This example does not log an error if the DB cluster does not exist.
// Instead, clusterResult is set to empty.
else {
clusterResult = Aws::RDS::Model::DBCluster();
}
return result;
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetDbCluster gets data about an Aurora DB cluster.
func (clusters *DbClusters) GetDbCluster(ctx context.Context, clusterName string) (*types.DBCluster, error) {
output, err := clusters.AuroraClient.DescribeDBClusters(ctx,
&rds.DescribeDBClustersInput{
DBClusterIdentifier: aws.String(clusterName),
})
if err != nil {
var notFoundError *types.DBClusterNotFoundFault
if errors.As(err, ¬FoundError) {
log.Printf("DB cluster %v does not exist.\n", clusterName)
err = nil
} else {
log.Printf("Couldn't get DB cluster %v: %v\n", clusterName, err)
}
return nil, err
} else {
return &output.DBClusters[0], err
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBClusters) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void describeDbClusterParameters(RdsClient rdsClient, String dbCLusterGroupName, int flag) {
try {
DescribeDbClusterParametersRequest dbParameterGroupsRequest;
if (flag == 0) {
dbParameterGroupsRequest = DescribeDbClusterParametersRequest.builder()
.dbClusterParameterGroupName(dbCLusterGroupName)
.build();
} else {
dbParameterGroupsRequest = DescribeDbClusterParametersRequest.builder()
.dbClusterParameterGroupName(dbCLusterGroupName)
.source("user")
.build();
}
DescribeDbClusterParametersResponse response = rdsClient
.describeDBClusterParameters(dbParameterGroupsRequest);
List dbParameters = response.parameters();
String paraName;
for (Parameter para : dbParameters) {
// Only print out information about either auto_increment_offset or
// auto_increment_increment.
paraName = para.parameterName();
if ((paraName.compareTo("auto_increment_offset") == 0)
|| (paraName.compareTo("auto_increment_increment ") == 0)) {
System.out.println("*** The parameter name is " + paraName);
System.out.println("*** The parameter value is " + para.parameterValue());
System.out.println("*** The parameter data type is " + para.dataType());
System.out.println("*** The parameter description is " + para.description());
System.out.println("*** The parameter allowed values is " + para.allowedValues());
}
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusters) dans le manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
}
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBClusters](https://sdk.amazonaws.com/kotlin/api/latest/index.html) dans le *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def get_db_cluster(self, cluster_name):
"""
Gets data about an Aurora DB cluster.
:param cluster_name: The name of the DB cluster to retrieve.
:return: The retrieved DB cluster.
"""
try:
response = self.rds_client.describe_db_clusters(
DBClusterIdentifier=cluster_name
)
cluster = response["DBClusters"][0]
except ClientError as err:
if err.response["Error"]["Code"] == "DBClusterNotFoundFault":
logger.info("Cluster %s does not exist.", cluster_name)
else:
logger.error(
"Couldn't verify the existence of DB cluster %s. Here's why: %s: %s",
cluster_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return cluster
```
+ Pour plus de détails sur l'API, voir [AWS Describe DBClusters](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusters) *in SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Get a list of allowed engine versions. rds.DescribeDbEngineVersions(Engine='aurora-mysql', DBParameterGroupFamily=)
// Create an Aurora DB cluster database cluster that contains a MySql database and uses the parameter group you created.
// Wait for DB cluster to be ready. Call rds.DescribeDBClusters and check for Status == 'available'.
// Get a list of instance classes available for the selected engine and engine version. rds.DescribeOrderableDbInstanceOptions(Engine='mysql', EngineVersion=).
// Create a database instance in the cluster.
// Wait for DB instance to be ready. Call rds.DescribeDbInstances and check for DBInstanceStatus == 'available'.
pub async fn start_cluster_and_instance(&mut self) -> Result<(), ScenarioError> {
if self.password.is_none() {
return Err(ScenarioError::with(
"Must set Secret Password before starting a cluster",
));
}
let create_db_cluster = self
.rds
.create_db_cluster(
DB_CLUSTER_IDENTIFIER,
DB_CLUSTER_PARAMETER_GROUP_NAME,
DB_ENGINE,
self.engine_version.as_deref().expect("engine version"),
self.username.as_deref().expect("username"),
self.password
.replace(SecretString::new("".to_string()))
.expect("password"),
)
.await;
if let Err(err) = create_db_cluster {
return Err(ScenarioError::new(
"Failed to create DB Cluster with cluster group",
&err,
));
}
self.db_cluster_identifier = create_db_cluster
.unwrap()
.db_cluster
.and_then(|c| c.db_cluster_identifier);
if self.db_cluster_identifier.is_none() {
return Err(ScenarioError::with("Created DB Cluster missing Identifier"));
}
info!(
"Started a db cluster: {}",
self.db_cluster_identifier
.as_deref()
.unwrap_or("Missing ARN")
);
let create_db_instance = self
.rds
.create_db_instance(
self.db_cluster_identifier.as_deref().expect("cluster name"),
DB_INSTANCE_IDENTIFIER,
self.instance_class.as_deref().expect("instance class"),
DB_ENGINE,
)
.await;
if let Err(err) = create_db_instance {
return Err(ScenarioError::new(
"Failed to create Instance in DB Cluster",
&err,
));
}
self.db_instance_identifier = create_db_instance
.unwrap()
.db_instance
.and_then(|i| i.db_instance_identifier);
// Cluster creation can take up to 20 minutes to become available
let cluster_max_wait = Duration::from_secs(20 * 60);
let waiter = Waiter::builder().max(cluster_max_wait).build();
while waiter.sleep().await.is_ok() {
let cluster = self
.rds
.describe_db_clusters(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = cluster {
warn!(?err, "Failed to describe cluster while waiting for ready");
continue;
}
let instance = self
.rds
.describe_db_instance(
self.db_instance_identifier
.as_deref()
.expect("instance identifier"),
)
.await;
if let Err(err) = instance {
return Err(ScenarioError::new(
"Failed to find instance for cluster",
&err,
));
}
let instances_available = instance
.unwrap()
.db_instances()
.iter()
.all(|instance| instance.db_instance_status() == Some("Available"));
let endpoints = self
.rds
.describe_db_cluster_endpoints(
self.db_cluster_identifier
.as_deref()
.expect("cluster identifier"),
)
.await;
if let Err(err) = endpoints {
return Err(ScenarioError::new(
"Failed to find endpoint for cluster",
&err,
));
}
let endpoints_available = endpoints
.unwrap()
.db_cluster_endpoints()
.iter()
.all(|endpoint| endpoint.status() == Some("available"));
if instances_available && endpoints_available {
return Ok(());
}
}
Err(ScenarioError::with("timed out waiting for cluster"))
}
pub async fn describe_db_clusters(
&self,
id: &str,
) -> Result> {
self.inner
.describe_db_clusters()
.db_cluster_identifier(id)
.send()
.await
}
#[tokio::test]
async fn test_start_cluster_and_instance() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_describe_db_instance()
.with(eq("RustSDKCodeExamplesDBInstance"))
.return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.with(eq("RustSDKCodeExamplesDBCluster"))
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
assert!(scenario
.password
.replace(SecretString::new("BAD SECRET".into()))
.unwrap()
.expose_secret()
.is_empty());
assert_eq!(
scenario.db_cluster_identifier,
Some("RustSDKCodeExamplesDBCluster".into())
);
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Err(SdkError::service_error(
CreateDBClusterError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _}) if message == "Failed to create DB Cluster with cluster group")
}
#[tokio::test]
async fn test_start_cluster_and_instance_cluster_create_missing_id() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.return_once(|_, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context:_ }) if message == "Created DB Cluster missing Identifier");
}
#[tokio::test]
async fn test_start_cluster_and_instance_instance_create_error() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.return_once(|_, _, _, _| {
Err(SdkError::service_error(
CreateDBInstanceError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"create db instance error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
let create = scenario.start_cluster_and_instance().await;
assert_matches!(create, Err(ScenarioError { message, context: _ }) if message == "Failed to create Instance in DB Cluster")
}
#[tokio::test]
async fn test_start_cluster_and_instance_wait_hiccup() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_create_db_cluster()
.withf(|id, params, engine, version, username, password| {
assert_eq!(id, "RustSDKCodeExamplesDBCluster");
assert_eq!(params, "RustSDKCodeExamplesDBParameterGroup");
assert_eq!(engine, "aurora-mysql");
assert_eq!(version, "aurora-mysql8.0");
assert_eq!(username, "test username");
assert_eq!(password.expose_secret(), "test password");
true
})
.return_once(|id, _, _, _, _, _| {
Ok(CreateDbClusterOutput::builder()
.db_cluster(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds
.expect_create_db_instance()
.withf(|cluster, name, class, engine| {
assert_eq!(cluster, "RustSDKCodeExamplesDBCluster");
assert_eq!(name, "RustSDKCodeExamplesDBInstance");
assert_eq!(class, "m5.large");
assert_eq!(engine, "aurora-mysql");
true
})
.return_once(|cluster, name, class, _| {
Ok(CreateDbInstanceOutput::builder()
.db_instance(
DbInstance::builder()
.db_cluster_identifier(cluster)
.db_instance_identifier(name)
.db_instance_class(class)
.build(),
)
.build())
});
mock_rds
.expect_describe_db_clusters()
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|_| {
Err(SdkError::service_error(
DescribeDBClustersError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe cluster error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
})
.with(eq("RustSDKCodeExamplesDBCluster"))
.times(1)
.returning(|id| {
Ok(DescribeDbClustersOutput::builder()
.db_clusters(DbCluster::builder().db_cluster_identifier(id).build())
.build())
});
mock_rds.expect_describe_db_instance().return_once(|name| {
Ok(DescribeDbInstancesOutput::builder()
.db_instances(
DbInstance::builder()
.db_instance_identifier(name)
.db_instance_status("Available")
.build(),
)
.build())
});
mock_rds
.expect_describe_db_cluster_endpoints()
.return_once(|_| {
Ok(DescribeDbClusterEndpointsOutput::builder()
.db_cluster_endpoints(DbClusterEndpoint::builder().status("available").build())
.build())
});
let mut scenario = AuroraScenario::new(mock_rds);
scenario.engine_version = Some("aurora-mysql8.0".into());
scenario.instance_class = Some("m5.large".into());
scenario.username = Some("test username".into());
scenario.password = Some(SecretString::new("test password".into()));
tokio::time::pause();
let assertions = tokio::spawn(async move {
let create = scenario.start_cluster_and_instance().await;
assert!(create.is_ok());
});
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::advance(Duration::from_secs(1)).await;
tokio::time::resume();
let _ = assertions.await;
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBClusters](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_clusters) dans le *AWS SDK pour la référence de l'API Rust*.
------
# Utilisation `DescribeDBEngineVersions` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DescribeDBEngineVersions`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Get a list of DB engine versions for a particular DB engine.
///
/// The name of the engine.
/// Optional parameter group family name.
/// A list of DBEngineVersions.
public async Task> DescribeDBEngineVersionsForEngineAsync(string engine,
string? parameterGroupFamily = null)
{
var response = await _amazonRDS.DescribeDBEngineVersionsAsync(
new DescribeDBEngineVersionsRequest()
{
Engine = engine,
DBParameterGroupFamily = parameterGroupFamily
});
return response.DBEngineVersions;
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBEngine des versions](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBEngineVersions) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
//! Routine which gets available DB engine versions for an engine name and
//! an optional parameter group family.
/*!
\sa getDBEngineVersions()
\param engineName: A DB engine name.
\param parameterGroupFamily: A parameter group family name, ignored if empty.
\param engineVersionsResult: Vector of 'DBEngineVersion' objects returned by the routine.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::getDBEngineVersions(const Aws::String &engineName,
const Aws::String ¶meterGroupFamily,
Aws::Vector &engineVersionsResult,
const Aws::RDS::RDSClient &client) {
Aws::RDS::Model::DescribeDBEngineVersionsRequest request;
request.SetEngine(engineName);
if (!parameterGroupFamily.empty()) {
request.SetDBParameterGroupFamily(parameterGroupFamily);
}
engineVersionsResult.clear();
Aws::String marker; // The marker is used for pagination.
do {
if (!marker.empty()) {
request.SetMarker(marker);
}
Aws::RDS::Model::DescribeDBEngineVersionsOutcome outcome =
client.DescribeDBEngineVersions(request);
if (outcome.IsSuccess()) {
const Aws::Vector &engineVersions =
outcome.GetResult().GetDBEngineVersions();
engineVersionsResult.insert(engineVersionsResult.end(),
engineVersions.begin(), engineVersions.end());
marker = outcome.GetResult().GetMarker();
}
else {
std::cerr << "Error with Aurora::DescribeDBEngineVersionsRequest. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
} while (!marker.empty());
return true;
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBEngine des versions](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBEngineVersions) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetEngineVersions gets database engine versions that are available for the specified engine
// and parameter group family.
func (clusters *DbClusters) GetEngineVersions(ctx context.Context, engine string, parameterGroupFamily string) (
[]types.DBEngineVersion, error) {
output, err := clusters.AuroraClient.DescribeDBEngineVersions(ctx,
&rds.DescribeDBEngineVersionsInput{
Engine: aws.String(engine),
DBParameterGroupFamily: aws.String(parameterGroupFamily),
})
if err != nil {
log.Printf("Couldn't get engine versions for %v: %v\n", engine, err)
return nil, err
} else {
return output.DBEngineVersions, nil
}
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBEngine des versions](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBEngineVersions) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
public static void describeDBEngines(RdsClient rdsClient) {
try {
DescribeDbEngineVersionsRequest engineVersionsRequest = DescribeDbEngineVersionsRequest.builder()
.engine("aurora-mysql")
.defaultOnly(true)
.maxRecords(20)
.build();
DescribeDbEngineVersionsResponse response = rdsClient.describeDBEngineVersions(engineVersionsRequest);
List engines = response.dbEngineVersions();
// Get all DBEngineVersion objects.
for (DBEngineVersion engineOb : engines) {
System.out.println("The name of the DB parameter group family for the database engine is "
+ engineOb.dbParameterGroupFamily());
System.out.println("The name of the database engine " + engineOb.engine());
System.out.println("The version number of the database engine " + engineOb.engineVersion());
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBEngine des versions](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBEngineVersions) dans le manuel de *référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](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}")
}
}
}
```
+ Pour plus de détails sur l'API, voir [Description des DBEngine versions](https://sdk.amazonaws.com/kotlin/api/latest/index.html) dans le *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/aurora#code-examples).
```
class AuroraWrapper:
"""Encapsulates Aurora DB cluster actions."""
def __init__(self, rds_client):
"""
:param rds_client: A Boto3 Amazon Relational Database Service (Amazon RDS) client.
"""
self.rds_client = rds_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
rds_client = boto3.client("rds")
return cls(rds_client)
def get_engine_versions(self, engine, parameter_group_family=None):
"""
Gets database engine versions that are available for the specified engine
and parameter group family.
:param engine: The database engine to look up.
:param parameter_group_family: When specified, restricts the returned list of
engine versions to those that are compatible with
this parameter group family.
:return: The list of database engine versions.
"""
try:
kwargs = {"Engine": engine}
if parameter_group_family is not None:
kwargs["DBParameterGroupFamily"] = parameter_group_family
response = self.rds_client.describe_db_engine_versions(**kwargs)
versions = response["DBEngineVersions"]
except ClientError as err:
logger.error(
"Couldn't get engine versions for %s. Here's why: %s: %s",
engine,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return versions
```
+ Pour plus de détails sur l'API, consultez le [manuel de référence de l'API Describe DBEngine Versions](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBEngineVersions) in *AWS SDK for Python (Boto3*).
------
#### [ Rust ]
**SDK pour Rust**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/aurora#code-examples).
```
// Get available engine families for Aurora MySql. rds.DescribeDbEngineVersions(Engine='aurora-mysql') and build a set of the 'DBParameterGroupFamily' field values. I get {aurora-mysql8.0, aurora-mysql5.7}.
pub async fn get_engines(&self) -> Result>, ScenarioError> {
let describe_db_engine_versions = self.rds.describe_db_engine_versions(DB_ENGINE).await;
trace!(versions=?describe_db_engine_versions, "full list of versions");
if let Err(err) = describe_db_engine_versions {
return Err(ScenarioError::new(
"Failed to retrieve DB Engine Versions",
&err,
));
};
let version_count = describe_db_engine_versions
.as_ref()
.map(|o| o.db_engine_versions().len())
.unwrap_or_default();
info!(version_count, "got list of versions");
// Create a map of engine families to their available versions.
let mut versions = HashMap::>::new();
describe_db_engine_versions
.unwrap()
.db_engine_versions()
.iter()
.filter_map(
|v| match (&v.db_parameter_group_family, &v.engine_version) {
(Some(family), Some(version)) => Some((family.clone(), version.clone())),
_ => None,
},
)
.for_each(|(family, version)| versions.entry(family).or_default().push(version));
Ok(versions)
}
pub async fn describe_db_engine_versions(
&self,
engine: &str,
) -> Result> {
self.inner
.describe_db_engine_versions()
.engine(engine)
.send()
.await
}
#[tokio::test]
async fn test_scenario_get_engines() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_engine_versions()
.with(eq("aurora-mysql"))
.return_once(|_| {
Ok(DescribeDbEngineVersionsOutput::builder()
.db_engine_versions(
DbEngineVersion::builder()
.db_parameter_group_family("f1")
.engine_version("f1a")
.build(),
)
.db_engine_versions(
DbEngineVersion::builder()
.db_parameter_group_family("f1")
.engine_version("f1b")
.build(),
)
.db_engine_versions(
DbEngineVersion::builder()
.db_parameter_group_family("f2")
.engine_version("f2a")
.build(),
)
.db_engine_versions(DbEngineVersion::builder().build())
.build())
});
let scenario = AuroraScenario::new(mock_rds);
let versions_map = scenario.get_engines().await;
assert_eq!(
versions_map,
Ok(HashMap::from([
("f1".into(), vec!["f1a".into(), "f1b".into()]),
("f2".into(), vec!["f2a".into()])
]))
);
}
#[tokio::test]
async fn test_scenario_get_engines_failed() {
let mut mock_rds = MockRdsImpl::default();
mock_rds
.expect_describe_db_engine_versions()
.with(eq("aurora-mysql"))
.return_once(|_| {
Err(SdkError::service_error(
DescribeDBEngineVersionsError::unhandled(Box::new(Error::new(
ErrorKind::Other,
"describe_db_engine_versions error",
))),
Response::new(StatusCode::try_from(400).unwrap(), SdkBody::empty()),
))
});
let scenario = AuroraScenario::new(mock_rds);
let versions_map = scenario.get_engines().await;
assert_matches!(
versions_map,
Err(ScenarioError { message, context: _ }) if message == "Failed to retrieve DB Engine Versions"
);
}
```
+ Pour plus de détails sur l'API, consultez la section [Description DBEngine des versions](https://docs.rs/aws-sdk-rds/latest/aws_sdk_rds/client/struct.Client.html#method.describe_db_engine_versions) dans le *AWS SDK pour la référence de l'API Rust*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/rds#code-examples).
```
" iv_engine = 'mysql'
" iv_dbparametergroupfamily = 'mysql8.0' (optional - filters by parameter group family)
TRY.
oo_result = lo_rds->describedbengineversions(
iv_engine = iv_engine
iv_dbparametergroupfamily = iv_dbparametergroupfamily ).
DATA(lv_version_count) = lines( oo_result->get_dbengineversions( ) ).
MESSAGE |Retrieved { lv_version_count } engine versions.| TYPE 'I'.
ENDTRY.
```
+ Pour plus de détails sur l'API, consultez la section [Description DBEngine des versions](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) dans le *AWS SDK pour la référence de l'API SAP ABAP*.
------
# Utilisation `DescribeDBInstances` avec un AWS SDK
Les exemples de code suivants illustrent comment utiliser `DescribeDBInstances`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :
+ [Principes de base](aurora_example_aurora_Scenario_GetStartedClusters_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Aurora#code-examples).
```
///
/// Returns a list of DB instances.
///
/// Optional name of a specific DB instance.
/// List of DB instances.
public async Task> DescribeDBInstancesPagedAsync(string? dbInstanceIdentifier = null)
{
var results = new List();
var instancesPaginator = _amazonRDS.Paginators.DescribeDBInstances(
new DescribeDBInstancesRequest
{
DBInstanceIdentifier = dbInstanceIdentifier
});
// Get the entire list using the paginator.
await foreach (var instances in instancesPaginator.DBInstances)
{
results.Add(instances);
}
return results;
}
```
+ Pour plus de détails sur l'API, voir [Description DBInstances](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBInstances) dans le manuel de *référence des AWS SDK pour .NET API*.
------
#### [ C\$1\$1 ]
**SDK pour C\$1\$1**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/aurora#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient client(clientConfig);
//! Routine which gets a DB instance description.
/*!
\sa describeDBCluster()
\param dbInstanceIdentifier: A DB instance identifier.
\param instanceResult: The 'DBInstance' object containing the description.
\param client: 'RDSClient' instance.
\return bool: Successful completion.
*/
bool AwsDoc::Aurora::describeDBInstance(const Aws::String &dbInstanceIdentifier,
Aws::RDS::Model::DBInstance &instanceResult,
const Aws::RDS::RDSClient &client) {
Aws::RDS::Model::DescribeDBInstancesRequest request;
request.SetDBInstanceIdentifier(dbInstanceIdentifier);
Aws::RDS::Model::DescribeDBInstancesOutcome outcome =
client.DescribeDBInstances(request);
bool result = true;
if (outcome.IsSuccess()) {
instanceResult = outcome.GetResult().GetDBInstances()[0];
}
else if (outcome.GetError().GetErrorType() !=
Aws::RDS::RDSErrors::D_B_INSTANCE_NOT_FOUND_FAULT) {
result = false;
std::cerr << "Error with Aurora::DescribeDBInstances. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
// This example does not log an error if the DB instance does not exist.
// Instead, instanceResult is set to empty.
else {
instanceResult = Aws::RDS::Model::DBInstance();
}
return result;
}
```
+ Pour plus de détails sur l'API, voir [Description DBInstances](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBInstances) dans le manuel de *référence des AWS SDK pour C\$1\$1 API*.
------
#### [ Go ]
**Kit SDK pour Go V2**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/aurora#code-examples).
```
import (
"context"
"errors"
"log"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/rds"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
)
type DbClusters struct {
AuroraClient *rds.Client
}
// GetInstance gets data about a DB instance.
func (clusters *DbClusters) GetInstance(ctx context.Context, instanceName string) (
*types.DBInstance, error) {
output, err := clusters.AuroraClient.DescribeDBInstances(ctx,
&rds.DescribeDBInstancesInput{
DBInstanceIdentifier: aws.String(instanceName),
})
if err != nil {
var notFoundError *types.DBInstanceNotFoundFault
if errors.As(err, ¬FoundError) {
log.Printf("DB instance %v does not exist.\n", instanceName)
err = nil
} else {
log.Printf("Couldn't get instance %v: %v\n", instanceName, err)
}
return nil, err
} else {
return &output.DBInstances[0], nil
}
}
```
+ Pour plus de détails sur l'API, voir [Description DBInstances](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/rds#Client.DescribeDBInstances) dans le manuel de *référence des AWS SDK pour Go API*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/rds#code-examples).
```
// Waits until the database instance is available.
public static void waitForInstanceReady(RdsClient rdsClient, String dbClusterIdentifier) {
boolean instanceReady = false;
String instanceReadyStr;
System.out.println("Waiting for instance to become available.");
try {
DescribeDbClustersRequest instanceRequest = DescribeDbClustersRequest.builder()
.dbClusterIdentifier(dbClusterIdentifier)
.build();
while (!instanceReady) {
DescribeDbClustersResponse response = rdsClient.describeDBClusters(instanceRequest);
List