DeploymentPreference

Especifica as configurações para permitir implantações graduais do Lambda. Para obter mais informações sobre como configurar implantações graduais do Lambda, consulte Implantação gradual de aplicativos com tecnologia sem servidor.

nota

Você deve especificar um AutoPublishAlias em seu AWS::Serverless::Function para usar um objeto DeploymentPreference, caso contrário, ocorrerá um erro.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

  Alarms: List
  Enabled: Boolean
  Hooks: Hooks
  PassthroughCondition: Boolean
  Role: String
  TriggerConfigurations: List
  Type: String

Propriedades

Alarms

Uma lista de CloudWatch alarmes que você deseja que sejam acionados por quaisquer erros gerados pela implantação.

Essa propriedade aceita a função intrínseca Fn::If. Consulte a seção Exemplos na parte inferior deste tópico para ver um exemplo de modelo que usa Fn::If.

Tipo: lista

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Enabled

Se essa preferência de implantação está habilitada.

Tipo: booliano

Obrigatório: não

Padrão: verdadeiro

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Hooks

Funções de validação do Lambda que são executadas antes e depois da mudança de tráfego.

Tipo: Ganchos

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

PassthroughCondition

Se for True, e se essa preferência de implantação estiver ativada, a Condição da função será passada para o CodeDeploy recurso gerado. Geralmente, você deve definir isso como Verdadeiro. Caso contrário, o CodeDeploy recurso seria criado mesmo se a Condição da função fosse resolvida como False.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Role

Um ARN de função do IAM que CodeDeploy será usado para mudança de tráfego. Um perfil do IAM não será criado se ele for fornecido.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

TriggerConfigurations

Uma lista das configurações de gatilho que você deseja associar ao grupo de implantação. Usado para notificar um tópico do SNS sobre eventos do ciclo de vida.

Tipo: lista

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a TriggerConfigurations propriedade de um AWS::CodeDeploy::DeploymentGroup recurso.

Type

No momento, existem duas categorias de tipos de implantação: Linear e Canário. Para obter mais informações sobre os tipos de implantação disponíveis, consulte Implantação gradual de aplicativos com tecnologia sem servidor.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Exemplos

DeploymentPreference com ganchos pré e pós-trânsito.

Exemplo de preferência de implantação que contém ganchos pré e pós-tráfego.

YAML

DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    - Ref: AliasErrorMetricGreaterThanZeroAlarm
    - Ref: LatestVersionErrorMetricGreaterThanZeroAlarm
  Hooks:
    PreTraffic:
      Ref: PreTrafficLambdaFunction
    PostTraffic:
      Ref: PostTrafficLambdaFunction

DeploymentPreference com função intrínseca Fn: :If

Exemplo de preferência de implantação que usa Fn::If para configurar alarmes. Neste exemplo, Alarm1 será configurado se MyCondition for true, Alarm2 e Alarm5 será configurado se MyCondition for false.

YAML

DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    Fn::If:
      - MyCondition
      - - Alarm1
      - - Alarm2
        - Alarm5