AWS AppConfig ejemplos que utilizan AWS CLI - AWS Command Line Interface
Acciones

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWS AppConfig ejemplos que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with AWS AppConfig.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo usar create-application.

AWS CLI

Para crear una aplicación

El siguiente create-application ejemplo crea una aplicación en AWS AppConfig.

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

Salida:

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

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte CreateApplicationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-configuration-profile.

AWS CLI

Para crear un perfil de configuración

En el siguiente create-configuration-profile ejemplo, se crea un perfil de configuración mediante una configuración almacenada en Parameter Store, una función de Systems Manager.

aws appconfig create-configuration-profile \
    --application-id "339ohji" \
    --name "Example-Configuration-Profile" \
    --location-uri "ssm-parameter://Example-Parameter" \
    --retrieval-role-arn "arn:aws:iam::111122223333:role/Example-App-Config-Role"

Salida:

{
    "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 obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar create-environment.

AWS CLI

Para crear un entorno

El siguiente create-environment ejemplo crea un AWS AppConfig entorno denominado Example-Environment mediante la aplicación que creó con create-application.

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

Salida:

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

Para obtener más información, consulte el paso 2: Creación de un entorno en la Guía del usuario.AWS AppConfig

  • Para API obtener más información, consulte CreateEnvironmentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-extension-association.

AWS CLI

Para crear una asociación de extensiones

El siguiente create-extension-association ejemplo crea una nueva asociación de extensiones en 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

Salida:

{
  "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar create-extension.

AWS CLI

Para crear una extensión

En el create-extension ejemplo siguiente se crea una nueva extensión en 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}

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte CreateExtensionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-hosted-configuration-version.

AWS CLI

Para crear una versión de configuración alojada

El siguiente create-hosted-configuration-version ejemplo crea una nueva configuración en el almacén de configuración AWS AppConfig hospedado. El contenido de la configuración debe convertirse primero a base64.

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

Contenidos de configuration_version_output_file:

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

Salida:

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

Para obtener más información, consulte Acerca del almacén de configuración AWS AppConfig hospedado en la Guía del usuario de AWS Appconfig.

En el siguiente ejemplo de código, se muestra cómo usar delete-application.

AWS CLI

Eliminación de una aplicación

En el siguiente delete-application ejemplo, se elimina la aplicación especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte DeleteApplicationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-configuration-profile.

AWS CLI

Para eliminar un perfil de configuración

En el siguiente delete-configuration-profile ejemplo, se elimina el perfil de configuración especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar delete-deployment-strategy.

AWS CLI

Para eliminar una estrategia de despliegue

En el siguiente delete-deployment-strategy ejemplo, se elimina la estrategia de despliegue especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 4: Crear una estrategia de despliegue en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar delete-environment.

AWS CLI

Para eliminar un entorno

En el siguiente delete-environment ejemplo, se elimina el entorno de aplicación especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 2: Creación de un entorno en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte DeleteEnvironmentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-extension-association.

AWS CLI

Para eliminar una asociación de extensiones

En el siguiente delete-extension-association ejemplo, se elimina una asociación de extensiones de AWS AppConfig.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar delete-extension.

AWS CLI

Para eliminar una extensión

En el siguiente delete-extension ejemplo, se elimina una extensión de AWS AppConfig.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte DeleteExtensionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-hosted-configuration-version.

AWS CLI

Para eliminar una versión de configuración alojada

En el siguiente delete-hosted-configuration-version ejemplo, se elimina una versión de configuración alojada en el almacén de configuración AWS AppConfig hospedado.

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

Resultado: este comando no produce ningún resultado.

Para obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar get-application.

AWS CLI

Para enumerar los detalles de una aplicación

En el siguiente get-application ejemplo, se muestran los detalles de la aplicación especificada.

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

Salida:

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

Para obtener más información, consulte Cómo AWS AppConfig funciona en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte GetApplicationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-configuration-profile.

AWS CLI

Para recuperar los detalles del perfil de configuración

El siguiente get-configuration-profile ejemplo devuelve los detalles del perfil de configuración especificado.

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

Salida:

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

Para obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar get-configuration.

AWS CLI

Para recuperar los detalles de configuración

El siguiente get-configuration ejemplo devuelve los detalles de configuración de la aplicación de ejemplo. En llamadas posteriores a get-configuration, utilice el client-configuration-version parámetro para actualizar la configuración de la aplicación únicamente si la versión ha cambiado. Si solo se actualiza la configuración cuando la versión ha cambiado, se evitan los cargos excesivos que se generen al llamar a get-configuration.

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

Contenidos de configuration-output-file:

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

Salida:

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

Para obtener más información, consulte el paso 6: Recibir la configuración en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte GetConfigurationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-deployment-strategy.

AWS CLI

Para recuperar los detalles de una estrategia de despliegue

En el siguiente get-deployment-strategy ejemplo, se enumeran los detalles de la estrategia de despliegue especificada.

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

Salida:

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

Para obtener más información, consulte el paso 4: Crear una estrategia de despliegue en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar get-deployment.

AWS CLI

Para recuperar los detalles de la implementación

En el siguiente get-deployment ejemplo, se enumeran los detalles de la implementación en la aplicación en el entorno y la implementación especificados.

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

Salida:

{
    "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 obtener más información, consulte el paso 5: Implementar una configuración en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte GetDeploymentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-environment.

AWS CLI

Para recuperar los detalles del entorno

El siguiente get-environment ejemplo devuelve los detalles y el estado del entorno especificado.

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

Salida:

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

Para obtener más información, consulte el paso 2: Creación de un entorno en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte GetEnvironmentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-extension-association.

AWS CLI

Para obtener los detalles de la asociación de extensiones

En el siguiente get-extension-association ejemplo, se muestra información sobre una asociación de extensiones.

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

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar get-extension.

AWS CLI

Para obtener los detalles de la extensión

En el siguiente get-extension ejemplo, se muestra información sobre una extensión.

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

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte GetExtensionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-hosted-configuration-version.

AWS CLI

Para recuperar los detalles de la configuración alojada

En el siguiente get-hosted-configuration-version ejemplo, se recuperan los detalles de configuración de la AWS AppConfig configuración alojada.

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

Contenidos de hosted-configuration-version-output:

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

Salida:

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

Para obtener más información, consulte Acerca del almacén de configuración AWS AppConfig hospedado en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar list-applications.

AWS CLI

Para ver una lista de las aplicaciones disponibles

En el siguiente list-applications ejemplo, se enumeran las aplicaciones disponibles en su AWS cuenta.

aws appconfig list-applications

Salida:

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

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte ListApplicationsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-configuration-profiles.

AWS CLI

Para ver una lista de los perfiles de configuración disponibles

El siguiente list-configuration-profiles ejemplo muestra los perfiles de configuración disponibles para la aplicación especificada.

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

Salida:

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

Para obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar list-deployment-strategies.

AWS CLI

Para enumerar las estrategias de despliegue disponibles

En el siguiente list-deployment-strategies ejemplo, se enumeran las estrategias de despliegue disponibles en su AWS cuenta.

aws appconfig list-deployment-strategies

Salida:

{
    "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 obtener más información, consulte el paso 4: Crear una estrategia de despliegue en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar list-deployments.

AWS CLI

Para ver una lista de las implementaciones disponibles

En el siguiente list-deployments ejemplo, se enumeran las implementaciones disponibles en su AWS cuenta para la aplicación y el entorno especificados.

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

Salida:

{
    "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 obtener más información, consulte el paso 5: Implementar una configuración en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte ListDeploymentsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-environments.

AWS CLI

Para ver una lista de los entornos disponibles

En el siguiente list-environments ejemplo, se enumeran los entornos disponibles en su AWS cuenta para la aplicación especificada.

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

Salida:

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

Para obtener más información, consulte el paso 2: Creación de un entorno en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte ListEnvironmentsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-extension-associations.

AWS CLI

Para ver una lista de todas las asociaciones de AWS AppConfig extensiones de una AWS región en tu AWS cuenta

En el siguiente list-extension-associations ejemplo, se enumeran todas las asociaciones de AWS AppConfig extensiones de la AWS cuenta corriente de una AWS región específica.

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

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar list-extensions.

AWS CLI

Para ver una lista AWS AppConfig de todas las extensiones de tu AWS cuenta para una AWS región

En el siguiente list-extensions ejemplo, se muestran todas las AWS AppConfig extensiones de la AWS cuenta corriente de una AWS región específica. El comando devuelve extensiones personalizadas y AWS creadas.

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

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte ListExtensionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-hosted-configuration-versions.

AWS CLI

Para ver una lista de las versiones de configuración alojada disponibles

En el siguiente list-hosted-configuration-versions ejemplo, se enumeran las versiones de configuración alojadas en el almacén de configuración AWS AppConfig hospedado para la aplicación y el perfil de configuración especificados.

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

Salida:

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

Para obtener más información, consulte Acerca del almacén de configuración AWS AppConfig hospedado en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar list-tags-for-resource.

AWS CLI

Para enumerar las etiquetas de una aplicación

En el siguiente list-tags-for-resource ejemplo, se enumeran las etiquetas de una aplicación específica.

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

Salida:

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

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar start-deployment.

AWS CLI

Para iniciar un despliegue de configuración

En el siguiente start-deployment ejemplo, se inicia una implementación en la aplicación mediante el entorno, la estrategia de implementación y el perfil de configuración especificados.

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

Salida:

{
    "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 obtener más información, consulte el paso 5: Implementar una configuración en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte StartDeploymentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar stop-deployment.

AWS CLI

Para detener el despliegue de la configuración

El siguiente stop-deployment ejemplo detiene el despliegue de una configuración de aplicación en el entorno especificado.

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

Salida:

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

Para obtener más información, consulte el paso 5: Implementar una configuración en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte StopDeploymentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar tag-resource.

AWS CLI

Para etiquetar una aplicación

El siguiente tag-resource ejemplo etiqueta un recurso de aplicación.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte TagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar untag-resource.

AWS CLI

Para eliminar una etiqueta de una aplicación

En el siguiente untag-resource ejemplo, se elimina la etiqueta group1 de la aplicación especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte UntagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-application.

AWS CLI

Para actualizar una aplicación

En el siguiente update-application ejemplo, se actualiza el nombre de la aplicación especificada.

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

Salida:

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

Para obtener más información, consulte el paso 1: Crear una AWS AppConfig aplicación en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte UpdateApplicationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-configuration-profile.

AWS CLI

Para actualizar un perfil de configuración

El siguiente update-configuration-profile ejemplo actualiza la descripción del perfil de configuración especificado.

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

Salida:

{
    "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 obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar update-deployment-strategy.

AWS CLI

Para actualizar una estrategia de despliegue

En el siguiente update-deployment-strategy ejemplo, se actualiza el tiempo de horneado final a 20 minutos en la estrategia de despliegue especificada.

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

Salida:

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

Para obtener más información, consulte el paso 4: Crear una estrategia de despliegue en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar update-environment.

AWS CLI

Para actualizar un entorno

El siguiente update-environment ejemplo actualiza la descripción de un entorno.

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

Salida:

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

Para obtener más información, consulte el paso 2: Creación de un entorno en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte UpdateEnvironmentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-extension-association.

AWS CLI

Para actualizar una asociación AWS AppConfig de extensiones

El siguiente update-extension-association ejemplo agrega un nuevo valor de parámetro a una asociación de extensiones en AWS AppConfig.

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

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

En el siguiente ejemplo de código, se muestra cómo usar update-extension.

AWS CLI

Para actualizar una AWS AppConfig extensión

En el siguiente update-extension ejemplo, se agrega una clave de parámetro adicional a una extensión en AWS AppConfig.

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

Salida:

{
    "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 obtener más información, consulte Trabajar con AWS AppConfig extensiones en la Guía del AWS AppConfig usuario.

  • Para API obtener más información, consulte UpdateExtensionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar validate-configuration.

AWS CLI

Para validar una configuración

En el siguiente validate-configuration ejemplo, se utilizan los validadores de un perfil de configuración para validar una configuración.

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

El comando no produce ningún resultado.

Para obtener más información, consulte el paso 3: Crear una configuración y un perfil de configuración en la Guía del AWS AppConfig usuario.