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.
Utilice variables en su documento de componentes personalizados
Las variables proporcionan una forma de etiquetar los datos con nombres significativos que se pueden usar en toda la aplicación. Puede definir variables personalizadas con formatos sencillos y legibles para flujos de trabajo complejos y hacer referencia a ellas en el documento del componente de la YAML aplicación para obtener un TOE de AWS componente.
En esta sección se proporciona información que le ayudará a definir variables para su TOE de AWS componente en el documento del componente de la YAML aplicación, incluida la sintaxis, las restricciones de nombres y ejemplos.
Parámetros
Los parámetros son variables mutables, con ajustes que la aplicación que realiza la llamada puede proporcionar en el tiempo de ejecución. Puede definir los parámetros en la Parameters
sección del YAML documento.
Reglas para nombres de parámetros
El nombre debe tener entre 3 y 128 caracteres de extensión.
El nombre solo puede contener caracteres alfanuméricos (a-z, A-Z y 0-9), guiones (-) o guiones bajos (_).
El nombre debe ser único dentro del documento.
El nombre debe especificarse en forma de YAML cadena.
Sintaxis
parameters: - <name>: type: <parameter type> default: <parameter value> description: <parameter description>
Nombre de la clave |
Obligatoria |
Descripción |
---|---|---|
|
Sí |
El nombre del parámetro. Debe ser único para el documento (no debe coincidir con ningún otro nombre de parámetro o constante). |
|
Sí |
El tipo de datos del parámetro. Los tipos admitidos incluyen: |
|
No |
El valor predeterminado para el parámetro. |
|
No |
Describe el parámetro. |
Valores de parámetros de referencia en un documento
Puede hacer referencia a los parámetros de las entradas escalonadas o en bucle del YAML documento, de la siguiente manera:
-
Las referencias de parámetros distinguen mayúsculas y minúsculas y el nombre debe coincidir exactamente.
-
El nombre debe ir entre corchetes dobles
{{
MyParameter
}}
. -
Se permiten espacios dentro de las llaves y se recortan automáticamente. Por ejemplo, todas las referencias siguientes son válidas:
{{
,MyParameter
}}{{
,MyParameter
}}{{
,MyParameter
}}{{
MyParameter
}} -
La referencia del YAML documento debe especificarse en forma de cadena (entre comillas simples o dobles).
Por ejemplo:
- {{
no es válido, ya que no se identifica como una cadena.MyParameter
}}Sin embargo, las siguientes referencias son válidas:
- '{{
yMyParameter
}}'- "{{
.MyParameter
}}"
Ejemplos
Los siguientes ejemplos muestran cómo utilizar los parámetros en el YAML documento:
-
Consulte un parámetro en las entradas escalonadas:
name: Download AWS CLI version 2 schemaVersion: 1.0 parameters: - Source: type: string default: 'https://awscli.amazonaws.com/AWSCLIV2.msi' description: The AWS CLI installer source URL. phases: - name: build steps: - name: Download action: WebDownload inputs: - source: '{{ Source }}' destination: 'C:\Windows\Temp\AWSCLIV2.msi'
-
Consulte un parámetro en las entradas de bucle:
name: PingHosts schemaVersion: 1.0 parameters: - Hosts: type: string default: 127.0.0.1,amazon.com description: A comma separated list of hosts to ping. phases: - name: build steps: - name: Ping action: ExecuteBash loop: forEach: list: '{{ Hosts }}' delimiter: ',' inputs: commands: - ping -c 4 {{ loop.value }}
Anulación de los parámetros en tiempo de ejecución
Puede utilizar la --parameters
opción del AWS CLI con un par clave-valor para establecer el valor de un parámetro en tiempo de ejecución.
Especifique el par clave-valor del parámetro como nombre y valor, separados por un signo igual (<name>=<value>).
Varios parámetros deben estar separados por una coma.
Se ignoran los nombres de los parámetros que no se encuentran en el documento del YAML componente.
Tanto el nombre como el valor del parámetro son obligatorios.
importante
Los parámetros de los componentes son valores de texto plano y se registran AWS CloudTrail Le recomendamos que utilice . AWS Secrets Manager o el AWS Systems Manager Tienda de parámetros para guardar tus secretos. Para obtener más información sobre Secrets Manager, consulte ¿Qué es Secrets Manager? en el AWS Secrets Manager Guía del usuario. Para obtener más información acerca de AWS Systems Manager Almacén de parámetros, consulte AWS Systems Manager Almacén de parámetros en el AWS Systems Manager Guía del usuario.
Sintaxis
--parameters
name1
=value1
,name2
=value2
...
CLIopción |
Obligatoria |
Descripción |
---|---|---|
--parameters |
No |
Esta opción toma una lista de pares clave-valor, con el nombre del parámetro como clave. |
Ejemplos
Los siguientes ejemplos muestran cómo utilizar los parámetros en el YAML documento:
-
El par clave-valor del parámetro especificado en esta opción
--parameter
no es válido:--parameters ntp-server=
-
Establezca un par clave-valor de un parámetro con la
--parameter
opción de AWS CLI:--parameters ntp-server=ntp-server-windows-qe.us-east1.amazon.com
-
Establezca varios pares clave-valor de parámetros con la opción de
--parameter
AWS CLI:--parameters ntp-server=ntp-server.amazon.com,http-url=https://internal-us-east1.amazon.com
Constantes
Las constantes son variables inmutables que no se pueden modificar ni anular una vez definidas. Las constantes se pueden definir mediante valores de la sección de constants
un TOE de AWS no válido.
Reglas de nomenclatura de constantes
El nombre debe tener entre 3 y 128 caracteres de extensión.
El nombre solo puede contener caracteres alfanuméricos (a-z, A-Z y 0-9), guiones (-) o guiones bajos (_).
El nombre debe ser único dentro del documento.
El nombre debe especificarse como una YAML cadena.
Sintaxis
constants: - <name>: type: <constant type> value: <constant value>
Nombre de la clave | Obligatoria | Descripción |
---|---|---|
|
Sí |
Nombre de la constante. Debe ser único para el documento (no debe coincidir con ningún otro nombre de parámetro o constante). |
|
Sí | Valor de la constante. |
|
Sí | Tipo de la constante. El tipo admitido es string . |
Valores constantes de referencia en un documento
Puede hacer referencia a las constantes en las entradas escalonadas o en bucle del YAML documento, de la siguiente manera:
-
Las referencias constantes distinguen mayúsculas y minúsculas y el nombre debe coincidir exactamente.
-
El nombre debe estar entre corchetes dobles
{{
MyConstant
}}
. -
Se permiten espacios dentro de las llaves y se recortan automáticamente. Por ejemplo, todas las referencias siguientes son válidas:
{{
,MyConstant
}}{{
,MyConstant
}}{{
,MyConstant
}}{{
MyConstant
}} -
La referencia del YAML documento debe especificarse en forma de cadena (entre comillas simples o dobles).
Por ejemplo:
- {{
no es válido, ya que no se identifica como una cadena.MyConstant
}}Sin embargo, las siguientes referencias son válidas:
- '{{
yMyConstant
}}'- "{{
.MyConstant
}}"
Ejemplos
Constante referenciada en las entradas escalonadas
name: Download AWS CLI version 2 schemaVersion: 1.0 constants: - Source: type: string value: https://awscli.amazonaws.com/AWSCLIV2.msi phases: - name: build steps: - name: Download action: WebDownload inputs: - source: '{{ Source }}' destination: 'C:\Windows\Temp\AWSCLIV2.msi'
Constante referenciada en las entradas de bucle
name: PingHosts schemaVersion: 1.0 constants: - Hosts: type: string value: 127.0.0.1,amazon.com phases: - name: build steps: - name: Ping action: ExecuteBash loop: forEach: list: '{{ Hosts }}' delimiter: ',' inputs: commands: - ping -c 4 {{ loop.value }}