AWS AppConfig 使用範例 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

AWS AppConfig 使用範例 AWS CLI

下列程式碼範例說明如何使用 AWS Command Line Interface 與來執行動作及實作常見案例 AWS AppConfig。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用create-application

AWS CLI

若要建立應用程式

下列create-application範例會在中建立應用程式 AWS AppConfig。

aws appconfig create-application \ --name "example-application" \ --description "An application used for creating an example."

輸出:

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

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

下列程式碼範例會示範如何使用create-configuration-profile

AWS CLI

建立組態設定描述檔

下列create-configuration-profile範例會使用儲存在「參數存放區」(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"

輸出:

{ "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 }

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。

下列程式碼範例會示範如何使用create-environment

AWS CLI

建立環境的步驟

下列create-environment範例會使用您使用建立 AWS AppConfig 應用程式建立的應用程式,建立名為 Example-環境的環境。

aws appconfig create-environment \ --application-id "339ohji" \ --name "Example-Environment"

輸出:

{ "ApplicationId": "339ohji", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" }

若要取得更多資訊,請參閱《AWS AppConfig 使用指南》中的步驟 2:建立環境

下列程式碼範例會示範如何使用create-extension-association

AWS CLI

若要建立擴充功能關聯

下列create-extension-association範例會在中建立新的擴充功能關聯 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

輸出:

{ "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 }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

下列程式碼範例會示範如何使用create-extension

AWS CLI

若要建立擴充功能

下列create-extension範例會在中建立新的副檔名 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}

輸出:

{ "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 } } }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateExtension中的。

下列程式碼範例會示範如何使用create-hosted-configuration-version

AWS CLI

若要建立託管組態版本

下列create-hosted-configuration-version範例會在 AWS AppConfig 裝載的組態存放區中建立新的組態。組態內容必須先轉換為 base64。

aws appconfig create-hosted-configuration-version \ --application-id "339ohji" \ --configuration-profile-id "ur8hx2f" \ --content eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9 \ --content-type "application/json" \ configuration_version_output_file

configuration_version_output_file 的內容:

{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }

輸出:

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

如需詳細資訊,請參閱《AWS Appconfig 使用者指南》中的關於 AWS AppConfig 託管組態存放區

下列程式碼範例會示範如何使用delete-application

AWS CLI

如欲刪除應用程式

下列delete-application範例會刪除指定的應用程式。

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

此命令不會產生輸出。

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

下列程式碼範例會示範如何使用delete-configuration-profile

AWS CLI

若要刪除組態設定檔

下列delete-configuration-profile範例會刪除指定的組態設定檔。

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

此命令不會產生輸出。

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。

下列程式碼範例會示範如何使用delete-deployment-strategy

AWS CLI

若要刪除部署策略

下列delete-deployment-strategy範例會刪除指定的部署策略。

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

此命令不會產生輸出。

如需詳細資訊,請參閱AWS AppConfig 使用指南中的步驟 4:建立部署策略

下列程式碼範例會示範如何使用delete-environment

AWS CLI

刪除環境的步驟

下列delete-environment範例會刪除指定的應用程式環境。

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

此命令不會產生輸出。

若要取得更多資訊,請參閱《AWS AppConfig 使用指南》中的步驟 2:建立環境

下列程式碼範例會示範如何使用delete-extension-association

AWS CLI

若要刪除擴充功能關聯

下列delete-extension-association範例會從中刪除擴充功能關聯 AWS AppConfig。

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

此命令不會產生輸出。

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

下列程式碼範例會示範如何使用delete-extension

AWS CLI

若要刪除副檔名

下列delete-extension範例會從中刪除副檔名 AWS AppConfig。

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

此命令不會產生輸出。

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DeleteExtension中的。

下列程式碼範例會示範如何使用delete-hosted-configuration-version

AWS CLI

若要刪除託管組態版本

下列delete-hosted-configuration-version範例會刪除裝載於主控組態存放區中的 AWS AppConfig 組態版本。

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

輸出:: 此命令不產生任何輸出。

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。

下列程式碼範例會示範如何使用get-application

AWS CLI

若要列出應用程式的詳細資訊

下列get-application範例會列出指定應用程式的詳細資訊。

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

輸出:

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

若要取得更多資訊,請參閱AWS AppConfig 使用指南》中的 AWS AppConfig 運作方式。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetApplication中的。

下列程式碼範例會示範如何使用get-configuration-profile

AWS CLI

擷取組態設定檔詳細資訊

下列get-configuration-profile範例會傳回指定組態設定檔的詳細資訊。

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

輸出:

{ "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。

下列程式碼範例會示範如何使用get-configuration

AWS CLI

擷取組態詳細資訊

下列get-configuration範例會傳回範例應用程式的組態詳細資料。在後續呼叫取得組態時,使用client-configuration-version參數來僅在版本已變更時更新應用程式的組態。只有在版本發生變更時更新組態,才能避免呼叫 get-configuration 所產生的額外費用。

aws appconfig get-configuration \ --application "example-application" \ --environment "Example-Environment" \ --configuration "Example-Configuration-Profile" \ --client-id "test-id" \ configuration-output-file

configuration-output-file 的內容:

{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }

輸出:

{ "ConfigurationVersion": "1", "ContentType": "application/json" }

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 6:接收組態

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetConfiguration中的。

下列程式碼範例會示範如何使用get-deployment-strategy

AWS CLI

若要擷取部署策略的詳細資訊

下列get-deployment-strategy範例會列出指定部署策略的詳細資訊。

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

輸出:

{ "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" }

如需詳細資訊,請參閱AWS AppConfig 使用指南中的步驟 4:建立部署策略

下列程式碼範例會示範如何使用get-deployment

AWS CLI

擷取部署詳細資訊

下列get-deployment範例會列出在指定環境和部署中部署至應用程式的詳細資訊。

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

輸出:

{ "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" }

如需詳細資訊,請參閱《AWS AppConfig 使用者指南》的步驟 5:部署組態

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetDeployment中的。

下列程式碼範例會示範如何使用get-environment

AWS CLI

擷取環境詳細資訊

下列get-environment範例會傳回指定環境的詳細資料和狀態。

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

輸出:

{ "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" }

若要取得更多資訊,請參閱《AWS AppConfig 使用指南》中的步驟 2:建立環境

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetEnvironment中的。

下列程式碼範例會示範如何使用get-extension-association

AWS CLI

取得擴充功能關聯詳細資

下列get-extension-association範例會顯示有關延伸功能關聯的資訊。

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

輸出:

{ "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 }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

下列程式碼範例會示範如何使用get-extension

AWS CLI

取得擴充功能詳細資

下列get-extension範例會顯示擴充功能的相關資訊。

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

輸出:

{ "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 } } }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetExtension中的。

下列程式碼範例會示範如何使用get-hosted-configuration-version

AWS CLI

檢視託管組態詳細資料

下列get-hosted-configuration-version範例會擷取 AWS AppConfig 託管組態的組態詳細資料。

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

hosted-configuration-version-output 的內容:

{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }

輸出:

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

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的關於 AWS AppConfig 託管組態存放區

下列程式碼範例會示範如何使用list-applications

AWS CLI

列出可用的應用程式

下列list-applications範例會列出您 AWS 帳戶中可用的應用程式。

aws appconfig list-applications

輸出:

{ "Items": [ { "Id": "339ohji", "Name": "test-application", "Description": "An application used for creating an example." }, { "Id": "rwalwu7", "Name": "Test-Application" } ] }

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListApplications中的。

下列程式碼範例會示範如何使用list-configuration-profiles

AWS CLI

列出可用的組態設定檔

下列list-configuration-profiles範例會列出指定應用程式的可用組態設定檔。

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

輸出:

{ "Items": [ { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter" } ] }

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。

下列程式碼範例會示範如何使用list-deployment-strategies

AWS CLI

列出可用的部署策略

下列list-deployment-strategies範例會列出您 AWS 帳戶中可用的部署策略。

aws appconfig list-deployment-strategies

輸出:

{ "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" } ] }

如需詳細資訊,請參閱AWS AppConfig 使用指南中的步驟 4:建立部署策略

下列程式碼範例會示範如何使用list-deployments

AWS CLI

列出可用部署的步驟

下列list-deployments範例會列出您 AWS 帳戶中針對指定應用程式和環境的可用部署。

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

輸出:

{ "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" } ] }

如需詳細資訊,請參閱《AWS AppConfig 使用者指南》的步驟 5:部署組態

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListDeployments中的。

下列程式碼範例會示範如何使用list-environments

AWS CLI

列出可用環境

下列list-environments範例會列出您 AWS 帳戶中指定應用程式的可用環境。

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

輸出:

{ "Items": [ { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ] }

若要取得更多資訊,請參閱《AWS AppConfig 使用指南》中的步驟 2:建立環境

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListEnvironments中的。

下列程式碼範例會示範如何使用list-extension-associations

AWS CLI

若要列出您 AWS 帳戶中某個 AWS 區域的所有 AWS AppConfig 擴充功能關聯

下列list-extension-associations範例會列出特定 AWS 區域中目前 AWS 帳戶的所有 AWS AppConfig 擴充功能關聯。

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

輸出:

{ "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" } ] }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

下列程式碼範例會示範如何使用list-extensions

AWS CLI

列出您 AWS 帳戶中某個 AWS 區域的所有 AWS AppConfig 擴充功能

下列list-extensions範例會列出特定 AWS 區域中目前 AWS 帳戶的所有 AWS AppConfig 副檔名。該命令會傳回自訂和 AWS 已編寫的擴充功能。

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

輸出:

{ "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." } ] }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListExtensions中的。

下列程式碼範例會示範如何使用list-hosted-configuration-versions

AWS CLI

列出可用的託管配置版本

下列list-hosted-configuration-versions範例會針對指定的應用程式和組態設定檔,列出 AWS AppConfig 託管組態存放區中託管的組態版本。

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

輸出:

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

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的關於 AWS AppConfig 託管組態存放區

下列程式碼範例會示範如何使用list-tags-for-resource

AWS CLI

若要列出應用程式的標籤

下列list-tags-for-resource範例會列出指定應用程式的標籤。

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

輸出:

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

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

下列程式碼範例會示範如何使用start-deployment

AWS CLI

啟動規劃部署的步驟

下列start-deployment範例會使用指定的環境、部署策略和組態設定檔,啟動應用程式的部署。

aws appconfig start-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-strategy-id 1225qzk \ --configuration-profile-id ur8hx2f \ --configuration-version 1

輸出:

{ "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" }

如需詳細資訊,請參閱《AWS AppConfig 使用者指南》的步驟 5:部署組態

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考StartDeployment中的。

下列程式碼範例會示範如何使用stop-deployment

AWS CLI

若要停止組態部署

下列stop-deployment範例會停止將應用程式組態部署至指定的環境。

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

輸出:

{ "DeploymentNumber": 0, "DeploymentDurationInMinutes": 0, "GrowthFactor": 0.0, "FinalBakeTimeInMinutes": 0, "PercentageComplete": 0.0 }

如需詳細資訊,請參閱《AWS AppConfig 使用者指南》的步驟 5:部署組態

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考StopDeployment中的。

下列程式碼範例會示範如何使用tag-resource

AWS CLI

標記應用程式

下列tag-resource範例會標記應用程式資源。

aws appconfig tag-resource \ --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji \ --tags '{"group1" : "1"}'

此命令不會產生輸出。

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考TagResource中的。

下列程式碼範例會示範如何使用untag-resource

AWS CLI

若要從應用程式移除標籤

下列untag-resource範例會從指定的應用程式移除 group1 標籤。

aws appconfig untag-resource \ --resource-arn arn:aws:appconfig:us-east-1:111122223333:application/339ohji \ --tag-keys '["group1"]'

此命令不會產生輸出。

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UntagResource中的。

下列程式碼範例會示範如何使用update-application

AWS CLI

若要更新應用程式

下列update-application範例會更新指定應用程式的名稱。

aws appconfig update-application \ --application-id 339ohji \ --name "Example-Application"

輸出:

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

如需詳細資訊,請參閱《AWS AppConfig 使用指南》中的步驟 1:建立 AWS AppConfig 應程式。

下列程式碼範例會示範如何使用update-configuration-profile

AWS CLI

更新組態設定描述檔

下列update-configuration-profile範例會更新指定組態設定檔的描述。

aws appconfig update-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --description "Configuration profile used for examples."

輸出:

{ "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" }

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。

下列程式碼範例會示範如何使用update-deployment-strategy

AWS CLI

更新部署策略

下列update-deployment-strategy範例會將指定的部署策略中的最終烘焙時間更新為 20 分鐘。

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

輸出:

{ "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 20, "ReplicateTo": "SSM_DOCUMENT" }

如需詳細資訊,請參閱AWS AppConfig 使用指南中的步驟 4:建立部署策略

下列程式碼範例會示範如何使用update-environment

AWS CLI

更新環境

下列update-environment範例會更新環境的描述。

aws appconfig update-environment \ --application-id 339ohji \ --environment-id 54j1r29 \ --description "An environment for examples."

輸出:

{ "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "Description": "An environment for examples.", "State": "RolledBack" }

若要取得更多資訊,請參閱《AWS AppConfig 使用指南》中的步驟 2:建立環境

下列程式碼範例會示範如何使用update-extension-association

AWS CLI

若要更新 AWS AppConfig 擴充功能關聯

下列update-extension-association範例會將新參數值新增至中的延伸關聯 AWS AppConfig。

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

輸出:

{ "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 }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

下列程式碼範例會示範如何使用update-extension

AWS CLI

若要更新 AWS AppConfig 擴充功能

下列update-extension範例會將其他參數 Key 加入至中的副檔名 AWS AppConfig。

aws appconfig update-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension \ --parameters S3bucket={Required=true},CampaignID={Required=false}

輸出:

{ "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 } } }

如需詳細資訊,請參閱《使用指南》中的〈AWS AppConfig 使用 AWS AppConfig 擴充功能

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UpdateExtension中的。

下列程式碼範例會示範如何使用validate-configuration

AWS CLI

驗證組態

下列validate-configuration範例會使用組態設定檔中的驗證程式來驗證組態。

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

該命令不會產生任何輸出。

如需詳細資訊,請參閱《AWS AppConfig 使用指南》的「步驟 3:建立組態和組態設定檔」。