Especificação do recurso AWS CloudFormation

A especificação do recurso do AWS CloudFormation é um arquivo de texto em formato JSON que define os recursos e as propriedades que o AWS CloudFormation aceita. O documento é uma especificação fortemente tipada, legível por máquina legível, que você pode usar para construir ferramentas para a criação de modelos AWS CloudFormation. Por exemplo, você pode usar a especificação para criar automaticamente a funcionalidade de preenchimento automático e de validação para modelos AWS CloudFormation em seu IDE (Ambiente de desenvolvimento integrado).

A especificação do recurso é organizado como um arquivo único e como uma série de arquivos, em que cada arquivo contém a definição de um tipo de recurso. Os arquivos únicos e os separados contêm informações idênticas. Dependendo da ferramenta e da implantação, use o arquivo ou os arquivos que servem para você.

Para fazer download da especificação do recurso, consulte a tabela a seguir.

A disponibilidade de recursos pode variar de acordo com a região. Para verificar a disponibilidade de um recurso em uma determinada região, consulte a especificação do recurso para a região em questão.

Especificação de recurso
Nome da região	Região	Arquivo único	Todos os arquivos
Leste dos EUA (Ohio)	us-east-2	.json	.zip
Leste dos EUA (Norte da Virgínia)	us-east-1	.json	.zip
Oeste dos EUA (N. da Califórnia)	us-west-1	.json	.zip
Oeste dos EUA (Oregon)	us-west-2	.json	.zip
África (Cidade do Cabo)	af-south-1	.json	.zip
Ásia-Pacífico (Hong Kong)	ap-east-1	.json	.zip
Ásia-Pacífico (Hyderabad)	ap-south-2	.json	.zip
Ásia-Pacífico (Jacarta)	ap-southeast-3	.json	.zip
Ásia-Pacífico (Melbourne)	ap-southeast-4	.json	.zip
Ásia-Pacífico (Mumbai)	ap-south-1	.json	.zip
Ásia-Pacífico (Osaka)	ap-northeast-3	.json	.zip
Ásia-Pacífico (Seul)	ap-northeast-2	.json	.zip
Ásia-Pacífico (Singapura)	ap-southeast-1	.json	.zip
Ásia-Pacífico (Sydney)	ap-southeast-2	.json	.zip
Ásia-Pacífico (Tóquio)	ap-northeast-1	.json	.zip
Canadá (Central)	ca-central-1	.json	.zip
Oeste do Canadá (Calgary)	ca-west-1	.json	.zip
China (Pequim)	cn-north-1	.json	.zip
China (Ningxia)	cn-northwest-1	.json	.zip
Europa (Frankfurt)	eu-central-1	.json	.zip
Europa (Irlanda)	eu-west-1	.json	.zip
Europa (Londres)	eu-west-2	.json	.zip
Europa (Milão)	eu-south-1	.json	.zip
Europa (Paris)	eu-west-3	.json	.zip
Europa (Espanha)	eu-south-2	.json	.zip
Europa (Estocolmo)	eu-north-1	.json	.zip
Europa (Zurique)	eu-central-2	.json	.zip
Israel (Tel Aviv)	il-central-1	.json	.zip
Oriente Médio (Barém)	me-south-1	.json	.zip
Oriente Médio (Emirados Árabes Unidos)	me-central-1	.json	.zip
América do Sul (São Paulo)	sa-east-1	.json	.zip
AWS GovCloud (Leste dos EUA)	us-gov-east-1	.json	.zip
AWS GovCloud (Oeste dos EUA)	us-gov-west-1	.json	.zip

O seguinte exemplo mostra a especificação para o recurso de chave do AWS Key Management Service (AWS::KMS::Key). Ele mostra as propriedades do recurso AWS::KMS::Key, as propriedades necessárias, o tipo de valor permitido para cada propriedade e seu comportamento de atualização. Para obter detalhes sobre a especificação, consulte Formato de especificação.

    "AWS::KMS::Key": {
      "Attributes": {
        "Arn": {
          "PrimitiveType": "String"
        }
      },
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html",
      "Properties": {
        "Description": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "EnableKeyRotation": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "Enabled": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "KeyPolicy": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy",
          "PrimitiveType": "Json",
          "Required": true,
          "UpdateType": "Mutable"
        },
        "KeyUsage": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Immutable"
        }
      }
    }