Esempi di AWS AppConfig con la AWS CLI - AWS Command Line Interface
Operazioni

Esempi di AWS AppConfig con la AWS CLI

Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando la AWS Command Line Interface con AWS AppConfig.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

L’esempio di codice seguente mostra come utilizzare create-application.

AWS CLI

Come creare un’applicazione

L’esempio create-application seguente crea un’applicazione in AWS AppConfig.

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

Output:

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

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta CreateApplication in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-configuration-profile.

AWS CLI

Come creare un profilo di configurazione

L’esempio create-configuration-profile seguente crea un profilo di configurazione utilizzando una configurazione archiviata in Parameter Store, una funzionalità di 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"

Output:

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

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare create-environment.

AWS CLI

Per creare un ambiente

L’esempio create-environment seguente crea un ambiente AWS AppConfig denominato Example-Environment utilizzando l’applicazione creata con create-application.

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

Output:

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

Per ulteriori informazioni, consulta Step 2: Creating an environment nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta CreateEnvironment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-extension-association.

AWS CLI

Come creare un’associazione di estensioni

L’esempio create-extension-association seguente crea una nuova associazione di estensioni in 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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare create-extension.

AWS CLI

Come creare un’estensione

L’esempio create-extension seguente crea una nuova estensione in 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}

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta CreateExtension in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-hosted-configuration-version.

AWS CLI

Come creare una versione della configurazione ospitata

L’esempio create-hosted-configuration-version seguente crea una nuova configurazione nell’archivio di configurazione ospitata di AWS AppConfig. Il contenuto della configurazione deve essere prima convertito in Base64.

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

Contenuto di configuration_version_output_file.

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

Output:

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

Per ulteriori informazioni, consulta About the AWS AppConfig hosted configuration store nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare delete-application.

AWS CLI

Eliminazione di un'applicazione

L’esempio delete-application seguente elimina l’applicazione specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta DeleteApplication in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-configuration-profile.

AWS CLI

Come eliminare un profilo di configurazione

L’esempio delete-configuration-profile seguente elimina il profilo di configurazione specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare delete-deployment-strategy.

AWS CLI

Come eliminare una strategia di implementazione

L’esempio delete-deployment-strategy seguente elimina la strategia di implementazione specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 4: Creating a deployment strategy nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare delete-environment.

AWS CLI

Come eliminare un ambiente

L’esempio delete-environment seguente elimina l’ambiente dell’applicazione specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 2: Creating an environment nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta DeleteEnvironment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-extension-association.

AWS CLI

Come eliminare un’associazione di estensioni

L’esempio delete-extension-association seguente elimina un’associazione di estensioni da AWS AppConfig.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare delete-extension.

AWS CLI

Come eliminare un’estensione

L’esempio delete-extension seguente elimina un’estensione da AWS AppConfig.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta DeleteExtension in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-hosted-configuration-version.

AWS CLI

Come eliminare una versione della configurazione ospitata

L’esempio delete-hosted-configuration-version seguente elimina una versione della configurazione ospitata nell’archivio di configurazione ospitata di AWS AppConfig.

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

Output: questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare get-application.

AWS CLI

Come elencare i dettagli di un’applicazione

L’esempio get-application seguente elenca i dettagli dell’applicazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta How AWS AppConfig works nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta GetApplication in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-configuration-profile.

AWS CLI

Come recuperare i dettagli del profilo di configurazione

L’esempio get-configuration-profile seguente restituisce i dettagli del profilo di configurazione specificato.

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

Output:

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

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare get-configuration.

AWS CLI

Come recuperare i dettagli della configurazione

L’esempio get-configuration seguente restituisce i dettagli della configurazione dell’applicazione di esempio. Nelle chiamate successive a get-configuration, utilizza il parametro client-configuration-version per aggiornare la configurazione dell’applicazione solo se è cambiata la versione. Se la configurazione viene aggiornata solo quando è cambiata la versione, si evitano costi in eccesso derivanti dalle chiamate a get-configuration.

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

Contenuto di configuration-output-file.

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

Output:

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

Per ulteriori informazioni, consulta Step 6: Receiving the configuration nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta GetConfiguration in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-deployment-strategy.

AWS CLI

Come recuperare i dettagli di una strategia di implementazione

L’esempio get-deployment-strategy seguente elenca i dettagli della strategia di implementazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Step 4: Creating a deployment strategy nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare get-deployment.

AWS CLI

Come recuperare i dettagli dell’implementazione

L’esempio get-deployment seguente elenca i dettagli dell’implementazione nell’applicazione nell’ambiente e nell’implementazione specificati.

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

Output:

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

Per ulteriori informazioni, consulta Step 5: Deploying a configuration nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta GetDeployment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-environment.

AWS CLI

Come recuperare i dettagli dell’ambiente

L’esempio get-environment seguente restituisce i dettagli e lo stato dell’ambiente specificato.

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

Output:

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

Per ulteriori informazioni, consulta Step 2: Creating an environment nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta GetEnvironment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-extension-association.

AWS CLI

Come ottenere informazioni dettagliate su un’associazione di estensioni

L’esempio get-extension-association seguente visualizza informazioni su un’associazione di estensioni.

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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare get-extension.

AWS CLI

Come ottenere informazioni dettagliate su un’estensione

L’esempio get-extension seguente visualizza informazioni su un’estensione.

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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta GetExtension in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-hosted-configuration-version.

AWS CLI

Come recuperare informazioni dettagliate su una configurazione ospitata

L’esempio get-hosted-configuration-version seguente recupera i dettagli di configurazione della configurazione ospitata di AWS AppConfig.

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

Contenuto di hosted-configuration-version-output.

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

Output:

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

Per ulteriori informazioni, consulta About the AWS AppConfig hosted configuration store nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare list-applications.

AWS CLI

Come elencare le applicazioni disponibili

L’esempio list-applications seguente elenca le applicazioni disponibili nel tuo account AWS.

aws appconfig list-applications

Output:

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

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta ListApplications in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-configuration-profiles.

AWS CLI

Come elencare i profili di configurazione disponibili

L’esempio list-configuration-profiles seguente elenca i profili di configurazione disponibili per l’applicazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare list-deployment-strategies.

AWS CLI

Come elencare le strategie di implementazione disponibili

L’esempio list-deployment-strategies seguente elenca le strategie di implementazione disponibili nel tuo account AWS.

aws appconfig list-deployment-strategies

Output:

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

Per ulteriori informazioni, consulta Step 4: Creating a deployment strategy nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare list-deployments.

AWS CLI

Come elencare le implementazioni disponibili

L’esempio list-deployments seguente elenca le implementazioni disponibili nel tuo account AWS per l’applicazione e l’ambiente specificati.

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

Output:

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

Per ulteriori informazioni, consulta Step 5: Deploying a configuration nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta ListDeployments in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-environments.

AWS CLI

Come elencare gli ambienti disponibili

L’esempio list-environments seguente elenca gli ambienti disponibili nel tuo account AWS per l’applicazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Step 2: Creating an environment nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta ListEnvironments in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-extension-associations.

AWS CLI

Come elencare tutte le associazioni di estensioni di AWS AppConfig nel tuo account AWS per una Regione AWS

L’esempio list-extension-associations seguente elenca tutte le associazioni di estensioni di AWS AppConfig per l’account AWS corrente in una specifica Regione AWS.

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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare list-extensions.

AWS CLI

Come elencare tutte le estensioni di AWS AppConfig nel tuo account AWS per una Regione AWS

L’esempio list-extensions seguente elenca tutte le estensioni di AWS AppConfig per l’account AWS corrente in una specifica Regione AWS. Il comando restituisce le estensioni personalizzate e create da AWS.

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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta ListExtensions in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-hosted-configuration-versions.

AWS CLI

Come elencare le versioni delle configurazioni ospitate disponibili

L’esempio list-hosted-configuration-versions seguente elenca le versioni delle configurazioni ospitate nell’archivio di configurazione ospitata di AWS AppConfig per l’applicazione e il profilo di configurazione specificati.

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

Output:

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

Per ulteriori informazioni, consulta About the AWS AppConfig hosted configuration store nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare list-tags-for-resource.

AWS CLI

Come elencare i tag di un’applicazione

L’esempio list-tags-for-resource seguente elenca i tag dell’applicazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull'API, consulta ListTagsForResource nella Documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare start-deployment.

AWS CLI

Come avviare l’implementazione di una configurazione

L’esempio start-deployment seguente avvia un’implementazione nell’applicazione utilizzando l’ambiente, la strategia di implementazione e il profilo di configurazione specificati.

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

Output:

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

Per ulteriori informazioni, consulta Step 5: Deploying a configuration nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta StartDeployment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare stop-deployment.

AWS CLI

Come arrestare l’implementazione di una configurazione

L’esempio stop-deployment seguente arresta l’implementazione della configurazione di un’applicazione nell’ambiente specificato.

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

Output:

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

Per ulteriori informazioni, consulta Step 5: Deploying a configuration nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta StopDeployment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare tag-resource.

AWS CLI

Come taggare un’applicazione

L’esempio tag-resource seguente tagga una risorsa dell’applicazione.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta TagResource in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare untag-resource.

AWS CLI

Come rimuovere un tag da un’applicazione

L’esempio untag-resource seguente rimuove il tag group1 dall’applicazione specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta UntagResource in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare update-application.

AWS CLI

Come aggiornare un’applicazione

L’esempio update-application seguente aggiorna il nome dell’applicazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Step 1: Creating an AWS AppConfig application nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta UpdateApplication in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare update-configuration-profile.

AWS CLI

Come aggiornare un profilo di configurazione

L’esempio update-configuration-profile seguente aggiorna la descrizione del profilo di configurazione specificato.

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

Output:

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

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare update-deployment-strategy.

AWS CLI

Come aggiornare una strategia di implementazione

L’esempio update-deployment-strategy seguente aggiorna il tempo di incorporamento finale a 20 minuti nella strategia di implementazione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Step 4: Creating a deployment strategy nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare update-environment.

AWS CLI

Come aggiornare un ambiente

L’esempio update-environment seguente aggiorna la descrizione di un ambiente.

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

Output:

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

Per ulteriori informazioni, consulta Step 2: Creating an environment nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta UpdateEnvironment in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare update-extension-association.

AWS CLI

Come aggiornare un’associazione di estensioni di AWS AppConfig

L’esempio update-extension-association seguente aggiunge un nuovo valore di parametro a un’associazione di estensioni in AWS AppConfig.

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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

L’esempio di codice seguente mostra come utilizzare update-extension.

AWS CLI

Come aggiornare un’estensione di AWS AppConfig

L’esempio update-extension seguente aggiunge un’ulteriore chiave di parametro a un’estensione in AWS AppConfig.

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

Output:

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

Per ulteriori informazioni, consulta Working with AWS AppConfig extensions nella Guida per l’utente di AWS AppConfig.

  • Per informazioni dettagliate sull’API, consulta UpdateExtension in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare validate-configuration.

AWS CLI

Come convalidare una configurazione

L’esempio validate-configuration seguente utilizza i validatori in un profilo di configurazione per convalidare una configurazione.

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

Il comando non produce alcun output.

Per ulteriori informazioni, consulta Step 3: Creating a configuration and a configuration profile nella Guida per l’utente di AWS AppConfig.