View a markdown version of this page

AWS AppConfig exemples utilisant AWS CLI - AWS Exemples de code SDK
Actions

D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples GitHub .

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS AppConfig exemples utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de AWS Command Line Interface with 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 utilisercreate-application.

AWS CLI

Pour créer une application

L'create-applicationexemple suivant 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 AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez CreateApplication la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-configuration-profile.

AWS CLI

Pour créer un profil de configuration

L’exemple create-configuration-profile suivant 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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utilisercreate-environment.

AWS CLI

Pour créer un environnement

L'create-environmentexemple suivant crée un AWS AppConfig environnement nommé à l' Example-Environment aide de l'application que vous avez créée à l'aide de 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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez CreateEnvironment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-extension-association.

AWS CLI

Pour créer une association d’extension

L'create-extension-associationexemple suivant crée une nouvelle association d'extension dans AWS AppConfig.

aws appconfig create-extension-association \
    --region us-west-2 \
    --extension-identifier S3-backup-extension \
    --resource-identifier "arn:aws:appconfig:us-west-2:123456789012:application/Finance" \
    --parameters S3bucket=FinanceConfigurationBackup

Sortie :

{
  "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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utilisercreate-extension.

AWS CLI

Pour créer une extension

L'create-extensionexemple suivant crée une nouvelle extension dans AWS AppConfig.

aws appconfig create-extension \
    --region us-west-2 \
    --name S3-backup-extension \
    --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}

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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez CreateExtension la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-hosted-configuration-version.

AWS CLI

Pour créer une version de configuration hébergée

L'create-hosted-configuration-versionexemple suivant crée une nouvelle configuration dans le magasin de configuration AWS AppConfig hébergé. 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" \
    --content eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9 \
    --content-type "application/json" \
    configuration_version_output_file

Contenu 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 la section À propos du magasin de configuration AWS AppConfig hébergé dans le Guide de l'utilisateur d'AWS Appconfig.

L'exemple de code suivant montre comment utiliserdelete-application.

AWS CLI

Pour supprimer une application

L’exemple delete-application suivant supprime l’application spécifiée.

aws appconfig delete-application \
--application-id 339ohji

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez Étape 1 : Création d'une AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez DeleteApplication la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-configuration-profile.

AWS CLI

Pour supprimer un profil de configuration

L’exemple delete-configuration-profile suivant supprime le profil de la configuration spécifiée.

aws appconfig delete-configuration-profile \
    --application-id 339ohji \
    --configuration-profile-id ur8hx2f

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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserdelete-deployment-strategy.

AWS CLI

Pour supprimer une stratégie de déploiement

L’exemple delete-deployment-strategy suivant supprime la stratégie de déploiement spécifiée.

aws appconfig delete-deployment-strategy \
    --deployment-strategy-id 1225qzk

Cette 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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserdelete-environment.

AWS CLI

Pour supprimer un environnement

L’exemple delete-environment suivant supprime l’environnement d’application spécifié.

aws appconfig delete-environment \
    --application-id 339ohji \
    --environment-id 54j1r29

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez Étape 2 : Création d'un environnement dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez DeleteEnvironment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-extension-association.

AWS CLI

Pour supprimer une association d’extension

L'delete-extension-associationexemple suivant supprime une association d'extension de AWS AppConfig.

aws appconfig delete-extension-association \
    --region us-west-2 \
    --extension-association-id a1b2c3d4

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserdelete-extension.

AWS CLI

Pour supprimer une extension

L'delete-extensionexemple suivant supprime une extension de AWS AppConfig.

aws appconfig delete-extension \
    --region us-west-2 \
    --extension-identifier S3-backup-extension

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez DeleteExtension la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-hosted-configuration-version.

AWS CLI

Pour supprimer une version de configuration hébergée

L'delete-hosted-configuration-versionexemple suivant supprime une version de configuration hébergée dans le magasin de configuration AWS AppConfig hébergé.

aws appconfig delete-hosted-configuration-version \
    --application-id 339ohji \
    --configuration-profile-id ur8hx2f \
    --version-number 1

Sortie : 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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserget-application.

AWS CLI

Pour répertorier les informations d’une application

L’exemple get-application suivant répertorie les informations de l’application spécifiée.

aws appconfig get-application \
    --application-id 339ohji

Sortie :

{
    "Description": "An application used for creating an example.",
    "Id": "339ohji",
    "Name": "example-application"
}

Pour plus d'informations, consultez la section Comment AWS AppConfig fonctionne dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez GetApplication la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-configuration-profile.

AWS CLI

Pour récupérer les informations du profil de la configuration

L’exemple get-configuration-profile suivant renvoie les informations du profil de la configuration spécifié.

aws appconfig get-configuration-profile \
    --application-id 339ohji \
    --configuration-profile-id ur8hx2f

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserget-configuration.

AWS CLI

Pour récupérer les informations de la configuration

L’exemple get-configuration suivant renvoie les informations de la configuration de l’exemple d’application. Lors des appels ultérieurs à get-configuration, utilisez le paramètre client-configuration-version pour 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-file

Contenu 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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez GetConfiguration la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-deployment-strategy.

AWS CLI

Pour récupérer les informations d’une stratégie de déploiement

L’exemple get-deployment-strategy suivant répertorie les informations de la stratégie de déploiement spécifiée.

aws appconfig get-deployment-strategy \
    --deployment-strategy-id 1225qzk

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserget-deployment.

AWS CLI

Pour récupérer les informations du déploiement

L’exemple get-deployment suivant 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-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-number 1

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez GetDeployment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-environment.

AWS CLI

Pour récupérer les informations de l’environnement

L’exemple get-environment suivant renvoie les informations et l’état de l’environnement spécifié.

aws appconfig get-environment \
    --application-id 339ohji \
    --environment-id 54j1r29

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez GetEnvironment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-extension-association.

AWS CLI

Pour obtenir les informations de l’association d’extension

L’exemple get-extension-association suivant affiche des informations sur une association d’extension.

aws appconfig get-extension-association \
    --region us-west-2 \
    --extension-association-id a1b2c3d4

Sortie :

{
    "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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserget-extension.

AWS CLI

Pour obtenir les informations de l’extension

L’exemple get-extension suivant affiche des informations sur une extension.

aws appconfig get-extension \
    --region us-west-2 \
    --extension-identifier S3-backup-extension

Sortie :

{
    "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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez GetExtension la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-hosted-configuration-version.

AWS CLI

Pour récupérer les détails de configuration hébergée

L'get-hosted-configuration-versionexemple suivant récupère les détails de configuration de la configuration AWS AppConfig hébergée.

aws appconfig get-hosted-configuration-version \
    --application-id 339ohji \
    --configuration-profile-id ur8hx2f \
    --version-number 1 \
    hosted-configuration-version-output

Contenu 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 la section À propos du magasin de configuration AWS AppConfig hébergé dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-applications.

AWS CLI

Pour répertorier les applications disponibles

L'list-applicationsexemple suivant répertorie les applications disponibles dans votre AWS compte.

aws appconfig list-applications

Sortie :

{
    "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 AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez ListApplications la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-configuration-profiles.

AWS CLI

Pour répertorier les profils de configuration disponibles

L’exemple list-configuration-profiles suivant répertorie les profils de configuration disponibles pour l’application spécifiée.

aws appconfig list-configuration-profiles \
    --application-id 339ohji

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-deployment-strategies.

AWS CLI

Pour répertorier les stratégies de déploiement disponibles

L'list-deployment-strategiesexemple suivant répertorie les stratégies de déploiement disponibles dans votre AWS compte.

aws appconfig list-deployment-strategies

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-deployments.

AWS CLI

Pour répertorier les déploiements disponibles

L'list-deploymentsexemple suivant répertorie les déploiements disponibles sur votre AWS compte pour l'application et l'environnement spécifiés.

aws appconfig list-deployments \
    --application-id 339ohji \
    --environment-id 54j1r29

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez ListDeployments la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-environments.

AWS CLI

Pour répertorier les environnements disponibles

L'list-environmentsexemple suivant répertorie les environnements disponibles dans votre AWS compte pour l'application spécifiée.

aws appconfig list-environments \
    --application-id 339ohji

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez ListEnvironments la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-extension-associations.

AWS CLI

Pour répertorier toutes les associations d' AWS AppConfig extension de votre AWS compte pour une AWS région

L'list-extension-associationsexemple suivant répertorie toutes les associations d' AWS AppConfig extensions pour le AWS compte courant dans une AWS région spécifique.

aws appconfig list-extension-associations \
    --region us-west-2

Sortie :

{
    "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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-extensions.

AWS CLI

Pour répertorier toutes les AWS AppConfig extensions de votre AWS compte pour une AWS région

L'list-extensionsexemple suivant répertorie toutes les AWS AppConfig extensions du AWS compte courant dans une AWS région spécifique. La commande renvoie des extensions personnalisées AWS et créées.

aws appconfig list-extensions \
    --region us-west-2

Sortie :

{
    "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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez ListExtensions la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-hosted-configuration-versions.

AWS CLI

Pour répertorier les versions de configuration hébergées disponibles

L'list-hosted-configuration-versionsexemple suivant répertorie les versions de configurations hébergées dans le magasin de configuration AWS AppConfig hébergé pour l'application et le profil de configuration spécifiés.

aws appconfig list-hosted-configuration-versions \
    --application-id 339ohji \
    --configuration-profile-id ur8hx2f

Sortie :

{
    "Items": [
        {
            "ApplicationId": "339ohji",
            "ConfigurationProfileId": "ur8hx2f",
            "VersionNumber": 1,
            "ContentType": "application/json"
        }
    ]
}

Pour plus d'informations, consultez la section À propos du magasin de configuration AWS AppConfig hébergé dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises d’une application

L’exemple list-tags-for-resource suivant répertorie les balises d’une application spécifiée.

aws appconfig list-tags-for-resource \
    --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji

Sortie :

{
    "Tags": {
        "group1": "1"
    }
}

Pour plus d'informations, consultez Étape 1 : Création d'une AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez ListTagsForResource la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-deployment.

AWS CLI

Pour démarrer le déploiement d’une configuration

L’exemple start-deployment suivant 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-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-strategy-id 1225qzk \
    --configuration-profile-id ur8hx2f \
    --configuration-version 1

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez StartDeployment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-deployment.

AWS CLI

Pour arrêter le déploiement d’une configuration

L’exemple stop-deployment suivant arrête le déploiement d’une configuration d’application dans l’environnement spécifié.

aws appconfig stop-deployment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-number 2

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez StopDeployment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour baliser une application

L’exemple tag-resource suivant balise une ressource d’application.

aws appconfig tag-resource \
    --resource-arn arn: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 AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez TagResource la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer une balise d’une application

L’exemple untag-resource suivant supprime la balise group1 de l’application spécifiée.

aws appconfig untag-resource \
    --resource-arn arn: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 AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez UntagResource la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-application.

AWS CLI

Pour mettre à jour une application

L’exemple update-application suivant met à jour le nom de l’application spécifiée.

aws appconfig update-application \
    --application-id 339ohji \
    --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 AWS AppConfig application dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez UpdateApplication la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-configuration-profile.

AWS CLI

Pour mettre à jour un profil de configuration

L’exemple update-configuration-profile suivant met à jour la description du profil de configuration spécifié.

aws appconfig update-configuration-profile \
    --application-id 339ohji \
    --configuration-profile-id ur8hx2f \
    --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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-deployment-strategy.

AWS CLI

Pour mettre à jour une stratégie de déploiement

L’exemple update-deployment-strategy suivant met à jour la durée de l’intégration finale à 20 minutes dans la stratégie de déploiement spécifiée.

aws appconfig update-deployment-strategy \
    --deployment-strategy-id 1225qzk \
    --final-bake-time-in-minutes 20

Sortie :

{
    "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 AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-environment.

AWS CLI

Pour mettre à jour un environnement

L’exemple update-environment suivant met à jour la description d’un environnement.

aws appconfig update-environment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --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 AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez UpdateEnvironment la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-extension-association.

AWS CLI

Pour mettre à jour une association d' AWS AppConfig extension

L'update-extension-associationexemple suivant ajoute une nouvelle valeur de paramètre à une association d'extension dans AWS AppConfig.

aws appconfig update-extension-association \
    --region us-west-2 \
    --extension-association-id a1b2c3d4 \
    --parameters S3bucket=FinanceMobileApp

Sortie :

{
    "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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-extension.

AWS CLI

Pour mettre à jour une AWS AppConfig extension

L'update-extensionexemple suivant ajoute un paramètre supplémentaire Key à une extension dans AWS AppConfig.

aws appconfig update-extension \
    --region us-west-2 \
    --extension-identifier S3-backup-extension \
    --parameters S3bucket={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 la section Utilisation des AWS AppConfig extensions dans le Guide de AWS AppConfig l'utilisateur.

  • Pour plus de détails sur l'API, consultez UpdateExtension la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliservalidate-configuration.

AWS CLI

Pour valider une configuration

L’exemple validate-configuration suivant utilise les validateurs d’un profil de configuration pour valider une configuration.

aws appconfig validate-configuration \
    --application-id abc1234 \
    --configuration-profile-id ur8hx2f \
    --configuration-version 1

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez Étape 3 : Création d'une configuration et d'un profil de configuration dans le Guide de AWS AppConfig l'utilisateur.