Exemples d’utilisation de l’AWS CLI avec AWS AppConfig
Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec AWS AppConfig.
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.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.
Rubriques
Actions
L’exemple de code suivant montre comment utiliser create-application.
- AWS CLI
-
Pour créer une application
L’exemple
create-applicationsuivant crée une application dans AWS AppConfig.aws appconfig create-application \ --name"example-application"\ --description"An application used for creating an example."Sortie :
{ "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" }Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez CreateApplication
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser create-configuration-profile.
- AWS CLI
-
Pour créer un profil de configuration
L’exemple
create-configuration-profilesuivant crée un profil de configuration à l’aide d’une configuration stockée dans Parameter Store, une fonctionnalité de Systems Manager.aws appconfig create-configuration-profile \ --application-id"339ohji"\ --name"Example-Configuration-Profile"\ --location-uri"ssm-parameter://Example-Parameter"\ --retrieval-role-arn"arn:aws:iam::111122223333:role/Example-App-Config-Role"Sortie :
{ "ApplicationId": "339ohji", "Description": null, "Id": "ur8hx2f", "LocationUri": "ssm-parameter://Example-Parameter", "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role", "Type": null, "Validators": null }Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez CreateConfigurationProfile
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser create-environment.
- AWS CLI
-
Pour créer un environnement
L’exemple
create-environmentsuivant crée un environnement AWS AppConfig nommé Example-Environment à l’aide de l’application que vous avez créée avec create-application.aws appconfig create-environment \ --application-id"339ohji"\ --name"Example-Environment"Sortie :
{ "ApplicationId": "339ohji", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" }Pour plus d’informations, consultez Étape 2 : Création d’un environnement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez CreateEnvironment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser create-extension-association.
- AWS CLI
-
Pour créer une association d’extension
L’exemple
create-extension-associationsuivant crée une association d’extension dans AWS AppConfig.aws appconfig create-extension-association \ --regionus-west-2\ --extension-identifierS3-backup-extension\ --resource-identifier"arn:aws:appconfig:us-west-2:123456789012:application/Finance"\ --parametersS3bucket=FinanceConfigurationBackupSortie :
{ "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance", "Parameters": { "S3bucket": "FinanceConfigurationBackup" }, "ExtensionVersionNumber": 1 }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez CreateExtensionAssociation
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser create-extension.
- AWS CLI
-
Pour créer une extension
L’exemple
create-extensionsuivant crée une extension dans AWS AppConfig.aws appconfig create-extension \ --regionus-west-2\ --nameS3-backup-extension\ --actionsPRE_CREATE_HOSTED_CONFIGURATION_VERSION=[{Name=S3backup,Uri=arn:aws:lambda:us-west-2:123456789012:function:s3backupfunction,RoleArn=arn:aws:iam::123456789012:role/appconfigextensionrole}]\ --parametersS3bucket={Required=true}Sortie :
{ "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1", "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [ { "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:123456789012:function:s3backupfunction", "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole" } ] }, "Parameters": { "S3bucket": { "Required": true } } }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez CreateExtension
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser create-hosted-configuration-version.
- AWS CLI
-
Pour créer une version de configuration hébergée
L’exemple
create-hosted-configuration-versionsuivant crée une configuration dans le magasin de configuration hébergé par AWS AppConfig. Le contenu de la configuration doit d’abord être converti en base64.aws appconfig create-hosted-configuration-version \ --application-id"339ohji"\ --configuration-profile-id"ur8hx2f"\ --contenteyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9\ --content-type"application/json"\configuration_version_output_fileContenu de
configuration_version_output_file:{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }Sortie :
{ "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" }Pour plus d’informations, consultez À propos du magasin de configuration hébergé par AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez CreateHostedConfigurationVersion
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-application.
- AWS CLI
-
Pour supprimer une application
L’exemple
delete-applicationsuivant supprime l’application spécifiée.aws appconfig delete-application \ --application-id339ohjiCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteApplication
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-configuration-profile.
- AWS CLI
-
Pour supprimer un profil de configuration
L’exemple
delete-configuration-profilesuivant supprime le profil de configuration spécifié.aws appconfig delete-configuration-profile \ --application-id339ohji\ --configuration-profile-idur8hx2fCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteConfigurationProfile
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-deployment-strategy.
- AWS CLI
-
Pour supprimer une stratégie de déploiement
L’exemple
delete-deployment-strategysuivant supprime la stratégie de déploiement spécifiée.aws appconfig delete-deployment-strategy \ --deployment-strategy-id1225qzkCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 4 : Création d’une stratégie de déploiement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteDeploymentStrategy
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-environment.
- AWS CLI
-
Pour supprimer un environnement
L’exemple
delete-environmentsuivant supprime l’environnement d’application spécifié.aws appconfig delete-environment \ --application-id339ohji\ --environment-id54j1r29Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 2 : Création d’un environnement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteEnvironment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-extension-association.
- AWS CLI
-
Pour supprimer une association d’extension
L’exemple
delete-extension-associationsuivant supprime une association d’extension d’AWS AppConfig.aws appconfig delete-extension-association \ --regionus-west-2\ --extension-association-ida1b2c3d4Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteExtensionAssociation
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-extension.
- AWS CLI
-
Pour supprimer une extension
L’exemple
delete-extensionsuivant supprime une extension d’AWS AppConfig.aws appconfig delete-extension \ --regionus-west-2\ --extension-identifierS3-backup-extensionCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteExtension
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-hosted-configuration-version.
- AWS CLI
-
Pour supprimer une version de configuration hébergée
L’exemple
delete-hosted-configuration-versionsuivant supprime une version de configuration hébergée dans le magasin de configuration hébergé par AWS AppConfig.aws appconfig delete-hosted-configuration-version \ --application-id339ohji\ --configuration-profile-idur8hx2f\ --version-number1Sortie : cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez DeleteHostedConfigurationVersion
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-application.
- AWS CLI
-
Pour répertorier les informations d’une application
L’exemple
get-applicationsuivant répertorie les informations de l’application spécifiée.aws appconfig get-application \ --application-id339ohjiSortie :
{ "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" }Pour plus d’informations, consultez Fonctionnement d’AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetApplication
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-configuration-profile.
- AWS CLI
-
Pour récupérer les informations du profil de configuration
L’exemple
get-configuration-profilesuivant renvoie les informations du profil de configuration spécifié.aws appconfig get-configuration-profile \ --application-id339ohji\ --configuration-profile-idur8hx2fSortie :
{ "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetConfigurationProfile
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-configuration.
- AWS CLI
-
Pour récupérer les informations de configuration
L’exemple
get-configurationsuivant renvoie les informations de configuration de l’exemple d’application. Lors des appels ultérieurs à get-configuration, utilisez le paramètreclient-configuration-versionpour ne mettre à jour la configuration de votre application que si la version a changé. La mise à jour de la configuration uniquement lorsque la version a changé permet d’éviter les frais supplémentaires liés à l’appel à get-configuration.aws appconfig get-configuration \ --application"example-application"\ --environment"Example-Environment"\ --configuration"Example-Configuration-Profile"\ --client-id"test-id"\configuration-output-fileContenu de
configuration-output-file:{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }Sortie :
{ "ConfigurationVersion": "1", "ContentType": "application/json" }Pour plus d’informations, consultez Étape 6 : Réception de la configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetConfiguration
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-deployment-strategy.
- AWS CLI
-
Pour récupérer les informations d’une stratégie de déploiement
L’exemple
get-deployment-strategysuivant répertorie les informations de la stratégie de déploiement spécifiée.aws appconfig get-deployment-strategy \ --deployment-strategy-id1225qzkSortie :
{ "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" }Pour plus d’informations, consultez Étape 4 : Création d’une stratégie de déploiement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetDeploymentStrategy
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-deployment.
- AWS CLI
-
Pour récupérer les informations du déploiement
L’exemple
get-deploymentsuivant répertorie les informations du déploiement de l’application dans l’environnement et le déploiement spécifiés.aws appconfig get-deployment \ --application-id339ohji\ --environment-id54j1r29\ --deployment-number1Sortie :
{ "ApplicationId": "339ohji", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "EventLog": [ { "EventType": "DEPLOYMENT_COMPLETED", "TriggeredBy": "APPCONFIG", "Description": "Deployment completed", "OccurredAt": "2021-09-17T21:59:03.888000+00:00" }, { "EventType": "BAKE_TIME_STARTED", "TriggeredBy": "APPCONFIG", "Description": "Deployment bake time started", "OccurredAt": "2021-09-17T21:58:57.722000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 100.00% of clients", "OccurredAt": "2021-09-17T21:55:56.816000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 75.00% of clients", "OccurredAt": "2021-09-17T21:52:56.567000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 50.00% of clients", "OccurredAt": "2021-09-17T21:49:55.737000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 25.00% of clients", "OccurredAt": "2021-09-17T21:46:55.187000+00:00" }, { "EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER", "Description": "Deployment started", "OccurredAt": "2021-09-17T21:43:54.205000+00:00" } ], "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" }Pour plus d’informations, consultez Étape 5 : Déploiement d’une configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetDeployment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-environment.
- AWS CLI
-
Pour récupérer les informations de l’environnement
L’exemple
get-environmentsuivant renvoie les informations et l’état de l’environnement spécifié.aws appconfig get-environment \ --application-id339ohji\ --environment-id54j1r29Sortie :
{ "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" }Pour plus d’informations, consultez Étape 2 : Création d’un environnement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetEnvironment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-extension-association.
- AWS CLI
-
Pour obtenir les informations sur une association d’extension
L’exemple
get-extension-associationsuivant affiche les informations sur une association d’extension.aws appconfig get-extension-association \ --regionus-west-2\ --extension-association-ida1b2c3d4Sortie :
{ "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance", "Parameters": { "S3bucket": "FinanceConfigurationBackup" }, "ExtensionVersionNumber": 1 }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetExtensionAssociation
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-extension.
- AWS CLI
-
Pour obtenir les informations concernant l’extension
L’exemple
get-extensionsuivant affiche les informations sur une extension.aws appconfig get-extension \ --regionus-west-2\ --extension-identifierS3-backup-extensionSortie :
{ "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [ { "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:123456789012:function:S3backupfunction", "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole" } ] }, "Parameters": { "S3bucket": { "Required": true } } }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetExtension
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-hosted-configuration-version.
- AWS CLI
-
Pour récupérer les informations de la configuration hébergée
L’exemple
get-hosted-configuration-versionsuivant récupère les informations de la configuration hébergée par AWS AppConfig.aws appconfig get-hosted-configuration-version \ --application-id339ohji\ --configuration-profile-idur8hx2f\ --version-number1\hosted-configuration-version-outputContenu de
hosted-configuration-version-output:{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }Sortie :
{ "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" }Pour plus d’informations, consultez À propos du magasin de configuration hébergé par AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez GetHostedConfigurationVersion
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-applications.
- AWS CLI
-
Pour répertorier les applications disponibles
L’exemple
list-applicationssuivant répertorie les applications disponibles dans votre compte AWS.aws appconfig list-applicationsSortie :
{ "Items": [ { "Id": "339ohji", "Name": "test-application", "Description": "An application used for creating an example." }, { "Id": "rwalwu7", "Name": "Test-Application" } ] }Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListApplications
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-configuration-profiles.
- AWS CLI
-
Pour répertorier les profils de configuration disponibles
L’exemple
list-configuration-profilessuivant répertorie les profils de configuration disponibles pour l’application spécifiée.aws appconfig list-configuration-profiles \ --application-id339ohjiSortie :
{ "Items": [ { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter" } ] }Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListConfigurationProfiles
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-deployment-strategies.
- AWS CLI
-
Pour répertorier les stratégies de déploiement disponibles
L’exemple
list-deployment-strategiessuivant répertorie les stratégies de déploiement disponibles dans votre compte AWS.aws appconfig list-deployment-strategiesSortie :
{ "Items": [ { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" }, { "Id": "AppConfig.AllAtOnce", "Name": "AppConfig.AllAtOnce", "Description": "Quick", "DeploymentDurationInMinutes": 0, "GrowthType": "LINEAR", "GrowthFactor": 100.0, "FinalBakeTimeInMinutes": 10, "ReplicateTo": "NONE" }, { "Id": "AppConfig.Linear50PercentEvery30Seconds", "Name": "AppConfig.Linear50PercentEvery30Seconds", "Description": "Test/Demo", "DeploymentDurationInMinutes": 1, "GrowthType": "LINEAR", "GrowthFactor": 50.0, "FinalBakeTimeInMinutes": 1, "ReplicateTo": "NONE" }, { "Id": "AppConfig.Canary10Percent20Minutes", "Name": "AppConfig.Canary10Percent20Minutes", "Description": "AWS Recommended", "DeploymentDurationInMinutes": 20, "GrowthType": "EXPONENTIAL", "GrowthFactor": 10.0, "FinalBakeTimeInMinutes": 10, "ReplicateTo": "NONE" } ] }Pour plus d’informations, consultez Étape 4 : Création d’une stratégie de déploiement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListDeploymentStrategies
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-deployments.
- AWS CLI
-
Pour répertorier les déploiements disponibles
L’exemple
list-deploymentssuivant répertorie les déploiements disponibles dans votre compte AWS pour l’application et l’environnement spécifiés.aws appconfig list-deployments \ --application-id339ohji\ --environment-id54j1r29Sortie :
{ "Items": [ { "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" } ] }Pour plus d’informations, consultez Étape 5 : Déploiement d’une configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListDeployments
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-environments.
- AWS CLI
-
Pour répertorier les environnements disponibles
L’exemple
list-environmentssuivant répertorie les environnements disponibles dans votre compte AWS pour l’application spécifiée.aws appconfig list-environments \ --application-id339ohjiSortie :
{ "Items": [ { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ] }Pour plus d’informations, consultez Étape 2 : Création d’un environnement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListEnvironments
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-extension-associations.
- AWS CLI
-
Pour répertorier toutes les associations d’extension AWS AppConfig dans votre compte AWS pour une région AWS
L’exemple
list-extension-associationssuivant répertorie toutes les associations d’extension AWS AppConfig du compte AWS actuel dans une région AWS spécifique.aws appconfig list-extension-associations \ --regionus-west-2Sortie :
{ "Items": [ { "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance" } ] }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListExtensionAssociations
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-extensions.
- AWS CLI
-
Pour répertorier toutes les extensions AWS AppConfig de votre compte AWS pour une région AWS
L’exemple
list-extensionssuivant répertorie toutes les extensions AWS AppConfig du compte AWS actuel dans une région AWS spécifique. La commande renvoie les extensions personnalisées et créées dans AWS.aws appconfig list-extensions \ --regionus-west-2Sortie :
{ "Items": [ { "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1" }, { "Id": "AWS.AppConfig.FeatureFlags", "Name": "AppConfig Feature Flags Helper", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.FeatureFlags/1", "Description": "Validates AppConfig feature flag data automatically against a JSON schema that includes structure and constraints. Also transforms feature flag data prior to sending to the client. This extension is automatically associated to configuration profiles with type \"AWS.AppConfig.FeatureFlags\"." }, { "Id": "AWS.AppConfig.JiraIntegration", "Name": "AppConfig integration with Atlassian Jira", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.JiraIntegration/1", "Description": "Exports feature flag data from AWS AppConfig into Jira. The lifecycle of each feature flag in AppConfig is tracked in Jira as an individual issue. Customers can see in Jira when flags are updated, turned on or off. Works in conjunction with the AppConfig app in the Atlassian Marketplace and is automatically associated to configuration profiles configured within that app." }, { "Id": "AWS.AppConfig.DeploymentNotificationsToEventBridge", "Name": "AppConfig deployment events to Amazon EventBridge", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.DeploymentNotificationsToEventBridge/1", "Description": "Sends events to Amazon EventBridge when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile." }, { "Id": "AWS.AppConfig.DeploymentNotificationsToSqs", "Name": "AppConfig deployment events to Amazon SQS", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.DeploymentNotificationsToSqs/1", "Description": "Sends messages to the configured Amazon SQS queue when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile." }, { "Id": "AWS.AppConfig.DeploymentNotificationsToSns", "Name": "AppConfig deployment events to Amazon SNS", "VersionNumber": 1, "Description": "Sends events to the configured Amazon SNS topic when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile." } ] }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListExtensions
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-hosted-configuration-versions.
- AWS CLI
-
Pour répertorier les versions de configuration hébergées disponibles
L’exemple
list-hosted-configuration-versionssuivant répertorie les versions de configurations hébergées dans le magasin de configuration hébergé par AWS AppConfig pour l’application et le profil de configuration spécifiés.aws appconfig list-hosted-configuration-versions \ --application-id339ohji\ --configuration-profile-idur8hx2fSortie :
{ "Items": [ { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": 1, "ContentType": "application/json" } ] }Pour plus d’informations, consultez À propos du magasin de configuration hébergé par AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListHostedConfigurationVersions
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-tags-for-resource.
- AWS CLI
-
Pour répertorier les balises d’une application
L’exemple
list-tags-for-resourcesuivant répertorie les balises d’une application spécifiée.aws appconfig list-tags-for-resource \ --resource-arnarn:aws:appconfig:us-east-1:682428703967:application/339ohjiSortie :
{ "Tags": { "group1": "1" } }Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ListTagsForResource
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser start-deployment.
- AWS CLI
-
Pour démarrer le déploiement d’une configuration
L’exemple
start-deploymentsuivant lance un déploiement vers l’application en utilisant l’environnement, la stratégie de déploiement et le profil de configuration spécifiés.aws appconfig start-deployment \ --application-id339ohji\ --environment-id54j1r29\ --deployment-strategy-id1225qzk\ --configuration-profile-idur8hx2f\ --configuration-version1Sortie :
{ "ApplicationId": "339ohji", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "DEPLOYING", "EventLog": [ { "EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER", "Description": "Deployment started", "OccurredAt": "2021-09-17T21:43:54.205000+00:00" } ], "PercentageComplete": 0.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00" }Pour plus d’informations, consultez Étape 5 : Déploiement d’une configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez StartDeployment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser stop-deployment.
- AWS CLI
-
Pour arrêter le déploiement d’une configuration
L’exemple
stop-deploymentsuivant arrête le déploiement d’une configuration d’application dans l’environnement spécifié.aws appconfig stop-deployment \ --application-id339ohji\ --environment-id54j1r29\ --deployment-number2Sortie :
{ "DeploymentNumber": 0, "DeploymentDurationInMinutes": 0, "GrowthFactor": 0.0, "FinalBakeTimeInMinutes": 0, "PercentageComplete": 0.0 }Pour plus d’informations, consultez Étape 5 : Déploiement d’une configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez StopDeployment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser tag-resource.
- AWS CLI
-
Pour baliser une application
L’exemple
tag-resourcesuivant balise une ressource d’application.aws appconfig tag-resource \ --resource-arnarn:aws:appconfig:us-east-1:682428703967:application/339ohji\ --tags '{"group1" : "1"}'Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez TagResource
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser untag-resource.
- AWS CLI
-
Pour supprimer une balise d’une application
L’exemple
untag-resourcesuivant supprime la balise group1 de l’application spécifiée.aws appconfig untag-resource \ --resource-arnarn:aws:appconfig:us-east-1:111122223333:application/339ohji\ --tag-keys '["group1"]'Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UntagResource
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-application.
- AWS CLI
-
Pour mettre à jour une application
L’exemple
update-applicationsuivant met à jour le nom de l’application spécifiée.aws appconfig update-application \ --application-id339ohji\ --name"Example-Application"Sortie :
{ "Id": "339ohji", "Name": "Example-Application", "Description": "An application used for creating an example." }Pour plus d’informations, consultez Étape 1 : Création d’une application AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UpdateApplication
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-configuration-profile.
- AWS CLI
-
Pour mettre à jour un profil de configuration
L’exemple
update-configuration-profilesuivant met à jour la description du profil de configuration spécifié.aws appconfig update-configuration-profile \ --application-id339ohji\ --configuration-profile-idur8hx2f\ --description"Configuration profile used for examples."Sortie :
{ "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "Description": "Configuration profile used for examples.", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UpdateConfigurationProfile
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-deployment-strategy.
- AWS CLI
-
Pour mettre à jour une stratégie de déploiement
L’exemple
update-deployment-strategysuivant met à jour la durée de l’intégration finale pour qu’elle soit de 20 minutes dans la stratégie de déploiement spécifiée.aws appconfig update-deployment-strategy \ --deployment-strategy-id1225qzk\ --final-bake-time-in-minutes20Sortie :
{ "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 20, "ReplicateTo": "SSM_DOCUMENT" }Pour plus d’informations, consultez Étape 4 : Création d’une stratégie de déploiement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UpdateDeploymentStrategy
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-environment.
- AWS CLI
-
Pour mettre à jour un environnement
L’exemple
update-environmentsuivant met à jour la description d’un environnement.aws appconfig update-environment \ --application-id339ohji\ --environment-id54j1r29\ --description"An environment for examples."Sortie :
{ "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "Description": "An environment for examples.", "State": "RolledBack" }Pour plus d’informations, consultez Étape 2 : Création d’un environnement dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UpdateEnvironment
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-extension-association.
- AWS CLI
-
Pour mettre à jour une association d’extension AWS AppConfig
L’exemple
update-extension-associationsuivant ajoute une nouvelle valeur de paramètre à une association d’extension dans AWS AppConfig.aws appconfig update-extension-association \ --regionus-west-2\ --extension-association-ida1b2c3d4\ --parametersS3bucket=FinanceMobileAppSortie :
{ "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance", "Parameters": { "S3bucket": "FinanceMobileApp" }, "ExtensionVersionNumber": 1 }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UpdateExtensionAssociation
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-extension.
- AWS CLI
-
Pour mettre à jour une extension AWS AppConfig
L’exemple
update-extensionsuivant ajoute une clé de paramètre supplémentaire à une extension dans AWS AppConfig.aws appconfig update-extension \ --regionus-west-2\ --extension-identifierS3-backup-extension\ --parametersS3bucket={Required=true},CampaignID={Required=false}Sortie :
{ "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1", "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [ { "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:123456789012:function:S3backupfunction", "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole" } ] }, "Parameters": { "CampaignID": { "Required": false }, "S3bucket": { "Required": true } } }Pour plus d’informations, consultez Utilisation des extensions AWS AppConfig dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez UpdateExtension
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser validate-configuration.
- AWS CLI
-
Pour valider une configuration
L’exemple
validate-configurationsuivant utilise les validateurs d’un profil de configuration pour valider une configuration.aws appconfig validate-configuration \ --application-idabc1234\ --configuration-profile-idur8hx2f\ --configuration-version1Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Étape 3 : Création d’une configuration et d’un profil de configuration dans le Guide de l’utilisateur AWS AppConfig.
-
Pour plus de détails sur l’API, consultez ValidateConfiguration
dans la Référence des commandes de l’AWS CLI.
-