

# Fragmentos de código de plantillas generales
<a name="quickref-general"></a>

Los siguientes ejemplos muestran diferentes características de plantilla de CloudFormation que no son específicas de un servicio de AWS.

**Topics**
+ [Propiedad UserData codificada en Base64](#scenario-userdata-base64)
+ [Propiedad UserData codificada en Base64 con AccessKey y SecretKey](#scenario-userdata-base64-with-keys)
+ [Sección Parameters con un parámetro de cadena literal](#scenario-one-string-parameter)
+ [Sección Parameters con parámetro de cadena con limitación de expresiones regulares](#scenario-constraint-string-parameter)
+ [Sección Parameters con parámetro numérico con restricciones MinValue y MaxValue](#scenario-one-number-min-parameter)
+ [Sección Parameters con parámetro numérico con restricción AllowedValues](#scenario-one-number-parameter)
+ [Sección Parameters con un parámetro CommaDelimitedList literal](#scenario-one-list-parameter)
+ [Sección Parameters con valor de parámetros basado en pseudoparámetro](#scenario-one-pseudo-parameter)
+ [Sección Mapping con tres asignaciones](#scenario-mapping-with-four-maps)
+ [Description basada en cadena literal](#scenario-description-from-literal-string)
+ [Sección Outputs con una salida de cadena literal](#scenario-output-with-literal-string)
+ [Sección Outputs con una referencia de recursos y una salida de pseudoreferencia](#scenario-output-with-ref-and-pseudo-ref)
+ [Sección Outputs con una salida basada en una función, una cadena literal, una referencia y un pseudoparámetro](#scenario-output-with-complex-spec)
+ [Versión de formato de plantilla](#scenario-format-version)
+ [Propiedad Tags de AWS](#scenario-format-aws-tag)

## Propiedad UserData codificada en Base64
<a name="scenario-userdata-base64"></a>

Este ejemplo muestra el conjunto de una propiedad `UserData` que utiliza las funciones `Fn::Base64` y `Fn::Join`. Las referencias `MyValue` y `MyName` son parámetros que deben definirse en la sección `Parameters` de la plantilla. La cadena literal `Hello World` es simplemente otro valor que este ejemplo introduce como parte de los `UserData`.

### JSON
<a name="quickref-general-example-1.json"></a>

```
1. "UserData" : {
2.     "Fn::Base64" : {
3.         "Fn::Join" : [ ",", [
4.             { "Ref" : "MyValue" },
5.             { "Ref" : "MyName" },
6.             "Hello World" ] ]
7.     }
8. }
```

### YAML
<a name="quickref-general-example-1.yaml"></a>

```
1. UserData:
2.   Fn::Base64: !Sub |
3.      Ref: MyValue
4.      Ref: MyName
5.      Hello World
```

## Propiedad UserData codificada en Base64 con AccessKey y SecretKey
<a name="scenario-userdata-base64-with-keys"></a>

Este ejemplo muestra el conjunto de una propiedad `UserData` que utiliza las funciones `Fn::Base64` y `Fn::Join`. Incluye la información `AccessKey` y `SecretKey`. Las referencias `AccessKey` y `SecretKey` son parámetros que deben definirse en la sección Parameters de la plantilla.

### JSON
<a name="quickref-general-example-2.json"></a>

```
1. "UserData" : {
2.     "Fn::Base64" : {
3.         "Fn::Join" : [ "", [
4.             "ACCESS_KEY=", { "Ref" : "AccessKey" },
5.             "SECRET_KEY=", { "Ref" : "SecretKey" } ]
6.         ]
7.     }
8. }
```

### YAML
<a name="quickref-general-example-2.yaml"></a>

```
1. UserData:
2.   Fn::Base64: !Sub |
3.      ACCESS_KEY=${AccessKey}
4.      SECRET_KEY=${SecretKey}
```

## Sección Parameters con un parámetro de cadena literal
<a name="scenario-one-string-parameter"></a>

El siguiente ejemplo muestra una declaración de la sección Parameters (Parámetros) válida en la que se declara un parámetro de tipo `String` individual.

### JSON
<a name="quickref-general-example-3.json"></a>

```
1. "Parameters" : {
2.     "UserName" : {
3.         "Type" : "String",
4.         "Default" : "nonadmin",
5.         "Description" : "Assume a vanilla user if no command-line spec provided"
6.     }
7. }
```

### YAML
<a name="quickref-general-example-3.yaml"></a>

```
1. Parameters:
2.   UserName:
3.     Type: String
4.     Default: nonadmin
5.     Description: Assume a vanilla user if no command-line spec provided
```

## Sección Parameters con parámetro de cadena con limitación de expresiones regulares
<a name="scenario-constraint-string-parameter"></a>

El siguiente ejemplo muestra una declaración de la sección Parameters (Parámetros) válida en la que se declara un parámetro de tipo `String` individual. El parámetro `AdminUserAccount` tiene el valor predeterminado de `admin`. El valor del parámetro debe tener una longitud mínima de 1, una longitud máxima de 16 y contener caracteres alfabéticos y números, pero debe comenzar por un carácter alfabético.

### JSON
<a name="quickref-general-example-4.json"></a>

```
 1. "Parameters" : {
 2.     "AdminUserAccount": {
 3.       "Default": "admin",
 4.       "NoEcho": "true",
 5.       "Description" : "The admin account user name",
 6.       "Type": "String",
 7.       "MinLength": "1",
 8.       "MaxLength": "16",
 9.       "AllowedPattern" : "[a-zA-Z][a-zA-Z0-9]*"
10.     }
11. }
```

### YAML
<a name="quickref-general-example-4.yaml"></a>

```
1. Parameters:
2.   AdminUserAccount:
3.     Default: admin
4.     NoEcho: true
5.     Description: The admin account user name
6.     Type: String
7.     MinLength: 1
8.     MaxLength: 16
9.     AllowedPattern: '[a-zA-Z][a-zA-Z0-9]*'
```

## Sección Parameters con parámetro numérico con restricciones MinValue y MaxValue
<a name="scenario-one-number-min-parameter"></a>

El siguiente ejemplo muestra una declaración de la sección Parameters (Parámetros) válida en la que se declara un parámetro de tipo `Number` individual. El parámetro `WebServerPort` tiene un valor predeterminado de 80, un valor mínimo de 1 y un valor máximo de 65535.

### JSON
<a name="quickref-general-example-5.json"></a>

```
1. "Parameters" : {
2.     "WebServerPort": {
3.       "Default": "80",
4.       "Description" : "TCP/IP port for the web server",
5.       "Type": "Number",
6.       "MinValue": "1",
7.       "MaxValue": "65535"
8.     }
9. }
```

### YAML
<a name="quickref-general-example-5.yaml"></a>

```
1. Parameters:
2.   WebServerPort:
3.     Default: 80
4.     Description: TCP/IP port for the web server
5.     Type: Number
6.     MinValue: 1
7.     MaxValue: 65535
```

## Sección Parameters con parámetro numérico con restricción AllowedValues
<a name="scenario-one-number-parameter"></a>

El siguiente ejemplo muestra una declaración de la sección Parameters (Parámetros) válida en la que se declara un parámetro de tipo `Number` individual. El parámetro `WebServerPort` tiene un valor predeterminado de 80 y solo permite valores de 80 y 8888.

### JSON
<a name="quickref-general-example-6.json"></a>

```
1. "Parameters" : {
2.     "WebServerPortLimited": {
3.       "Default": "80",
4.       "Description" : "TCP/IP port for the web server",
5.       "Type": "Number",
6.       "AllowedValues" : ["80", "8888"]
7.     }
8. }
```

### YAML
<a name="quickref-general-example-6.yaml"></a>

```
1. Parameters:
2.   WebServerPortLimited:
3.     Default: 80
4.     Description: TCP/IP port for the web server
5.     Type: Number
6.     AllowedValues:
7.     - 80
8.     - 8888
```

## Sección Parameters con un parámetro CommaDelimitedList literal
<a name="scenario-one-list-parameter"></a>

El siguiente ejemplo muestra una declaración de la sección `Parameters` válida en la que se declara un parámetro de tipo `CommaDelimitedList` individual. La propiedad `NoEcho` se establece en `TRUE`, lo que enmascara su valor con asteriscos (\$1\$1\$1\$1\$1) en la salida **describe-stacks**, excepto para la información almacenada en las ubicaciones especificadas a continuación.

**importante**  
El uso del atributo `NoEcho` no enmascara ninguna información almacenada en lo que se muestra a continuación:  
La sección de la plantilla `Metadata`. CloudFormation no transforma, modifica ni redacta ninguna información que incluya en la sección `Metadata`. Para obtener más información, consulte [Metadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html).
La sección de la plantilla `Outputs`. Para obtener más información, consulte [Salidas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html).
El atributo `Metadata` de una definición de recurso. Para obtener más información, consulte [`Metadata` atributo](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-metadata.html).
Recomendamos encarecidamente que no utilice estos mecanismos para incluir información confidencial, como contraseñas o secretos.

**importante**  
En lugar de integrar información confidencial directamente en las plantillas de CloudFormation, se recomienda utilizar parámetros dinámicos en la plantilla de la pila para hacer referencia a la información confidencial almacenada y administrada fuera de CloudFormation, como en AWS Systems Manager Parameter Store o AWS Secrets Manager.  
Para obtener más información, consulte la práctica recomendada [No integre credenciales en sus plantillas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds).

### JSON
<a name="quickref-general-example-7.json"></a>

```
1. "Parameters" : {
2.     "UserRoles" : {
3.         "Type" : "CommaDelimitedList",
4.         "Default" : "guest,newhire",
5.         "NoEcho" : "TRUE"
6.     }
7. }
```

### YAML
<a name="quickref-general-example-7.yaml"></a>

```
1. Parameters:
2.   UserRoles:
3.     Type: CommaDelimitedList
4.     Default: "guest,newhire"
5.     NoEcho: true
```

## Sección Parameters con valor de parámetros basado en pseudoparámetro
<a name="scenario-one-pseudo-parameter"></a>

El siguiente ejemplo muestra comandos en los datos de usuario de EC2 que utilizan los pseudoparámetros `AWS::StackName` y `AWS::Region`. Para obtener más información sobre pseudoparámetros, consulte . [Obtención de valores de AWS mediante pseudoparámetros](pseudo-parameter-reference.md).

### JSON
<a name="quickref-general-example-10.json"></a>

```
 1.           "UserData"       : { "Fn::Base64" : { "Fn::Join" : ["", [
 2.              "#!/bin/bash -xe\n",
 3.              "yum install -y aws-cfn-bootstrap\n",
 4. 
 5.              "/opt/aws/bin/cfn-init -v ",
 6.              "         --stack ", { "Ref" : "AWS::StackName" },
 7.              "         --resource LaunchConfig ",
 8.              "         --region ", { "Ref" : "AWS::Region" }, "\n",
 9. 
10.              "/opt/aws/bin/cfn-signal -e $? ",
11.              "         --stack ", { "Ref" : "AWS::StackName" },
12.              "         --resource WebServerGroup ",
13.              "         --region ", { "Ref" : "AWS::Region" }, "\n"
14.         ]]}}
15.       }
```

### YAML
<a name="quickref-general-example-10.yaml"></a>

```
1. UserData:
2.   Fn::Base64: !Sub |
3.      #!/bin/bash -xe
4.      yum update -y aws-cfn-bootstrap
5.      /opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --region ${AWS::Region}
6.      /opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --resource WebServerGroup --region ${AWS::Region}
```

## Sección Mapping con tres asignaciones
<a name="scenario-mapping-with-four-maps"></a>

El siguiente ejemplo muestra una declaración de sección `Mapping` válida que contiene tres asignaciones. La asignación, cuando coincide con una clave de mapeo de `Stop`, `SlowDown` o `Go`, proporciona los valores RGB asignados al atributo `RGBColor` correspondiente.

### JSON
<a name="quickref-general-example-11.json"></a>

```
 1. "Mappings" : {
 2.     "LightColor" : {
 3.         "Stop" : {
 4.             "Description" : "red",
 5.             "RGBColor" : "RED 255 GREEN 0 BLUE 0"
 6.         },
 7.         "SlowDown" : {
 8.             "Description" : "yellow",
 9.             "RGBColor" : "RED 255 GREEN 255 BLUE 0"
10.         },
11.         "Go" : {
12.             "Description" : "green",
13.             "RGBColor" : "RED 0 GREEN 128 BLUE 0"
14.         }
15.     }
16. }
```

### YAML
<a name="quickref-general-example-11.yaml"></a>

```
 1. Mappings:
 2.   LightColor:
 3.     Stop:
 4.       Description: red
 5.       RGBColor: "RED 255 GREEN 0 BLUE 0"
 6.     SlowDown:
 7.       Description: yellow
 8.       RGBColor: "RED 255 GREEN 255 BLUE 0"
 9.     Go:
10.       Description: green
11.       RGBColor: "RED 0 GREEN 128 BLUE 0"
```

## Description basada en cadena literal
<a name="scenario-description-from-literal-string"></a>

El siguiente ejemplo muestra una declaración de sección `Description` válida donde el valor se basa en una cadena literal. Este fragmento de código puede ser para plantillas, parámetros, recursos, propiedades o salidas.

### JSON
<a name="quickref-general-example-8.json"></a>

```
1. "Description" : "Replace this value"
```

### YAML
<a name="quickref-general-example-8.yaml"></a>

```
1. Description: "Replace this value"
```

## Sección Outputs con una salida de cadena literal
<a name="scenario-output-with-literal-string"></a>

Este ejemplo muestra una asignación de salida basada en una cadena literal.

### JSON
<a name="quickref-general-example-12.json"></a>

```
1. "Outputs" : {
2.     "MyPhone" : {
3.         "Value" : "Please call 555-5555",
4.         "Description" : "A random message for aws cloudformation describe-stacks"
5.     }
6. }
```

### YAML
<a name="quickref-general-example-12.yaml"></a>

```
1. Outputs:
2.   MyPhone:
3.     Value: Please call 555-5555
4.     Description: A random message for aws cloudformation describe-stacks
```

## Sección Outputs con una referencia de recursos y una salida de pseudoreferencia
<a name="scenario-output-with-ref-and-pseudo-ref"></a>

Este ejemplo muestra una sección `Outputs` con dos asignaciones de salida. Una se basa en un recurso y la otra se basa en una pseudoreferencia.

### JSON
<a name="quickref-general-example-13.json"></a>

```
1. "Outputs" : {
2.    "SNSTopic" : { "Value" : { "Ref" : "MyNotificationTopic" } },
3.    "StackName" : { "Value" : { "Ref" : "AWS::StackName" } }
4. }
```

### YAML
<a name="quickref-general-example-13.yaml"></a>

```
1. Outputs:
2.   SNSTopic:
3.     Value: !Ref MyNotificationTopic
4.   StackName:
5.     Value: !Ref AWS::StackName
```

## Sección Outputs con una salida basada en una función, una cadena literal, una referencia y un pseudoparámetro
<a name="scenario-output-with-complex-spec"></a>

Este ejemplo muestra una sección Outputs con una asignación de salida. La función Join se utiliza para concatenar el valor con un signo de porcentaje como delimitador.

### JSON
<a name="quickref-general-example-14.json"></a>

```
1. "Outputs" : {
2.     "MyOutput" : {
3.         "Value" : { "Fn::Join" :
4.             [ "%", [ "A-string", {"Ref" : "AWS::StackName" } ] ]
5.         }
6.     }
7. }
```

### YAML
<a name="quickref-general-example-14.yaml"></a>

```
1. Outputs:
2.   MyOutput:
3.     Value: !Join [ %, [ 'A-string', !Ref 'AWS::StackName' ]]
```

## Versión de formato de plantilla
<a name="scenario-format-version"></a>

El siguiente fragmento de código muestra una declaración válida de sección `AWSTemplateFormatVersion`.

### JSON
<a name="quickref-general-example-9.json"></a>

```
1. "AWSTemplateFormatVersion" : "2010-09-09"
```

### YAML
<a name="quickref-general-example-9.yaml"></a>

```
1. AWSTemplateFormatVersion: '2010-09-09'
```

## Propiedad Tags de AWS
<a name="scenario-format-aws-tag"></a>

En este ejemplo se muestra una propiedad `Tags` de AWS. Esta propiedad se especifica dentro de la sección Properties de un recurso. Cuando se crea el recurso, se etiqueta con las etiquetas que usted declare.

### JSON
<a name="quickref-general-example-15.json"></a>

```
 1. "Tags" : [
 2.       {
 3.         "Key" : "keyname1",
 4.         "Value" : "value1"
 5.       },
 6.       {
 7.         "Key" : "keyname2",
 8.         "Value" : "value2"
 9.       }
10.     ]
```

### YAML
<a name="quickref-general-example-15.yaml"></a>

```
1. Tags: 
2.   - 
3.     Key: "keyname1"
4.     Value: "value1"
5.   - 
6.     Key: "keyname2"
7.     Value: "value2"
```