Lumberyard
Guía del usuario (Version 1.21)

Uso de la línea de comando en Cloud Canvas

Cloud Canvas proporciona la herramienta de línea de comandos \dev\lmbr_aws.cmd para trabajar con los recursos de AWS. La herramienta llama al código Python que se encuentra en el directorio \dev\Tools\lmbr_aws.

Notas

Sintaxis

lmbr_aws {command} {command-arguments}

{comando} es uno de los comandos de la sección de resumen de comandos siguiente. {argumentos-comando} son los argumentos que acepta el comando. Los argumentos comunes para la mayoría de los comandos se enumeran en la sección Argumentos comunes. Los argumentos exclusivos de un comando se enumeran en la sección de detalles del comando.

Configuración

La herramienta obtiene la configuración predeterminada de AWS a partir de los mismos archivos ~/.aws/credentials y ~/.aws/config que las herramientas de línea de comandos de AWS (para obtener más información, consulte Configuración de AWS Command Line Interface). La herramienta lmbr_aws no requiere que esté instalada la interfaz de línea de comandos de AWS.

Variables de entorno

Al igual que sucede con las herramientas de línea de comandos de AWS, la configuración predeterminada de AWS se puede anular con las siguientes variables de entorno.

  • AWS_ACCESS_KEY_ID La clave de acceso de la cuenta de AWS.

  • AWS_SECRET_ACCESS_KEY La clave de acceso secreta de la cuenta de AWS.

  • AWS_DEFAULT_REGION La región predeterminada que se va a usar, por ejemplo, us-east-2.

  • AWS_PROFILE El perfil de configuración y la credencial predeterminados que se van a utilizar, si procede.

Argumentos de configuración

Los siguientes argumentos se pueden utilizar para anular la configuración de AWS de los demás orígenes:

  • --assume-role{role-name} o -R {role-name}: especifica el rol de IAM que se asume para llevar a cabo las acciones solicitadas. Las credenciales del archivo ~/.aws/credentials deben poder asumir el rol que se especifica.

  • --aws-access-key {access-key}: la clave de acceso de AWS que se utiliza.

  • --aws-secret-key {secret-key}: la clave de acceso secreta de AWS que se utiliza.

  • --profile {profile-name} o -P {profile-name}: el perfil de la herramienta de línea de comandos de AWS que se utiliza.

Argumentos comunes

La mayoría de los comandos lmbr_aws aceptan los siguientes argumentos, además de los suyos propios:

  • --aws-directory {aws}: identifica el directorio {game}\AWS que se va a usar. El valor predeterminado es el valor de la propiedad sys_game_folder de {root}\bootstrap.cfg con AWS adjunto.

  • --game-directory {directory}: ubicación del directorio del proyecto de juego. El valor predeterminado es {root}\{game} donde {juego} lo determina el valor sys_game_folder del archivo {root}\bootstrap.cfg.

  • --help o -h: muestra ayuda para el comando.

  • --no-prompt: suprime las llamadas que solicitan entradas desde la ventana de símbolo del sistema.

  • --region-override {AWS_region}: especifica una región no predeterminada de AWS que se va a usar en su archivo local-project-settings.json.

    --root-directory {root}: identifica el directorio instalación_lumberyard\dev. El valor predeterminado es el directorio de trabajo actual.

  • --user-directory {user}: ubicación del directorio de la memoria caché del usuario. El valor predeterminado es {root}\Cache\{game}\AWS donde {juego} lo determina el valor sys_game_folder del archivo {root}\bootstrap.cfg.

  • --verbose: muestra el resultado adicional cuando se ejecutan comandos.

Comandos

Estos son los comandos de lmbr_aws.

Comandos de cloud-gem

Los comandos de lmbr_aws cloud-gem para crear, habilitar y deshabilitar gemas en la nube.

cloud-gem create

Cree una gema en la nube. Este comando es nuevo en Lumberyard 1.11.

Además de Argumentos comunes, el comando cloud-gem create acepta los siguientes argumentos:

  • --directory {path}

    Opcional. El directorio donde se ha creado la gema. El predeterminado es \dev\Gems\{name}\v{N}, donde {nombre} es el nombre que ha especificado mediante la opción --gem y {N} es la parte principal del número de versión de la gema que especifica la opción --version.

  • --enable

    Opcional. Habilite la gema para el proyecto actual al crearla. De forma predeterminada, la gema no está habilitada cuando se crea.

  • --gem {name}

    Obligatorio. Nombre de la gema que se va a crear.

  • --initial-content {initial-content-type}

    Opcional. Inicialice el directorio AWS de la gema en la nube con el contenido que especifique {initial-content-type}.

    Estos son los posibles valores de {initial-content-type}.

    nota

    Antes de usar las opciones de contenido de api, realice una de las siguientes opciones:

    • En Lumberyard Setup Assistant, elija Compile the game code (Compilar el código de juego).

    • Escriba el siguiente comando en el directorio \dev\Tools\LmbrSetup\Win desde una ventana de símbolo del sistema:

      lmbr capabilities enable compilegame
    • api-lambda

      Defina un grupo de recursos con recursos de funciones Amazon API Gateway y AWS Lambda que se ajusten al patrón de la API de servicio de Cloud Gem Framework. Puede añadir los recursos de AWS que sean necesarios.

    • api-lambda-bucket

      Defina un grupo de recursos con recursos de funciones API Gateway y Lambda que se ajusten al patrón de la API de servicio de Cloud Gem Framework. También crea un recurso de bucket de Amazon S3.

    • api-lambda-dynamodb

      Defina un grupo de recursos con recursos de funciones API Gateway y Lambda que se ajusten al patrón de la API de servicio de Cloud Gem Framework. También crea un recurso de tabla de Amazon DynamoDB.

    • bucket

      Define un grupo de recursos que tiene un recurso de bucket de Amazon S3.

    • lambda

      Define un grupo de recursos que tiene un recurso de función de Lambda.

    • no-resources

      Define un grupo de recursos que no tiene recursos (excepto AccessControl, que es necesario). Este es el valor predeterminado.

    • resource-manager-plugin

      Defina un plugin del administrador de recursos.

  • --no-cpp-code

    Opcional. Defina una gema que no contenga ningún código C++ y no se compile como un archivo .dll. La gema puede contener definiciones de grupos de recursos o plugins del administrador de recursos.

  • --version {version}

    Opcional. Establezca la versión de la gema en el número especificado por {version}. El valor predeterminado es 1.0.0. El número de versión debe tener el formato {number}.{number}.{number}.

cloud-gem disable

Deshabilite una gema en la nube que se encuentre en el proyecto actual. Este comando es nuevo en Lumberyard 1.11.

Además de Argumentos comunes, el comando cloud-gem disable acepta los siguientes argumentos:

  • --gem {name}

    Obligatorio. El nombre de la gema que se va a deshabilitar.

cloud-gem enable

Habilite una gema en la nube que se encuentre en el proyecto actual. Este comando es nuevo en Lumberyard 1.11.

Además de Argumentos comunes, el comando cloud-gem enable acepta los siguientes argumentos:

  • --gem {name}

    Obligatorio. El nombre de la gema que se va a habilitar.

cloud-gem-tts import-tts-zip

Importe paquetes de voz generados desde el servicio Cloud Gem Text-to-Speech en un proyecto. Este comando es nuevo en Lumberyard 1.11.

Además de Argumentos comunes, el comando cloud-gem-tts import-tts-zip acepta los siguientes argumentos:

  • --download-path {zip-path}

    Obligatorio. La ruta completa a un archivo .zip que se ha descargado del portal Text-to-Speech Cloud Gem.

  • --import-as-wav

    Opcional. Convierte archivos de audio al formato de archivo .wav cuando se extraen.

Para obtener más información acerca de la descarga y la importación de archivos de voz, consulte Cloud Gem Portal de conversión de texto a voz.

Comandos de deployment

Los comandos de lmbr_aws deployment administran las implementaciones de Cloud Canvas.

nota

En Lumberyard 1.16 y versiones posteriores, los comandos de deployment instalan, modifican o eliminan gemas en serie en lugar de en paralelo. Esto evita los problemas que pueden producirse en AWS cuando se crean, actualizan o eliminan al mismo tiempo varios grupos de recursos.

Este comportamiento predeterminado se puede anular con la opción --parallel, como en los siguientes ejemplos:

lmbr_aws deployment create --deployment deployment_name --parallel lmbr_aws deployment update --parallel lmbr_aws deployment delete --deployment deployment_name --parallel

aviso

Dado que aumenta en gran medida el riesgo de errores al modificar su implementación, no se recomienda el uso de la opción --parallel.

deployment create

Cree una copia independiente y completa de todos los recursos que necesita el proyecto de Lumberyard.

Además de Argumentos comunes, el comando deployment create acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Obligatorio. El nombre de la implementación que se creará.

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que el comando deployment create creará los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

deployment default

Establece o muestra el valor predeterminado del usuario y las implementaciones del proyecto.

Además de Argumentos comunes, el comando deployment default acepta los siguientes argumentos:

  • --set {deployment}

    Opcional. Establece el valor predeterminado del nombre de la implementación proporcionado.

  • --clear

    Opcional. Elimina los valores predeterminados.

  • --show

    Opcional. Muestra los valores predeterminados.

  • --project

    Opcional. Aplica --set y --clear al valor predeterminado del proyecto, en lugar de aplicarlo al usuario predeterminado. Se pasa por alto para --show.

    Solo se permite uno de los argumentos --set, --clear y --show.

    Si se especifica --set o --clear, este comando actualiza el archivo {root}\user\AWS\user-settings.json. Si se proporciona --project, el archivo {root}\{game}\AWS\project-settings.json se actualiza.

deployment delete

Elimina una copia independiente y completa de todos los recursos que necesita el proyecto de Lumberyard .

Además de Argumentos comunes, el comando deployment delete acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Obligatorio. El nombre de la implementación que se eliminará.

  • --confirm-resource-deletion

    Opcional. Confirma que el comando eliminará permanentemente los recursos para la implementación especificada. Si este argumento no se especifica, se emite un mensaje de confirmación.

nota

AWS CloudFormation no puede eliminar pilas que definan buckets de Amazon S3 que contienen datos. Para permitir la eliminación de las pilas de un proyecto, el archivo project-template.json especifica DeletionPolicy de Retain para el bucket de configuración. Esto hace que AWS CloudFormation no elimine el bucket cuando se elimina la pila del proyecto. Una vez eliminada la pila del proyecto, el comando elimina todos los objetos del bucket de configuración y, a continuación, elimina el bucket.

deployment list

Enumera todas las implementaciones del proyecto local.

Ejemplo del resultado:

Name Status Reason Timestamp Id ----------------- --------------- ---------------------------------------------------------------------------- ----------------- -------------------------------------------------------------------------------------------------------------------------- AnotherDeployment CREATE_PENDING Resource is defined in the local project template but does not exist in AWS. Development CREATE_COMPLETE 03/04/16 18:43:11 arn:aws:cloudformation:us-east-2:<ACCOUNTID>:stack/foo-hw-Development-ZDLXUB7FKR94/8e6492f0-e248-11e5-8e7e-50d5ca6e60ae User Default Deployment: (none) Project Default Deployment: Development Release Deployment: (none)

deployment list-resources

Enumera todos los recursos asociados con el proyecto.

Además de Argumentos comunes, el comando deployment list-resources acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación para la que se enumeran los recursos. Si no especifica, se enumeran todos los recursos del proyecto.

deployment protect

Marca una implementación como protegida y emite una advertencia cuando un usuario (por ejemplo, un desarrollador de juegos, un programador o un probador) intenta conectar un cliente de juego de desarrollo a los recursos activos. Para obtener más información, consulte Uso de implementaciones protegidas .

Además de Argumentos comunes, el comando deployment protect acepta los siguientes argumentos:

  • --set {deployment-name}

    Opcional. Especifica que la implementación está protegida.

  • --clear {deployment-name}

    Opcional. Especifica que la implementación no está protegida.

  • --show

    Opcional. Muestra una lista de las implementaciones actualmente protegidas.

    nota

    Para mostrar el estado protegido de las implementaciones, también puede usar el comando deployment list o mappings list.

deployment release

Establece, muestra o elimina la implementación de lanzamiento.

Además de Argumentos comunes, el comando deployment release acepta los siguientes argumentos:

  • --set {deployment-name}

    Obligatorio. El nombre de la implementación que se establece como implementación de lanzamiento

  • --clear

    Elimina la designación de lanzamiento de la implementación de lanzamiento actual.

  • --show

    Muestra la implementación que está actualmente configurada como la implementación de lanzamiento.

etiquetas de implementación

Administra las etiquetas de una implementación. Las etiquetas de implementación especifican anulaciones de grupos de recursos para una implementación.

Además de Argumentos comunes, el comando deployment tags acepta los siguientes argumentos:

  • --add {etiqueta} [{etiqueta} ...]

    Opcional. Especifica las etiquetas que se van a añadir a una implementación. Las etiquetas se guardan en el archivo lumberyard_version\dev\project_name\AWS\local-project-settings.json.

  • --clear

    Opcional. Borra todas las etiquetas de una implementación.

  • --delete {etiqueta} [{etiqueta} ...]

    Opcional. Especifica las etiquetas que se van a eliminar de una implementación.

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación.

  • --list

    Opcional. Enumera todas las etiquetas de una implementación.

deployment update-access

Establece, muestra o elimina la implementación de lanzamiento.

Además de Argumentos comunes, el comando deployment update-access acepta los siguientes argumentos:

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que este comando crea los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-resource-deletion

    Opcional. Si la operación elimina los recursos de forma permanente, confirme su confirmación y aprobación. Si no se especifica este argumento, se pedirá que confirme la finalización de la operación. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-security-change

    Opcional. Confirma que sabe que este comando puede hacer cambios relacionados con la seguridad. Especifique este argumento para deshabilitar la petición de confirmación.

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación cuya pila de acceso se ha actualizado. Si se omite, se actualiza la implementación predeterminada. Utilice* para actualizar todas las implementaciones.

deployment update, deployment upload, deployment upload-resources

Actualiza una implementación. Se puede usar deployment upload o deployment upload-resources en lugar de deployment update.

Además de Argumentos comunes, el comando deployment update acepta los siguientes argumentos:

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que este comando crea los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-resource-deletion

    Opcional. Si la operación elimina los recursos de forma permanente, confirme su confirmación y aprobación. Si no se especifica este argumento, se pedirá que confirme la finalización de la operación. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-security-change

    Opcional. Confirma que sabe que este comando puede hacer cambios relacionados con la seguridad. Especifique este argumento para deshabilitar la petición de confirmación.

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación que se actualiza. Si se omite, se actualiza la implementación predeterminada.

Comandos de function

Los comandos lmbr_aws function administran carpetas, registros de CloudWatch y el código de las funciones Lambda.

function create-folder

Vuelve a crear la carpeta de función predeterminada para un recurso de la función Lambda.

Además de Argumentos comunes, el comando function create-folder acepta los siguientes argumentos:

  • --function {function-name} o bien -f {function-name}

    Obligatorio. El nombre lógico de una función de recurso Lambda.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. El nombre de un grupo de recursos.

  • --force

    Opcional. Omite las comprobaciones de la existencia del recurso y el tipo de recurso. Se utiliza al crear carpetas para funciones que aún no se han creado.

function get-log

Recupera datos de un archivo de registro de CloudWatch Logs.

Además de Argumentos comunes, el comando function get-log acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de una implementación. Si se especifica este argumento, el argumento --resource-group también se debe especificar. Si falta este argumento, la función debe existir en la pila del proyecto.

  • --function {function-name} o bien -f {function-name}

    Obligatorio. El nombre lógico de una función de recurso Lambda.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Opcional. El nombre de un grupo de recursos. Si se especifica, el argumento --deployment también se debe especificar.

  • --log-stream-name {log-stream-name} o bien -l {log-stream-name}

    Opcional. El nombre del flujo de registro o el nombre del flujo de registro parcial. Si se omite, se muestra el flujo más reciente.

función upload-code

Actualiza funciones Lambda para una implementación o proyecto.

Además de Argumentos comunes, el comando function upload-code acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de una implementación que se va a actualizar. Si no se especifica este argumento ni el argumento --project, se actualiza la implementación predeterminada. Si se especifica el argumento --project, se omite el argumento --deployment.

  • --function {function-name}

    Opcional. El nombre de la función Lambda que se actualizará. Si no se especifica, se actualizan todas las funciones Lambda especificadas en el grupo de recursos.

  • --keep

    Opcional. Mantenga el archivo .zip generado en lugar de eliminarlo después de que se haya cargado.

  • --project

    Opcional. Actualiza el proyecto. Anula el argumento --deployment.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Opcional. El nombre de un grupo de recursos que tiene la función que se va a actualizar.

Comandos de login-provider

Los comandos lmbr_aws login-provider añaden, eliminan y actualizan proveedores de inicio de sesión en redes sociales en la configuración de grupos de identidad de Amazon Cognito.

login-provider add

Agrega un proveedor de inicio de sesión del jugador a la configuración del grupo de identidades de Amazon Cognito. Los proveedores de inicio de sesión permiten a los jugadores del juego iniciar sesión con la identidad que emplean en las redes sociales, como Facebook, o con su identidad de Amazon. Para obtener más información, consulte Control del acceso a los recursos.

Además de Argumentos comunes, el comando login-provider add acepta los siguientes argumentos:

  • --provider {provider-name}

    Obligatorio. El nombre del proveedor. El nombre debe ser amazon, google o facebook o, si utiliza un proveedor de OpenID genérico, un nombre de su elección.

  • --app-id {application-id}

    Obligatorio. El ID de aplicación del proveedor de inicio de sesión (este suele ser distinto del ID de cliente).

  • --client-id {client-id}

    Obligatorio. El ID de cliente de aplicación exclusivo para el proveedor de inicio de sesión.

  • --client-secret {client-secret}

    Obligatorio. La clave secreta que se utiliza con el proveedor de inicio de sesión.

  • --redirect-uri {redirect-uri}

    Obligatorio. El URI de redireccionamiento que se utiliza con el proveedor de inicio de sesión.

  • --provider-uri {provider-uri}

    Opcional. El URI de un proveedor de conexión de ID abierto genérico. Esto solo se utiliza con proveedores de OpenID genéricos.

  • --provider-port {provider-port}

    Opcional. El puerto de escucha del proveedor para su API. Esto solo se utiliza con proveedores de OpenID genéricos.

  • --provider-path {provider-path}

    Opcional. La parte de la ruta del URI del proveedor. Esto solo se utiliza con proveedores de OpenID genéricos.

    Este comando guarda la configuración en un objeto player-access/auth-settings.json en el bucket de configuración del proyecto para que la función Lambda de PlayerAccessTokenExchange tenga acceso a ella.

    nota

    Debe ejecutar project upload después de ejecutar este comando para que la configuración PlayerAccessIdentityPool se actualice y refleje el cambio.

login-provider remove

Elimina un proveedor de inicio de sesión del jugador de la configuración del grupo de identidades de Amazon Cognito.

Además de Argumentos comunes, el comando login-provider remove acepta el argumento siguiente:

  • --provider {provider-name}

    Obligatorio. El nombre del proveedor.

    El comando login-provider remove guarda la configuración en un objeto /player-access/auth-settings.json en el bucket de configuración del proyecto para que la función Lambda de PlayerAccessTokenExchange tenga acceso a ella.

    nota

    Debe ejecutar lmbr_aws project upload después de ejecutar este comando para que la configuración PlayerAccessIdentityPool se actualice y refleje el cambio.

login-provider update

Actualiza un proveedor de inicio de sesión del jugador en la configuración del grupo de identidades de Amazon Cognito. Los proveedores de inicio de sesión permiten a los jugadores del juego iniciar sesión con la identidad que emplean en las redes sociales, como Facebook, o con su identidad de Amazon. Para obtener más información, consulte Control del acceso a los recursos.

Además de Argumentos comunes, el comando login-provider update acepta los siguientes argumentos:

  • --provider {provider-name}

    Obligatorio. Nombre del proveedor actualizado. El nombre debe ser amazon, google o facebook o bien, si utiliza un proveedor de OpenID genérico, un nombre de su elección cuando agrega el proveedor.

  • --app-id {application-id}

    Opcional. El ID de aplicación del proveedor de inicio de sesión (este suele ser distinto del ID de cliente).

  • --client-id {client-id}

    Opcional. El ID de cliente de aplicación exclusivo para el proveedor de inicio de sesión.

  • --client-secret {client-secret}

    Opcional. La clave secreta que se utiliza con el proveedor de inicio de sesión.

  • --redirect-uri {redirect-uri}

    Opcional. El URI de redireccionamiento que se utiliza con el proveedor de inicio de sesión.

  • --provider-uri {provider-uri}

    Opcional. El URI de un proveedor de conexión de ID abierto genérico. Este argumento solo se utiliza con proveedores de OpenID genéricos.

  • --provider-port {provider-port}

    Opcional. El puerto en el que el proveedor escucha a la API del proveedor. Este argumento solo se utiliza con proveedores de OpenID genéricos.

  • --provider-path {provider-path}

    Opcional. La parte de la ruta del URI del proveedor. Este argumento solo se utiliza con proveedores de OpenID genéricos.

    El comando login-provider update guarda la configuración en un objeto /player-access/auth-settings.json en el bucket de configuración del proyecto para que la función Lambda de PlayerAccessTokenExchange tenga acceso a ella.

    nota

    Debe ejecutar lmbr_aws project upload después de ejecutar este comando para que la configuración PlayerAccessIdentityPool se actualice y refleje el cambio.

Comandos de mappings

Los comandos lmbr_aws mappings administran los mapeos de nombres de recursos lógicos a físicos en una implementación de Cloud Canvas.

mappings list

Muestra los mapeos de nombre de recurso lógico a físico.

Ejemplo del resultado:

Name Type Id --------------------------------------- --------------------------- ---------------------------------------------------------------- HelloWorld.SayHello AWS::Lambda::Function foo-hw-Development-ZDLXUB7FKR94-HelloWo-SayHello-1FADMFNE5M1CO PlayerAccessIdentityPool Custom::CognitoIdentityPool us-east-2:108f6d6a-f929-4212-9947-a03269b9582e PlayerLoginIdentityPool Custom::CognitoIdentityPool us-east-2:3020e175-0ddd-4860-8dad-1db57162cbb2 PlayerAccessTokenExchange AWS::Lambda::Function foo-hw-PlayerAccessTokenExchange-1BG6JJ94IZAUV account_id Configuration <ACCOUNTID> region Configuration us-east-2

mappings update

Actualiza el nombre fácil de recordar de los mapeos de ID de los recursos físicos para la implementación predeterminada actual o la implementación de lanzamiento.

Además de Argumentos comunes, el comando mappings update acepta los siguientes argumentos:

  • --release

    Opcional. Causa que se actualicen los mapeos de la versión de lanzamiento. De forma predeterminada, solo se actualizan los mapeos que se utilizan cuando se lanza el juego desde el editor.

    El comando busca en el archivo resource-template.json las propiedades Metadata.CloudCanvas.PlayerAccess sobre definiciones de recursos. Después, consulta en AWS CloudFormation los nombres físicos de esos recursos en la implementación predeterminada actual. Si el argumento --release se especifica, se consulta la implementación de lanzamiento.

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. Exporta archivos de mapeo de cliente y servidor para la implementación especificada al directorio \dev\project_name\Config en el formato {deployment_name}.player.awsLogicalMappings.json y {deployment_name}.server.awsLogicalMappings.json. El argumento {deployment-name} es obligatorio y distingue entre mayúsculas y minúsculas.

    Cuando ejecuta un lanzador de juego como el de dev\Bin64vcNNN\CloudGemSamplesLauncher.exe, puede utilizar el argumento -cc_override_resource_map {mappings-name} para elegir el mapeo. Para obtener más información, consulte Selección de una implementación con un iniciador de PC.

Comandos de parameter

Los comandos de lmbr_aws parameter administran los parámetros de las implementaciones y los grupos de recursos de Cloud Canvas.

parameter clear

Borra la configuración de los parámetros especificada para el proyecto. El proyecto se debe haber inicializado para eliminar los parámetros (es decir, se debe haber creado una pila de proyecto).

Además de Argumentos comunes, el comando parameter clear acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. Borra el valor del parámetro de la implementación específica. {deployment-name} puede ser *, en cuyo caso se elimina el valor de parámetro utilizado en todas las implementaciones que no reemplazan el valor. Si se omite, se elimina el valor de parámetro de todas las implementaciones, incluyendo *.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Opcional. Borra el valor del parámetro del grupo de recursos específico. {resource-group-name} puede ser *, en cuyo caso se elimina el valor de parámetro utilizado en todos los grupos de recursos que no reemplazan el valor. Si se omite, se elimina el valor del parámetro de todos los grupos de recursos, incluyendo *.

  • --parameter {parameter-name} o bien -p {parameter-name}

    Obligatorio. El parámetro que se va a eliminar.

parameter list

Proporciona los parámetros configurados en la actualidad para su proyecto. El proyecto se debe haber inicializado (es decir, se debe haber creado una pila de proyecto) para enumerar los parámetros.

Además de Argumentos comunes, el comando parameter list acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Obligatorio. Limita la lista a la implementación especificada. {deployment-name} puede ser *, en cuyo caso se enumeran los parámetros que se aplican a todas las implementaciones.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. Limita la lista al grupo de recursos especificado. {resource-group-name} puede ser *, en cuyo caso se enumeran los parámetros que se aplican a todos los grupos de recursos.

  • --parameter {parameter-name} o bien -p {parameter-name}

    Opcional. Limita la lista a los parámetros especificados.

parameter set

Establece la configuración de parámetros de su proyecto El proyecto debe haberse inicializado (es decir, se debe haber creado una pila de proyecto) antes de establecer los parámetros.

Además de Argumentos comunes, el comando parameter set acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Obligatorio. Establece el valor del parámetro de la implementación específica. {deployment-name} puede ser *, en cuyo caso se utiliza el valor del parámetro en todas las implementaciones que no reemplazan el valor.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. Establece el valor del parámetro del grupo de recursos específico. {resource-group-name} puede ser *, en cuyo caso se utiliza el valor del parámetro en todos los grupos de recursos que no reemplazan el valor.

  • --parameter {parameter-name} o bien -p {parameter-name}

    Obligatorio. Especifica el parámetro cuyo valor se va a configurar.

  • --value {parameter-value} o bien -v {parameter-value}

    Obligatorio. Especifica el valor que se va a establecer.

Comandos de profile

Los comandos de lmbr_aws profile administran los perfiles de AWS que se utilizan para Cloud Canvas.

profile add

Añade un perfil de AWS a la configuración de la herramienta de línea de comandos de AWS.

Además de Argumentos comunes, el comando profile add acepta los siguientes argumentos:

  • --aws-access-key{accesskey}

    Obligatorio. La clave de acceso de AWS asociada al perfil añadido.

  • --aws-secret-key{secretkey}

    Obligatorio. La clave secreta de AWS asociada al perfil añadido.

  • --profile {profile-name} o bien -P {profile-name}

    Obligatorio. El nombre del perfil de AWS que se va a añadir.

  • --make-default

    Opcional. Hacer que el nuevo perfil sea el predeterminado.

profile default

Establece, borra o muestra el perfil predeterminado de AWS. El comando profile default modifica la sección DefaultProfile del archivo user-settings.json. A partir de Lumberyard 1.15, la herramienta de limpieza de Cloud Canvas utiliza esta configuración para determinar el perfil de AWS que se va a utilizar.

Además de Argumentos comunes, el comando profile default acepta los siguientes argumentos:

  • --set {profile-name}

    Opcional. Establezca el perfil predeterminado de la implementación actual en el nombre de perfil de AWS proporcionado.

  • --clear

    Opcional. Elimina el perfil predeterminado.

  • --show

    Opcional. Muestra el perfil predeterminado.

profile list

Enumera los perfiles de AWS que se han configurado.

profile remove

Elimina un perfil de AWS de la configuración de línea de comandos de AWS.

Además de Argumentos comunes, el comando profile remove acepta el argumento siguiente:

  • --profile {profile-name} o bien -P {profile-name}

    Obligatorio. El nombre del perfil de AWS que se va a eliminar.

profile rename

Asigna un nombre a un perfil de AWS en la configuración de la herramienta de línea de comandos de AWS.

Además de Argumentos comunes, el comando profile rename acepta los siguientes argumentos:

  • --old {old-profile-name}

    Obligatorio. El nombre del perfil de AWS que se va a cambiar.

  • --new {new-profile-name}

    Obligatorio. El nombre nuevo del perfil de AWS.

profile update

Actualiza un perfil de AWS.

Además de Argumentos comunes, el comando profile update acepta los siguientes argumentos:

  • --aws-access-key{accesskey}

    Opcional. La clave de acceso de AWS asociada al perfil actualizado. El valor predeterminado es no cambiar la clave de acceso de AWS asociada con el perfil.

  • --aws-secret-key{secretkey}

    Opcional. La clave secreta de AWS asociada al perfil actualizado. El valor predeterminado es no cambiar la clave secreta de AWS asociada con el perfil.

  • --profile {profilename} o bien -P {profile-name}

    Obligatorio. El nombre del perfil de AWS que se va a actualizar.

nota

Para convertir un perfil existente en el predeterminado, utilice el comando profile default -set {profile-name}.

Comandos de project

Los comandos de lmbr_aws project administran proyectos de Cloud Canvas en Lumberyard.

project create

Inicialice el administrador de recursos de Cloud Canvas para un proyecto de Lumberyard. Esto incluye la creación de un conjunto de Definiciones de recursos predeterminado en el directorio dev\game\AWS y una pila de AWS CloudFormation que contiene los recursos que el administrador de recursos de Cloud Canvas usa para administrar los recursos del juego.

Además de Argumentos comunes, el comando project create acepta los siguientes argumentos:

  • --stack {stack-name}

    Opcional. El nombre usado para la pila AWS CloudFormation del proyecto. El valor predeterminado es el nombre del directorio {game}.

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que este comando creará los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

  • --files-only

    Opcional. Escribe los datos de configuración predeterminada en el directorio {game}\AWS y sale. El directorio debe estar vacío o no debe existir.

  • --region {region}

    Obligatorio. La región de AWS en la se creará la pila del proyecto.

    nota

    El argumento region solo puede utilizarse con los comandos project create y resource-importer list-importable-resources. Para anular manualmente la región de AWS en otros comandos lmbr_aws, utilice el argumento --region-override.

Funcionamiento de project create

El comando project create realiza las siguientes tareas:

  1. Crea la pila de AWS CloudFormation del proyecto usando una plantilla de arranque que solo define el recurso Bucket de configuración.

  2. Carga el archivo project-template.json y el contenido comprimido del subdirectorio project-code en Bucket de configuración.

  3. Utiliza el archivoproject-template.json cargado para realizar una operación de actualización de la pila de AWS CloudFormation. El archivo project-code.zip se utiliza para crear los recursos de funciones Lambda que se definen en el archivo project-template.json.

nota

  • Si el directorio {root}\{game}\AWS está vacío o no existe, project create lo crea si es necesario y copia el contenido del directorio dev\Tools\lmbr_aws\AWSResourceManager\default-project-content en dicho directorio.

  • project create da error si una pila con el nombre especificado ya existe en la cuenta y región de AWS configuradas. En este caso, puede utilizar el --stack argumento para especificar otro nombre para la pila del proyecto.

  • project create da error si el archivo dev\{game}\AWS\local-project-settings.json tiene una propiedad ProjectStackId que no está vacía. Inicialmente, la propiedad ProjectStackId no está presente en el archivo local-project-settings.json. Después de crear la pila del proyecto en el paso 1, la propiedad ProjectStackId se escribe en el archivo y es el ID de la pila de AWS CloudFormation del proyecto.

  • Si el proceso de actualización de la pila del paso 2 da error en el primer intento, puede volver a intentarlo utilizando el comando project upload.

project create-extension-template

Crea una plantilla de extensión para agregar recursos de proyecto, implementación o acceso a la implementación que complementan los archivos project-template.json, deployment-template.json o deployment-access-template.json existentes.

Además de Argumentos comunes, el comando project create-extension-template acepta los siguientes argumentos:

  • --project

    Opcional. Crea un archivo project-template-extensions.json en el directorio del proyecto.

  • --deployment

    Opcional. Crea un archivo deployment-template-extensions.json en el directorio del proyecto.

  • --deployment-access

    Opcional. Crea un archivo deployment-access-template-extensions.json en el directorio del proyecto.

project delete

Elimina la pila de AWS CloudFormation que contiene los recursos del proyecto. Debe eliminar todas las implementaciones del proyecto para eliminar la pila del proyecto. Después de eliminar la pila del proyecto, debe crear una pila nueva para poder utilizar el administrador de recursos de AWS CloudFormation en el proyecto.

Además de Argumentos comunes, el comando project delete acepta el argumento siguiente:

  • --confirm-resource-deletion

    Opcional. Confirma que da su confirmación y aprobación para que la operación elimine los recursos de forma permanente. Si no se especifica este argumento, se le pedirá que confirme la finalización de la operación. Especifique este argumento para deshabilitar la petición de confirmación.

    AWS CloudFormation no puede eliminar pilas que definan buckets de Amazon S3 que contienen datos. Para permitir la eliminación de las pilas de un proyecto, el archivo project-template.json especifica DeletionPolicy de Retain para el bucket de configuración. Esto hace que AWS CloudFormation no elimine el bucket cuando se elimina la pila del proyecto. Una vez eliminada la pila del proyecto, el comando elimina todos los objetos del bucket de configuración y, a continuación, elimina el bucket.

nota

Antes de usar el comando project delete, asegúrese de que las credenciales de AWS predeterminadas especificadas por el archivo ~/.aws/credentials en el sistema de archivos local son las mismas que las credenciales que se especifican en Credentials Manager (Administrador de credenciales) de Cloud Canvas. Si las credenciales no son iguales, el proyecto podría no eliminarse correctamente. Puede utilizar la herramienta de limpieza de Cloud Canvas para eliminar los recursos huérfanos después de la eliminación fallida de la pila del proyecto.

project list-resources

Enumera todos los recursos asociados con el proyecto.

project update, project upload

Actualice la pila de AWS CloudFormation del proyecto. project upload puede utilizarse en lugar de project update.

Además de Argumentos comunes, el comando project update acepta los siguientes argumentos:

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que este comando creará los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-resource-deletion

    Opcional. Si la operación elimina los recursos de forma permanente, confirme su confirmación y aprobación. Si no se especifica este argumento, se pedirá que confirme la finalización de la operación. Especifique este argumento para deshabilitar la petición de confirmación.

Funcionamiento de project update

El comando de actualización del proyecto realiza las siguientes tareas:

  1. Carga el archivo project-template.json y el contenido comprimido del subdirectorio project-code en Bucket de configuración.

  2. Utiliza el archivoproject-template.json cargado para realizar una operación de actualización de la pila de AWS CloudFormation. El archivo project-code.zip se utiliza para crear los recursos de funciones Lambda que se definen en el archivo project-template.json.

nota

El comando project update da error si el archivo dev\{game}\AWS\local-project-settings.json no existe o no tiene una propiedad ProjectStackId válida.

project update-framework-version

Actualiza la versión del marco de trabajo de Cloud Gem de un proyecto.

Además de Argumentos comunes, el comando project update-code acepta los siguientes argumentos:

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que el comando deployment create creará los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-resource-deletion

    Opcional. Confirma que el comando eliminará permanentemente los recursos que pertenecen a la implementación especificada. Si este argumento no se especifica, se emite un mensaje de confirmación.

  • --confirm-security-change

    Opcional. Confirma que sabe que este comando puede hacer cambios relacionados con la seguridad. Especifique este argumento para deshabilitar la petición de confirmación.

Para obtener más información, consulte Aplicar actualizaciones de marco de trabajo a un proyecto.

Comandos de resource-group

Los comandos de lmbr_aws resource-group administran los grupos de recursos en su proyecto de Cloud Canvas.

resource-group add

nota

La funcionalidad de este comando ha cambiado en Lumberyard 1.11. Este comando ya no está disponible y se ha sustituido por los comandos cloud-gem create y resource-group enable. A partir de Lumberyard 1.11, los grupos de recursos locales del proyecto se han dejado de utilizar en favor de las gemas en la nube. Dado que las gemas en la nube son reutilizables, recomendamos utilizarlas en lugar de los grupos de recursos locales.

A partir de Lumberyard 1.11, el comando resource-group add tiene el siguiente comportamiento:

  • Si el grupo de recursos especificado en el parámetro --resource-group existe, pero está deshabilitado, el grupo de recursos está habilitado. Es el equivalente al comando lmbr_aws resource-group enable.

  • En caso de que el grupo de recursos no exista, se llama al comando lmbr_aws cloud-gem create para crear un nuevo grupo de recursos en una gema en la nube. El nombre de la gema en la nube se especifica mediante el parámetro --resource-group {resource-group-name}.

    • De forma predeterminada, la nueva gema no tiene recursos. Esto se corresponde con la opción cloud-gem create del comando --initial-content no-resources.

    • Si se especifica la opción --include-example-resources, se llama al equivalente de la opción cloud-gem create del comando --initial-content api-lambda-dynamodb.

Además de Argumentos comunes, el comando resource-group add acepta los siguientes argumentos:

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. El nombre de un grupo de recursos existente que se va a habilitar. Si no existe ningún grupo de recursos con el nombre especificado, especifica el nombre de la gema en la nube y el grupo de recursos que se va a crear.

  • --gem {gem-path}

    Opcional. Busca la definición del grupo de recursos en Gems\group\AWS o gem-path\AWS.

  • --include-example-resources

    Opcional. El equivalente a la opción --initial-content api-lambda-dynamodb del comando cloud-gem create.

resource-group disable

Deshabilita un grupo de recursos para la depuración. Este comando es nuevo en Lumberyard 1.11.

Además de Argumentos comunes, el comando resource-group disable acepta el argumento siguiente:

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. El nombre del grupo de recursos que se va a deshabilitar.

De forma predeterminada, cuando una gema en la nube está habilitada para un proyecto, se habilitan todos sus grupos de recursos. Si deshabilita un grupo de recursos, tendrá las siguientes consecuencias:

  • Cuando se crea una implementación, los recursos que define el grupo de recursos deshabilitado no se crean en AWS.

  • Cuando se actualiza una implementación, los recursos que ha definido el grupo de recursos deshabilitado se eliminan.

  • El grupo de recursos se añade a una lista de grupos de recursos deshabilitados en el archivo local-project-settings.json del proyecto.

nota

Antes de Lumberyard 1.11, el archivo local-project-settings.json mantenía una lista de grupos de recursos habilitados. De forma predeterminada, todos los grupos de recursos de una gema en la nube se habilitan cuando se habilita la gema en la nube. Por lo tanto, publicar solo los grupos de recursos deshabilitados facilita su identificación.

Normalmente, es mejor deshabilitar la gema en la nube que proporciona un grupo de recursos que deshabilitar el grupo de recursos en sí. Por lo tanto, se recomienda utilizar solo el comando resource-group disable para la depuración o las pruebas. Para volver a habilitar un grupo de recursos, puede utilizar el comando lmbr_aws resource-group enable.

resource-group enable

Habilite un grupo de recursos. Este comando es nuevo en Lumberyard 1.11.

Además de Argumentos comunes, el comando resource-group disable acepta el argumento siguiente:

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. El nombre del grupo de recursos que se va a habilitar.

resource-group list

Muestra todos los grupos de recursos que se encuentran en la plantilla de implementación local y en la implementación seleccionada de AWS.

Además de Argumentos comunes, el comando resource-group list acepta el argumento siguiente:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación para la que se enumeran los grupos de recursos. Si no se proporciona, se usa la implementación predeterminada.

Ejemplo del resultado:

Name Status Reason Timestamp Id -------------- --------------- ------------------------------------------------------------------------------- ----------------- -------------------------------------------------------------------------------------------------------------------------------------------------- AnotherResourceGroup CREATE_PENDING Resource is defined in the local deployment template but does not exist in AWS. HelloWorld CREATE_COMPLETE 03/04/16 18:42:57 arn:aws:cloudformation:us-east-2:<ACCOUNTID>:stack/foo-hw-Development-ZDLXUB7FKR94-HelloWorld-WSGZ15EUWX52/9b909d20-e238-11e5-a98d-50fae987c09a

resource-group list-resources

Enumera todos los recursos asociados con el proyecto.

Además de Argumentos comunes, el comando resource-group list-resources acepta los siguientes argumentos:

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación para la que se enumeran los recursos. Si no especifica, se enumeran todos los recursos del proyecto.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Opcional. El nombre del grupo de recursos para el que se enumeran los recursos. Si se especifica, el argumento deployment también se debe especificar. Si no se especifica, se enumeran todos los recursos de la implementación o el proyecto.

resource-group remove

nota

La funcionalidad de este comando ha cambiado en Lumberyard 1.11. Este comando ya no está disponible y se ha sustituido por los comandos resource-group disable y cloud-gem disable.

A partir de Lumberyard 1.11, el comando resource-group remove tiene el siguiente comportamiento:

  • Si una gema en la nube proporciona el grupo de recursos especificado en el parámetro --resource-group, se deshabilita la gema en la nube. Es el equivalente al comando lmbr_aws cloud-gem disable.

  • Si una gema en la nube no proporciona el grupo de recursos, se deshabilita el grupo de recursos. Es el equivalente al comando lmbr_aws resource-group disable.

Además de Argumentos comunes, el comando resource-group remove acepta el argumento siguiente:

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. El nombre del grupo de recursos o la gema en la nube que se va a deshabilitar.

resource-group upload-resources (upload, update)

Actualice una pila de AWS CloudFormation del grupo de recursos en una implementación. Se puede usar resource-group update o resource-group upload en lugar de resource-group upload-resources.

Además de Argumentos comunes, el comando resource-group upload acepta los siguientes argumentos:

  • --confirm-aws-usage o bien -C

    Opcional. Confirma que sabe que este comando creará los recursos de AWS por los que es posible que se cobre y que pueden llevar a cabo acciones que afectan a los permisos de la cuenta de AWS. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-resource-deletion

    Opcional. Si la operación elimina los recursos de forma permanente, confirme su confirmación y aprobación. Especifique este argumento para deshabilitar la petición de confirmación.

  • --confirm-security-change

    Opcional. Confirma que sabe que este comando puede hacer cambios relacionados con la seguridad. Especifique este argumento para deshabilitar la petición de confirmación.

  • --deployment {deployment-name} o bien -d {deployment-name}

    Opcional. El nombre de la implementación que se actualiza. Si no se especifica, se actualiza la implementación predeterminada.

  • --resource-group {resource-group-name}, o bien -r {resource-group-name}

    Obligatorio. El nombre del grupo de recursos que se va a actualizar. Si no se especifica, se actualizan todos los grupos de recursos de la implementación.

Comandos de resource-importer

Los comandos de lmbr_aws resource-importer enumeran e importan las definiciones de recursos de AWS a su proyecto de Cloud Canvas.

resource-importer import-resource

Importa un recurso a un grupo de recursos.

Además de Argumentos comunes, el comando resource-importer import-resource acepta los siguientes argumentos:

  • --type {dynamodb|s3|lambda|sns|sqs}

    Opcional. El tipo de recurso AWS que se va a importar. Elija entre dynamodb, s3, lambda, sns o sqs.

  • --arn ARN

    Obligatorio. ARN del recurso de AWS que se va a importar.

  • --resource-name {resource-name}

    Obligatorio. El nombre del recurso que se va a importar.

  • --resource-group {resource-group-name} o bien -r {resource-group-name}

    Obligatorio. El nombre del grupo de recursos que se va a importar.

  • --download

    Opcional. Si se especifica, descarga el contenido del bucket de Amazon S3.

resource-importer list-importable-resources

Muestra todos los recursos compatibles actualmente que existen en AWS.

Además de Argumentos comunes, el comando resource-importer list-importable-resources acepta los siguientes argumentos:

  • --type {dynamodb|s3|lambda|sns|sqs}

    Obligatorio. El tipo de recurso de AWS que se va a mostrar. Elija entre dynamodb, s3, lambda, sns o sqs.

  • --region {region}

    Opcional. La región de AWS de los recursos. El valor predeterminado es la región de la pila del proyecto si existe.

    nota

    El argumento region solo puede utilizarse con los comandos resource-importer list-importable-resources y project create. Para anular manualmente la región de AWS en otros comandos lmbr_aws, utilice el argumento --region-override.