AWS CLI を使用した AWS AppConfig の例

アプリケーションを作成するには

次の 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 ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

設定プロファイルを作成するには

次の create-configuration-profile の例は、Systems Manager の一機能である Parameter Store に保存されている設定を使用して設定プロファイルを作成します。

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 ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。

環境を作成するには

次の create-environment の例では、create-application を使用して作成したアプリケーションを使用して Example-Environment という名前の AWS AppConfig 環境を作成します。

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 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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

拡張機能を作成するには

次の 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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

ホストされた設定バージョンを作成するには

次の 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 ユーザーガイド」の「About the AWS AppConfig hosted configuration store」を参照してください。

アプリケーションを削除するには

以下の delete-application の例は、指定されたスタックを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

設定プロファイルを削除するには

次の delete-configuration-profile の例では、指定された設定プロファイルを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。

デプロイ戦略を削除するには

次の delete-deployment-strategy の例は、指定されたデプロイ戦略を削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 4: Creating a deployment strategy」を参照してください。

環境を削除するには

以下の delete-environment の例は、指定されたアプリケーション環境を削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「ステップ 2: 環境の作成」を参照してください。

拡張機能の関連付けを削除するには

次の delete-extension-association の例では、AWS AppConfig に新しい拡張機能の関連付けを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

拡張機能を削除するには

次の delete-extension の例では、AWS AppConfig に新しい拡張機能を削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

ホストされた設定バージョンを削除するには

次の delete-hosted-configuration-version の例では、AWS AppConfig ホスト設定ストアでホストされている設定バージョンを削除します。

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

出力:: このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。

アプリケーションの詳細を一覧表示するには

次の get-application の例では、指定されたアプリケーションの詳細を一覧表示します。

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

出力:

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

詳細については、「AWS AppConfig ユーザーガイド」の「How AWS AppConfig works」を参照してください。

設定プロファイルの詳細を取得するには

次の 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 ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。

設定の詳細を取得するには

次の get-configuration の例では、サンプルアプリケーションの設定の詳細を返します。後続の 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 ユーザーガイド」の「Step 6: Receiving the configuration」を参照してください。

デプロイ戦略の詳細を取得するには

次の 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 ユーザーガイド」の「Step 4: Creating a deployment strategy」を参照してください。

デプロイの詳細を取得するには

次の 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: 構成のデプロイ」を参照してください。

環境の詳細を取得するには

次の get-environment の例は、指定された環境の詳細と状態を返します。

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

出力:

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

詳細については、「AWS AppConfig ユーザーガイド」の「ステップ 2: 環境の作成」を参照してください。

拡張機能の関連付けの詳細を取得するには

以下の 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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

拡張機能の詳細を取得するには

以下の 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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

ホスト設定の詳細を取得するには

次の 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 ユーザーガイド」の「About the AWS AppConfig hosted configuration store」を参照してください。

使用可能なアプリケーションを一覧表示するには

次の 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 ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

使用可能な設定プロファイルを一覧表示するには

次の 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 ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。

利用可能なデプロイ戦略を一覧表示するには

次の 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 ユーザーガイド」の「Step 4: Creating a deployment strategy」を参照してください。

使用可能なデプロイを一覧表示するには

次の 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: 構成のデプロイ」を参照してください。

使用可能な環境を一覧表示するには

次の list-environments の例では、指定されたアプリケーションの AWS アカウントで使用可能な環境を一覧表示します。

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

出力:

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

詳細については、「AWS AppConfig ユーザーガイド」の「ステップ 2: 環境の作成」を参照してください。

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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

利用可能なホスト設定バージョンを一覧表示するには

次の 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 ユーザーガイド」の「About the AWS AppConfig hosted configuration store」を参照してください。

アプリケーションのタグを一覧表示するには

次の 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 ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

設定デプロイを開始するには

次の 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: 構成のデプロイ」を参照してください。

設定のデプロイを停止するには

次の 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: 構成のデプロイ」を参照してください。

アプリケーションにタグ付けするには

次の tag-resource の例では、アプリケーションリソースにタグ付けします。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

アプリケーションからタグを削除するには

次の untag-resource の例では、指定されたアプリケーションから group1 のタグを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

アプリケーションを更新するには

次の 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 ユーザーガイド」の「Step 1: Creating an AWS AppConfig application」を参照してください。

設定プロファイルを更新するには

次の 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 ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。

デプロイ戦略を更新するには

次の 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 ユーザーガイド」の「Step 4: Creating a deployment strategy」を参照してください。

環境を更新するには

次の 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: 環境の作成」を参照してください。

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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

AWS AppConfig 拡張機能を更新するには

次の update-extension の例では、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 ユーザーガイド」の「Working with AWS AppConfig extensions」を参照してください。

設定を検証するには

次の validate-configuration の例では、設定プロファイルのバリデータを使用して構成を検証します。

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

このコマンドでは何も出力されません。

詳細については、「AWS AppConfig ユーザーガイド」の「Step 3: Creating a configuration and a configuration profile」を参照してください。