Referência de propriedades de configuração DO AWS CloudFormation

A ação do AWS CloudFormation que o CodePipeline invoca ao processar o estágio associado. Escolha um dos seguintes modos de ação:

O nome associado a uma pilha existente ou a uma pilha que você deseja criar. O nome deve ser exclusivo na região da AWS em que você está criando a pilha.

O nome de um conjunto de alterações existente ou um novo conjunto de alterações que você deseja criar para a pilha especificada.

O local de um arquivo de modelo do AWS CloudFormation, que segue o formato ArtifactName::TemplateFileName.

O local de um arquivo de configuração do modelo, que segure o formato ArtifactName::TemplateConfigurationFileName. O arquivo de configuração de modelo pode conter valores de parâmetros do modelo, uma política de pilha e tags. Se você incluir informações confidenciais, como senhas, restrinja o acesso a este arquivo. Para ter mais informações, consulte Artefatos do AWS CloudFormation.

Para pilhas que contêm determinados recursos, confirme explicitamente que o AWS CloudFormation pode criar ou atualizar esses recursos. Por exemplo, especifique CAPABILITY_IAM se o modelo da pilha contiver recursos do AWS Identity and Access Management (IAM). Para obter mais informações, consulte os parâmetros de solicitação da operação da API CreateStack.

Se houver recursos do IAM no modelo de pilha, especifique essa propriedade.

Você pode especificar mais de uma funcionalidade.

O nome do perfil de serviço do IAM que o AWS CloudFormation assume quando ele opera em recursos na pilha especificada.

Na seção Advanced (Avançado), você pode especificar um nome de arquivo de saída, como CreateStackOutput.json, que o CodePipeline adiciona ao artefato de saída depois de executar a ação especificada. O artefato de saída contém um arquivo JSON com o conteúdo da seção Outputs do modelo AWS CloudFormation.

Se você não especificar um nome, o CodePipeline não gerará um artefato de saída.

Os parâmetros são definidos em seu modelo e permitem que você insira valores personalizados ao criar ou atualizar uma pilha. É possível especificar um objeto JSON que substitui os valores dos parâmetros do modelo no arquivo de configuração do modelo. Todos os nomes de parâmetros devem estar presentes no modelo de pilha. Para obter mais informações, consulte Definir um parâmetro em um modelo.

Recomendamos que você use o arquivo de configuração do modelo para especificar a maioria dos valores de parâmetro. Use substituições de parâmetros para especificar somente valores de parâmetros dinâmicos. Os parâmetros dinâmicos são desconhecidos até que você execute o pipeline.

O exemplo a seguir define um valor para o parâmetro ParameterName usando uma função de substituição de parâmetro. A função recupera um valor de um artefato de entrada do CodePipeline. Para obter mais informações sobre funções de substituição de parâmetros, consulte Usar funções de substituição de parâmetros com pipelines CodePipeline.

{
  "ParameterName" : { "Fn::GetParam" : ["ArtifactName", "config-file-name.json", "ParamName"]}
}

A ação do AWS CloudFormation que o CodePipeline invoca ao processar o estágio associado. Especifique apenas um dos seguintes modos de ação:

Essa propriedade é obrigatória.

Para pilhas que contêm determinados recursos, confirme explicitamente que o AWS CloudFormation pode criar ou atualizar esses recursos. Por exemplo, especifique CAPABILITY_IAM se o modelo da pilha contiver recursos do AWS Identity and Access Management (IAM). Para obter mais informações, consulte os parâmetros de solicitação da operação da API CreateStack.

Essa propriedade é condicional. Se houver recursos do IAM no modelo de pilha, especifique essa propriedade.

Você pode especificar várias funcionalidades. O exemplo a seguir adiciona as propriedades CAPABILITY_IAM e CAPABILITY_AUTO_EXPAND ao modelo:

O nome de um conjunto de alterações existente ou um novo conjunto de alterações que você deseja criar para a pilha especificada.

Essa propriedade é necessária para os seguintes modos de ação: CHANGE_SET_REPLACE e CHANGE_SET_EXECUTE. Para todos os outros modos de ação, essa propriedade será ignorado.

Um nome para o arquivo de saída, como CreateStackOutput.json. O CodePipeline adiciona o arquivo ao artefato de saída depois de executar a ação especificada. O artefato de saída contém um arquivo JSON com o conteúdo da seção Outputs do modelo AWS CloudFormation.

Essa propriedade é opcional. Se você não especificar um nome, o CodePipeline não gerará um artefato de saída.

Os parâmetros são definidos em seu modelo e permitem que você insira valores personalizados ao criar ou atualizar uma pilha. É possível especificar um objeto JSON que substitui os valores dos parâmetros do modelo no arquivo de configuração do modelo. Todos os nomes de parâmetros devem estar presentes no modelo de pilha. Para obter mais informações, consulte Definir um parâmetro em um modelo.

O exemplo a seguir adiciona as substituições dos parâmetros KeyName e InstanceType ao modelo:

Recomendamos que você use o arquivo de configuração do modelo para especificar a maioria dos valores de parâmetro. Use substituições de parâmetros para especificar somente valores de parâmetros dinâmicos. Os valores dos parâmetros dinâmicos são desconhecidos até que você execute o pipeline.

O exemplo a seguir define um valor para o parâmetro ParameterName usando uma função de substituição de parâmetro. A função recupera um valor de um artefato de entrada do CodePipeline. Para obter mais informações sobre funções de substituição de parâmetros, consulte Usar funções de substituição de parâmetros com pipelines CodePipeline.

{
  "ParameterName" : { "Fn::GetParam" : ["ArtifactName", "config-file-name.json", "ParamName"]}
}

Essa propriedade é opcional.

O nome do recurso da Amazon (ARN) do perfil de serviço do IAM que o AWS CloudFormation assume quando ele funciona com recursos em uma pilha.

Essa propriedade é necessária para os seguintes modos de ação: CREATE_UPDATE, REPLACE_ON_FAILURE, DELETE_ONLY e CHANGE_SET_REPLACE. RoleArn não é aplicado ao executar um conjunto de alterações. Se você não usar o CodePipeline para criar o conjunto de alterações, verifique se o conjunto de alterações ou a pilha está associada a uma função.

O nome de uma pilha existente ou de uma pilha que você deseja criar.

Essa propriedade é necessária para todos os modos de ação.

TemplateConfiguration é o arquivo de configuração do modelo. Inclua o arquivo em um artefato de entrada para essa ação. O nome do arquivo de configuração de modelo segue este formato:

Artifactname::TemplateConfigurationFileName

Artifactname é o nome do artefato de entrada, da forma como aparece no CodePipeline. Por exemplo, um estágio de origem com o nome de artefato de SourceArtifact e um nome de arquivo de test-configuration.json cria um nome TemplateConfiguration, conforme mostrado neste exemplo:

"TemplateConfiguration": "SourceArtifact::test-configuration.json"

O arquivo de configuração de modelo pode conter valores de parâmetro do modelo e uma política de pilha. Se você incluir informações confidenciais, como senhas, restrinja o acesso a este arquivo. Para obter um exemplo de arquivo de configuração de modelo, consulte Artefatos do AWS CloudFormation.

Essa propriedade é opcional.

TemplatePath representa o arquivo de modelo do AWS CloudFormation. Inclua o arquivo em um artefato de entrada para essa ação. O nome do arquivo segue este formato:

Artifactname::TemplateFileName

Artifactname é o nome do artefato de entrada, da forma como aparece no CodePipeline. Por exemplo, um estágio de origem com o nome de artefato de SourceArtifact e um nome de arquivo de template.yaml cria um nome TemplatePath, conforme mostrado neste exemplo:

"TemplatePath": "SourceArtifact::template.yaml"

Essa propriedade é necessária para os seguintes modos de ação: CREATE_UPDATE, REPLACE_ON_FAILURE e CHANGE_SET_REPLACE. Para todos os outros modos de ação, essa propriedade será ignorado.