As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
AWS AppConfig exemplos usando AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS AppConfig.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.
Tópicos
Ações
O código de exemplo a seguir mostra como usar create-application
.
- AWS CLI
-
Para criar um aplicativo
O
create-application
exemplo a seguir cria um aplicativo em AWS AppConfig.aws appconfig create-application \ --name
"example-application"
\ --description"An application used for creating an example."
Saída:
{ "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" }
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte CreateApplication
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-configuration-profile
.
- AWS CLI
-
Para criar um perfil de configuração
O
create-configuration-profile
exemplo a seguir cria um perfil de configuração usando uma configuração armazenada no Parameter Store, um recurso do 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"
Saída:
{ "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 }
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte CreateConfigurationProfile
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-environment
.
- AWS CLI
-
Para criar um ambiente
O
create-environment
exemplo a seguir cria um AWS AppConfig ambiente chamado Example-Environment usando o aplicativo que você criou usando create-application.aws appconfig create-environment \ --application-id
"339ohji"
\ --name"Example-Environment"
Saída:
{ "ApplicationId": "339ohji", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" }
Para obter mais informações, consulte Etapa 2: Criação de um ambiente no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte CreateEnvironment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-extension-association
.
- AWS CLI
-
Para criar uma associação de extensão
O
create-extension-association
exemplo a seguir cria uma nova associação de extensão em AWS AppConfig.aws appconfig create-extension-association \ --region
us-west-2
\ --extension-identifierS3-backup-extension
\ --resource-identifier"arn:aws:appconfig:us-west-2:123456789012:application/Finance"
\ --parametersS3bucket=FinanceConfigurationBackup
Saída:
{ "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 }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte CreateExtensionAssociation
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-extension
.
- AWS CLI
-
Para criar uma extensão
O
create-extension
exemplo a seguir cria uma nova extensão em AWS AppConfig.aws appconfig create-extension \ --region
us-west-2
\ --nameS3-backup-extension
\ --actionsPRE_CREATE_HOSTED_CONFIGURATION_VERSION=[{Name=S3backup,Uri=arn:aws:lambda:us-west-2:123456789012:function:s3backupfunction,RoleArn=arn:aws:iam::123456789012:role/appconfigextensionrole}]
\ --parametersS3bucket={Required=true}
Saída:
{ "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 } } }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte CreateExtension
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-hosted-configuration-version
.
- AWS CLI
-
Para criar uma versão de configuração hospedada
O
create-hosted-configuration-version
exemplo a seguir cria uma nova configuração no repositório de configurações AWS AppConfig hospedado. O conteúdo da configuração deve primeiro ser convertido em base64.aws appconfig create-hosted-configuration-version \ --application-id
"339ohji"
\ --configuration-profile-id"ur8hx2f"
\ --contenteyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9
\ --content-type"application/json"
\configuration_version_output_file
Conteúdo de
configuration_version_output_file
:{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }
Saída:
{ "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" }
Para obter mais informações, consulte Sobre o armazenamento de configuração AWS AppConfig hospedado no Guia do usuário do AWS Appconfig.
-
Para API obter detalhes, consulte CreateHostedConfigurationVersion
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-application
.
- AWS CLI
-
Como excluir uma aplicação
O
delete-application
exemplo a seguir exclui o aplicativo especificado.aws appconfig delete-application \ --application-id
339ohji
Este comando não produz saída.
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteApplication
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-configuration-profile
.
- AWS CLI
-
Para excluir um perfil de configuração
O
delete-configuration-profile
exemplo a seguir exclui o perfil de configuração especificado.aws appconfig delete-configuration-profile \ --application-id
339ohji
\ --configuration-profile-idur8hx2f
Este comando não produz saída.
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteConfigurationProfile
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-deployment-strategy
.
- AWS CLI
-
Para excluir uma estratégia de implantação
O
delete-deployment-strategy
exemplo a seguir exclui a estratégia de implantação especificada.aws appconfig delete-deployment-strategy \ --deployment-strategy-id
1225qzk
Este comando não produz saída.
Para obter mais informações, consulte Etapa 4: Criação de uma estratégia de implantação no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteDeploymentStrategy
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-environment
.
- AWS CLI
-
Para excluir um ambiente
O
delete-environment
exemplo a seguir exclui o ambiente de aplicativo especificado.aws appconfig delete-environment \ --application-id
339ohji
\ --environment-id54j1r29
Este comando não produz saída.
Para obter mais informações, consulte Etapa 2: Criação de um ambiente no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteEnvironment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-extension-association
.
- AWS CLI
-
Para excluir uma associação de extensão
O
delete-extension-association
exemplo a seguir exclui uma associação de extensão de AWS AppConfig.aws appconfig delete-extension-association \ --region
us-west-2
\ --extension-association-ida1b2c3d4
Este comando não produz saída.
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteExtensionAssociation
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-extension
.
- AWS CLI
-
Para excluir uma extensão
O
delete-extension
exemplo a seguir exclui uma extensão do AWS AppConfig.aws appconfig delete-extension \ --region
us-west-2
\ --extension-identifierS3-backup-extension
Este comando não produz saída.
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteExtension
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-hosted-configuration-version
.
- AWS CLI
-
Para excluir uma versão de configuração hospedada
O
delete-hosted-configuration-version
exemplo a seguir exclui uma versão de configuração hospedada no repositório de configuração AWS AppConfig hospedado.aws appconfig delete-hosted-configuration-version \ --application-id
339ohji
\ --configuration-profile-idur8hx2f
\ --version-number1
Saída: Esse comando não produz saída.
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte DeleteHostedConfigurationVersion
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-application
.
- AWS CLI
-
Para listar detalhes de um aplicativo
O
get-application
exemplo a seguir lista os detalhes do aplicativo especificado.aws appconfig get-application \ --application-id
339ohji
Saída:
{ "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" }
Para obter mais informações, consulte Como AWS AppConfig funciona no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetApplication
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-configuration-profile
.
- AWS CLI
-
Para recuperar detalhes do perfil de configuração
O
get-configuration-profile
exemplo a seguir retorna os detalhes do perfil de configuração especificado.aws appconfig get-configuration-profile \ --application-id
339ohji
\ --configuration-profile-idur8hx2f
Saída:
{ "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetConfigurationProfile
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-configuration
.
- AWS CLI
-
Para recuperar detalhes da configuração
O
get-configuration
exemplo a seguir retorna os detalhes de configuração do aplicativo de exemplo. Nas chamadas subsequentes para get-configuration, use oclient-configuration-version
parâmetro para atualizar somente a configuração do seu aplicativo se a versão tiver sido alterada. Somente atualizar a configuração quando a versão é alterada evita cobranças excessivas incorridas ao chamar get-configuration.aws appconfig get-configuration \ --application
"example-application"
\ --environment"Example-Environment"
\ --configuration"Example-Configuration-Profile"
\ --client-id"test-id"
\configuration-output-file
Conteúdo de
configuration-output-file
:{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }
Saída:
{ "ConfigurationVersion": "1", "ContentType": "application/json" }
Para obter mais informações, consulte Etapa 6: Recebendo a configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetConfiguration
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-deployment-strategy
.
- AWS CLI
-
Para recuperar detalhes de uma estratégia de implantação
O
get-deployment-strategy
exemplo a seguir lista os detalhes da estratégia de implantação especificada.aws appconfig get-deployment-strategy \ --deployment-strategy-id
1225qzk
Saída:
{ "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" }
Para obter mais informações, consulte Etapa 4: Criação de uma estratégia de implantação no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetDeploymentStrategy
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-deployment
.
- AWS CLI
-
Para recuperar detalhes da implantação
O
get-deployment
exemplo a seguir lista os detalhes da implantação no aplicativo no ambiente e na implantação especificados.aws appconfig get-deployment \ --application-id
339ohji
\ --environment-id54j1r29
\ --deployment-number1
Saída:
{ "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" }
Para obter mais informações, consulte Etapa 5: Implantação de uma configuração no Guia do AWS AppConfig usuário.
-
Para API obter detalhes, consulte GetDeployment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-environment
.
- AWS CLI
-
Para recuperar detalhes do ambiente
O
get-environment
exemplo a seguir retorna os detalhes e o estado do ambiente especificado.aws appconfig get-environment \ --application-id
339ohji
\ --environment-id54j1r29
Saída:
{ "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" }
Para obter mais informações, consulte Etapa 2: Criação de um ambiente no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetEnvironment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-extension-association
.
- AWS CLI
-
Para obter detalhes da associação de extensão
O
get-extension-association
exemplo a seguir exibe informações sobre uma associação de extensão.aws appconfig get-extension-association \ --region
us-west-2
\ --extension-association-ida1b2c3d4
Saída:
{ "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 }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetExtensionAssociation
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-extension
.
- AWS CLI
-
Para obter detalhes da extensão
O
get-extension
exemplo a seguir exibe informações sobre uma extensão.aws appconfig get-extension \ --region
us-west-2
\ --extension-identifierS3-backup-extension
Saída:
{ "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 } } }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetExtension
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-hosted-configuration-version
.
- AWS CLI
-
Para recuperar detalhes da configuração hospedada
O
get-hosted-configuration-version
exemplo a seguir recupera os detalhes da configuração AWS AppConfig hospedada.aws appconfig get-hosted-configuration-version \ --application-id
339ohji
\ --configuration-profile-idur8hx2f
\ --version-number1
\hosted-configuration-version-output
Conteúdo de
hosted-configuration-version-output
:{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }
Saída:
{ "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" }
Para obter mais informações, consulte Sobre o armazenamento de configuração AWS AppConfig hospedado no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte GetHostedConfigurationVersion
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-applications
.
- AWS CLI
-
Para listar os aplicativos disponíveis
O
list-applications
exemplo a seguir lista os aplicativos disponíveis em sua AWS conta.aws appconfig list-applications
Saída:
{ "Items": [ { "Id": "339ohji", "Name": "test-application", "Description": "An application used for creating an example." }, { "Id": "rwalwu7", "Name": "Test-Application" } ] }
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListApplications
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-configuration-profiles
.
- AWS CLI
-
Para listar os perfis de configuração disponíveis
O
list-configuration-profiles
exemplo a seguir lista os perfis de configuração disponíveis para o aplicativo especificado.aws appconfig list-configuration-profiles \ --application-id
339ohji
Saída:
{ "Items": [ { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter" } ] }
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListConfigurationProfiles
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-deployment-strategies
.
- AWS CLI
-
Para listar as estratégias de implantação disponíveis
O
list-deployment-strategies
exemplo a seguir lista as estratégias de implantação disponíveis em sua AWS conta.aws appconfig list-deployment-strategies
Saída:
{ "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" } ] }
Para obter mais informações, consulte Etapa 4: Criação de uma estratégia de implantação no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListDeploymentStrategies
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-deployments
.
- AWS CLI
-
Para listar as implantações disponíveis
O
list-deployments
exemplo a seguir lista as implantações disponíveis em sua AWS conta para o aplicativo e o ambiente especificados.aws appconfig list-deployments \ --application-id
339ohji
\ --environment-id54j1r29
Saída:
{ "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" } ] }
Para obter mais informações, consulte Etapa 5: Implantação de uma configuração no Guia do AWS AppConfig usuário.
-
Para API obter detalhes, consulte ListDeployments
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-environments
.
- AWS CLI
-
Para listar os ambientes disponíveis
O
list-environments
exemplo a seguir lista os ambientes disponíveis em sua AWS conta para o aplicativo especificado.aws appconfig list-environments \ --application-id
339ohji
Saída:
{ "Items": [ { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ] }
Para obter mais informações, consulte Etapa 2: Criação de um ambiente no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListEnvironments
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-extension-associations
.
- AWS CLI
-
Para listar todas as associações de AWS AppConfig extensão em sua AWS conta para uma AWS região
O
list-extension-associations
exemplo a seguir lista todas as associações de AWS AppConfig extensão da AWS conta atual em uma AWS região específica.aws appconfig list-extension-associations \ --region
us-west-2
Saída:
{ "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" } ] }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListExtensionAssociations
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-extensions
.
- AWS CLI
-
Para listar todas AWS AppConfig as extensões em sua AWS conta para uma AWS região
O
list-extensions
exemplo a seguir lista todas as AWS AppConfig extensões da AWS conta atual em uma AWS região específica. O comando retorna extensões personalizadas e criadas por AWS autoria.aws appconfig list-extensions \ --region
us-west-2
Saída:
{ "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." } ] }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListExtensions
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-hosted-configuration-versions
.
- AWS CLI
-
Para listar as versões de configuração hospedada disponíveis
O
list-hosted-configuration-versions
exemplo a seguir lista as versões de configuração hospedadas no repositório de configurações AWS AppConfig hospedado para o aplicativo e o perfil de configuração especificados.aws appconfig list-hosted-configuration-versions \ --application-id
339ohji
\ --configuration-profile-idur8hx2f
Saída:
{ "Items": [ { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": 1, "ContentType": "application/json" } ] }
Para obter mais informações, consulte Sobre o armazenamento de configuração AWS AppConfig hospedado no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListHostedConfigurationVersions
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar list-tags-for-resource
.
- AWS CLI
-
Para listar as tags de um aplicativo
O
list-tags-for-resource
exemplo a seguir lista as tags de um aplicativo especificado.aws appconfig list-tags-for-resource \ --resource-arn
arn:aws:appconfig:us-east-1:682428703967:application/339ohji
Saída:
{ "Tags": { "group1": "1" } }
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ListTagsForResource
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar start-deployment
.
- AWS CLI
-
Para iniciar uma implantação de configuração
O
start-deployment
exemplo a seguir inicia uma implantação no aplicativo usando o ambiente, a estratégia de implantação e o perfil de configuração especificados.aws appconfig start-deployment \ --application-id
339ohji
\ --environment-id54j1r29
\ --deployment-strategy-id1225qzk
\ --configuration-profile-idur8hx2f
\ --configuration-version1
Saída:
{ "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" }
Para obter mais informações, consulte Etapa 5: Implantação de uma configuração no Guia do AWS AppConfig usuário.
-
Para API obter detalhes, consulte StartDeployment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar stop-deployment
.
- AWS CLI
-
Para interromper a implantação da configuração
O
stop-deployment
exemplo a seguir interrompe a implantação de uma configuração de aplicativo no ambiente especificado.aws appconfig stop-deployment \ --application-id
339ohji
\ --environment-id54j1r29
\ --deployment-number2
Saída:
{ "DeploymentNumber": 0, "DeploymentDurationInMinutes": 0, "GrowthFactor": 0.0, "FinalBakeTimeInMinutes": 0, "PercentageComplete": 0.0 }
Para obter mais informações, consulte Etapa 5: Implantação de uma configuração no Guia do AWS AppConfig usuário.
-
Para API obter detalhes, consulte StopDeployment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar tag-resource
.
- AWS CLI
-
Para marcar um aplicativo
O
tag-resource
exemplo a seguir marca um recurso do aplicativo.aws appconfig tag-resource \ --resource-arn
arn:aws:appconfig:us-east-1:682428703967:application/339ohji
\ --tags '{"group1" : "1"}
'Este comando não produz saída.
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte TagResource
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar untag-resource
.
- AWS CLI
-
Para remover uma tag de um aplicativo
O
untag-resource
exemplo a seguir remove a tag group1 do aplicativo especificado.aws appconfig untag-resource \ --resource-arn
arn:aws:appconfig:us-east-1:111122223333:application/339ohji
\ --tag-keys '["group1"]
'Este comando não produz saída.
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UntagResource
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-application
.
- AWS CLI
-
Para atualizar um aplicativo
O
update-application
exemplo a seguir atualiza o nome do aplicativo especificado.aws appconfig update-application \ --application-id
339ohji
\ --name"Example-Application"
Saída:
{ "Id": "339ohji", "Name": "Example-Application", "Description": "An application used for creating an example." }
Para obter mais informações, consulte Etapa 1: Criação de um AWS AppConfig aplicativo no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UpdateApplication
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-configuration-profile
.
- AWS CLI
-
Para atualizar um perfil de configuração
O
update-configuration-profile
exemplo a seguir atualiza a descrição do perfil de configuração especificado.aws appconfig update-configuration-profile \ --application-id
339ohji
\ --configuration-profile-idur8hx2f
\ --description"Configuration profile used for examples."
Saída:
{ "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" }
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UpdateConfigurationProfile
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-deployment-strategy
.
- AWS CLI
-
Para atualizar uma estratégia de implantação
O
update-deployment-strategy
exemplo a seguir atualiza o tempo final de cozimento para 20 minutos na estratégia de implantação especificada.aws appconfig update-deployment-strategy \ --deployment-strategy-id
1225qzk
\ --final-bake-time-in-minutes20
Saída:
{ "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 20, "ReplicateTo": "SSM_DOCUMENT" }
Para obter mais informações, consulte Etapa 4: Criação de uma estratégia de implantação no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UpdateDeploymentStrategy
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-environment
.
- AWS CLI
-
Para atualizar um ambiente
O
update-environment
exemplo a seguir atualiza a descrição de um ambiente.aws appconfig update-environment \ --application-id
339ohji
\ --environment-id54j1r29
\ --description"An environment for examples."
Saída:
{ "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "Description": "An environment for examples.", "State": "RolledBack" }
Para obter mais informações, consulte Etapa 2: Criação de um ambiente no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UpdateEnvironment
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-extension-association
.
- AWS CLI
-
Para atualizar uma associação AWS AppConfig de extensão
O
update-extension-association
exemplo a seguir adiciona um novo valor de parâmetro a uma associação de extensão em AWS AppConfig.aws appconfig update-extension-association \ --region
us-west-2
\ --extension-association-ida1b2c3d4
\ --parametersS3bucket=FinanceMobileApp
Saída:
{ "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 }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UpdateExtensionAssociation
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-extension
.
- AWS CLI
-
Para atualizar uma AWS AppConfig extensão
O
update-extension
exemplo a seguir adiciona um parâmetro adicional Key a uma extensão em AWS AppConfig.aws appconfig update-extension \ --region
us-west-2
\ --extension-identifierS3-backup-extension
\ --parametersS3bucket={Required=true},CampaignID={Required=false}
Saída:
{ "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 } } }
Para obter mais informações, consulte Como trabalhar com AWS AppConfig extensões no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte UpdateExtension
na Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar validate-configuration
.
- AWS CLI
-
Para validar uma configuração
O
validate-configuration
exemplo a seguir usa os validadores em um perfil de configuração para validar uma configuração.aws appconfig validate-configuration \ --application-id
abc1234
\ --configuration-profile-idur8hx2f
\ --configuration-version1
O comando não produz nenhuma saída.
Para obter mais informações, consulte Etapa 3: Criar uma configuração e um perfil de configuração no Guia AWS AppConfig do usuário.
-
Para API obter detalhes, consulte ValidateConfiguration
na Referência de AWS CLI Comandos.
-