Referencia de la acción de Comandos

La acción de Comandos permite ejecutar comandos del intérprete de comandos en una instancia de computación virtual. Al ejecutar la acción, los comandos especificados en la configuración de la acción se ejecutan en un contenedor independiente. Todos los artefactos que se especifican como artefactos de entrada para una CodeBuild acción están disponibles dentro del contenedor que ejecuta los comandos. Esta acción permite especificar comandos sin necesidad de crear primero un CodeBuild proyecto. Para obtener más información consulte ActionDeclaration y OutputArtifact en la Referencia de la API de AWS CodePipeline .

importante

Esta acción utiliza la CodeBuild computación CodePipeline gestionada para ejecutar comandos en un entorno de compilación. Si ejecuta la acción de Comandos, se le cobrarán cargos por separado en AWS CodeBuild.

nota

La acción Comandos solo está disponible para canalizaciones de tipo V2.

Consideraciones sobre la acción de Comandos

Las siguientes consideraciones se aplican a la acción de Comandos.

• La acción de comandos usa CodeBuild recursos similares a los de la CodeBuild acción y, al mismo tiempo, permite ejecutar comandos de entorno de shell en una instancia de cómputo virtual sin necesidad de asociar o crear un proyecto de compilación.

  nota

  Si ejecuta la acción de Comandos, se le cobrarán cargos por separado en AWS CodeBuild.

• Como la acción Comandos CodePipeline utiliza CodeBuild recursos, las compilaciones ejecutadas por la acción se atribuirán a los límites de compilación de tu cuenta en CodeBuild. Las compilaciones ejecutadas mediante la acción de Comandos se tendrán en cuenta para los límites de compilación simultánea configurados para esa cuenta.

• El tiempo de espera para las compilaciones con la acción de comandos es de 55 minutos, según las CodeBuild compilaciones.

• La instancia de procesamiento utiliza un entorno de compilación aislado en CodeBuild.

  nota

  Debido a que el entorno de compilación aislado se usa a nivel de cuenta, es posible que una instancia se reutilice para otra ejecución de canalización.

• Se admiten todos los formatos, excepto los formatos multilínea. Debe utilizar el formato de una sola línea al introducir comandos.

• La acción de comandos es compatible con las acciones entre cuentas. Para añadir una acción de comandos multicuenta, añádela actionRoleArn desde tu cuenta de destino en la declaración de acción.

• Para esta acción, CodePipeline asumirá la función de servicio de canalización y la utilizará para permitir el acceso a los recursos en tiempo de ejecución. Se recomienda configurar el rol de servicio para que los permisos se limiten al nivel de acción.

• Los permisos agregados a la función CodePipeline de servicio se detallan enAgregar permisos al rol de servicio de CodePipeline.

• El permiso necesario para ver los registros en la consola se detalla en Permisos necesarios para ver los registros de procesamiento en la CodePipeline consola.

• A diferencia de otras acciones en CodePipeline, no se establecen campos en la configuración de acciones; se establecen los campos de configuración de acciones fuera de la configuración de acciones.

Permisos para las políticas de roles de servicio

Cuando CodePipeline ejecuta la acción, CodePipeline crea un grupo de registros con el nombre de la canalización, tal como se indica a continuación. Esto permite reducir los permisos para registrar los recursos mediante el nombre de la canalización.

/aws/codepipeline/MyPipelineName

Si utiliza un rol de servicio existente, para utilizar la acción de Comandos tendrá que agregar los siguientes permisos para el rol de servicio.

• registros: CreateLogGroup

• registros: CreateLogStream

• registros: PutLogEvents

En la declaración de las políticas de roles de servicio, limite los permisos al nivel de la canalización como se muestra en el siguiente ejemplo.

{
    "Effect": "Allow",
    "Action": [
        "logs:CreateLogGroup",
        "logs:CreateLogStream",
        "logs:PutLogEvents"
    ],
    "Resource": [
        "arn:aws:logs:*:YOUR_AWS_ACCOUNT_ID:log-group:/aws/codepipeline/YOUR_PIPELINE_NAME",
        "arn:aws:logs:*:YOUR_AWS_ACCOUNT_ID:log-group:/aws/codepipeline/YOUR_PIPELINE_NAME:*"
   ]
}

Para ver los registros en la consola mediante la página del cuadro de diálogo de detalles de la acción, se debe agregar el permiso para ver los registros al rol de la consola. Para obtener más información, consulte el ejemplo de política de permisos para consolas en Permisos necesarios para ver los registros de procesamiento en la CodePipeline consola.

Tipo de acción

• Categoría: Compute

• Propietario: AWS

• Proveedor: Commands

• Versión: 1

Parámetros de configuración

Comandos

Obligatorio: sí

Puede proporcionar comandos del intérprete de comandos para que se ejecute la acción Commands. En la consola, los comandos se introducen en líneas separadas. En la CLI, los comandos se introducen como cadenas independientes.

nota

Los formatos multilínea no son compatibles y generarán un mensaje de error. Se debe utilizar el formato de una sola línea para introducir comandos en el campo Comandos.

Los siguientes detalles proporcionan la computación predeterminada que se utiliza para la acción de Comandos. Para obtener más información, consulte la referencia de tipos y modos de procesamiento del entorno de compilación en la Guía del CodeBuild usuario.

• CodeBuild imagen: aws/codebuild/amazonlinux 2-x86_64-standard:5.0

• Tipo de computación: Linux Small

• Valor de ComputEtype del entorno: BUILD_ _SMALL GENERAL1

• Valor del tipo de entorno: LINUX_CONTAINER

outputVariables

Obligatorio: no

Especifique los nombres de las variables del entorno que desee exportar. Para obtener una referencia sobre las variables de CodeBuild entorno, consulte Variables de entorno en entornos de compilación en la Guía del usuario. CodeBuild

Archivos

Obligatorio: no

Puede proporcionar los archivos que desee exportar como artefactos de salida para la acción.

El formato admitido para los archivos es el mismo que para los patrones de CodeBuild archivos. Por ejemplo, introduzca **/ para todos los archivos. Para obtener más información, consulte la referencia de especificaciones de compilación CodeBuild en la Guía del CodeBuild usuario.

VpcId

Obligatorio: no

El ID de VPC de sus recursos.

Subredes

Obligatorio: no

Las subredes de la VPC. Este campo es necesario cuando los comandos necesitan conectarse a los recursos de una VPC.

SecurityGroupIds

Obligatorio: no

Los grupos de seguridad de la VPC. Este campo es necesario cuando los comandos necesitan conectarse a los recursos de una VPC.

Artefactos de entrada

• Número de artefactos: 1 to 10

Artefactos de salida

• Número de artefactos: 0 to 1

Variables de entorno

Clave

La clave de un par de variables de entorno clave-valor, como. Name

Valor

El valor del par clave-valor, por ejemplo. Production El valor se puede parametrizar con variables de salida de acciones de canalización o variables de canalización.

Declaración de acciones (ejemplo)

YAML

name: Commands_action
actionTypeId:
  category: Compute
  owner: AWS
  provider: Commands
  version: '1'
runOrder: 1
configuration: {}
commands:
- ls
- echo hello
- 'echo pipeline Execution Id is #{codepipeline.PipelineExecutionId}'
outputArtifacts:
- name: BuildArtifact
  files:
  - **/
inputArtifacts:
- name: SourceArtifact
outputVariables:
- AWS_DEFAULT_REGION
region: us-east-1
namespace: compute

JSON

{
    "name": "Commands_action",
    "actionTypeId": {
        "category": "Compute",
        "owner": "AWS",
        "provider": "Commands",
        "version": "1"
    },
    "runOrder": 1,
    "configuration": {},
    "commands": [
        "ls",
        "echo hello",
        "echo pipeline Execution Id is #{codepipeline.PipelineExecutionId}"
    ],
    "outputArtifacts": [
        {
            "name": "BuildArtifact",
            "files": [
                "**/"
            ]
        }
    ],
    "inputArtifacts": [
        {
            "name": "SourceArtifact"
        }
    ],
    "outputVariables": [
        "AWS_DEFAULT_REGION"
    ],
    "region": "us-east-1",
    "namespace": "compute"
}

Véase también

Los recursos relacionados siguientes pueden serle de ayuda cuando trabaje con esta acción.

• Tutorial: Cree una canalización que ejecute comandos con compute (tipo V2): este tutorial proporciona un ejemplo de canalización con la acción de Comandos.