Atributo Condition

Para criar recursos no CloudFormation com base em condições, declare primeiro sua condição na seção Conditions do modelo. Em seguida, use a chave Condition junto com o ID lógico da condição como um atributo no recurso. O CloudFormation cria o recurso somente quando a condição é avaliada como verdadeira. Isso permite controlar a criação de recursos com base em critérios ou parâmetros específicos definidos no modelo.

Se você é novato no uso de condições em seus modelos, recomendamos revisar primeiro o tópico sobre sintaxe de condições do modelo do CloudFormation no Guia do usuário do AWS CloudFormation.

nota

Se um recurso com uma condição não for criado, nenhum recurso que dependa desse recurso será criado, independentemente das suas próprias condições.

Exemplo

O modelo a seguir contém um recurso de bucket do Amazon S3 com um atributo Condition. O bucket só será criado se a condição CreateBucket for avaliada como true.

JSON

{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Parameters" : {
      "EnvType" : {
         "Type" : "String",
         "AllowedValues" : ["prod", "dev"],
         "Default" : "dev",
         "Description" : "Environment type"
      }
   },
   "Conditions" : {
      "CreateBucket" : {"Fn::Equals" : [{"Ref" : "EnvType"}, "prod"]}
   },
   "Resources" : {
      "MyBucket" : {
         "Type" : "AWS::S3::Bucket",
         "Condition" : "CreateBucket",
         "Properties" : {
            "BucketName" : {"Fn::Join" : ["-", ["mybucket", {"Ref" : "EnvType"}]]}
         }
      }
   }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Parameters:
  EnvType:
    Type: String
    AllowedValues:
      - prod
      - dev
    Default: dev
    Description: Environment type
Conditions:
  CreateBucket: !Equals [!Ref EnvType, prod]
Resources:
  MyBucket:
    Type: AWS::S3::Bucket
    Condition: CreateBucket
    Properties:
      BucketName: !Sub mybucket-${EnvType}

Uso de várias condições

É possível combinar várias condições usando funções intrínsecas como Fn::And, Fn::Or e Fn::Not para criar uma lógica condicional mais complexa.

JSON

{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Parameters" : {
      "EnvType" : {
         "Type" : "String",
         "AllowedValues" : ["prod", "test", "dev"],
         "Default" : "dev",
         "Description" : "Environment type"
      },
      "CreateResources" : {
         "Type" : "String",
         "AllowedValues" : ["true", "false"],
         "Default" : "true",
         "Description" : "Create resources flag"
      }
   },
   "Conditions" : {
      "IsProd" : {"Fn::Equals" : [{"Ref" : "EnvType"}, "prod"]},
      "IsTest" : {"Fn::Equals" : [{"Ref" : "EnvType"}, "test"]},
      "CreateResourcesFlag" : {"Fn::Equals" : [{"Ref" : "CreateResources"}, "true"]},
      "CreateProdResources" : {"Fn::And" : [{"Condition" : "IsProd"}, {"Condition" : "CreateResourcesFlag"}]},
      "CreateTestOrDevResources" : {"Fn::And" : [{"Fn::Or" : [{"Condition" : "IsTest"}, {"Fn::Not" : [{"Condition" : "IsProd"}]}]}, {"Condition" : "CreateResourcesFlag"}]}
   },
   "Resources" : {
      "ProdBucket" : {
         "Type" : "AWS::S3::Bucket",
         "Condition" : "CreateProdResources",
         "Properties" : {
            "BucketName" : {"Fn::Join" : ["-", ["prod-bucket", {"Ref" : "AWS::StackName"}]]}
         }
      },
      "TestDevBucket" : {
         "Type" : "AWS::S3::Bucket",
         "Condition" : "CreateTestOrDevResources",
         "Properties" : {
            "BucketName" : {"Fn::Join" : ["-", [{"Ref" : "EnvType"}, "bucket", {"Ref" : "AWS::StackName"}]]}
         }
      }
   }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Parameters:
  EnvType:
    Type: String
    AllowedValues:
      - prod
      - test
      - dev
    Default: dev
    Description: Environment type
  CreateResources:
    Type: String
    AllowedValues:
      - 'true'
      - 'false'
    Default: 'true'
    Description: Create resources flag
Conditions:
  IsProd: !Equals [!Ref EnvType, prod]
  IsTest: !Equals [!Ref EnvType, test]
  CreateResourcesFlag: !Equals [!Ref CreateResources, 'true']
  CreateProdResources: !And
    - !Condition IsProd
    - !Condition CreateResourcesFlag
  CreateTestOrDevResources: !And
    - !Or
      - !Condition IsTest
      - !Not [!Condition IsProd]
    - !Condition CreateResourcesFlag
Resources:
  ProdBucket:
    Type: AWS::S3::Bucket
    Condition: CreateProdResources
    Properties:
      BucketName: !Sub prod-bucket-${AWS::StackName}
  TestDevBucket:
    Type: AWS::S3::Bucket
    Condition: CreateTestOrDevResources
    Properties:
      BucketName: !Sub ${EnvType}-bucket-${AWS::StackName}

Usar AWS::AccountId em condições

É possível usar pseudoparâmetros como AWS::AccountId em suas condições para criar recursos com base na Conta da AWS em que a pilha está sendo implantada. Isso é útil para implantações de várias contas ou quando você precisa excluir contas específicas do recebimento de determinados recursos. Para obter mais informações sobre pseudoparâmetros, consulte Obter valores da AWS usando pseudoparâmetros no Guia do usuário do AWS CloudFormation.

JSON

{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Conditions" : {
      "ExcludeAccount1" : {"Fn::Not" : [{"Fn::Equals" : [{"Ref" : "AWS::AccountId"}, "111111111111"]}]},
      "ExcludeAccount2" : {"Fn::Not" : [{"Fn::Equals" : [{"Ref" : "AWS::AccountId"}, "222222222222"]}]},
      "ExcludeBothAccounts" : {"Fn::And" : [{"Condition" : "ExcludeAccount1"}, {"Condition" : "ExcludeAccount2"}]}
   },
   "Resources" : {
      "StandardBucket" : {
         "Type" : "AWS::S3::Bucket",
         "Properties" : {
            "BucketName" : {"Fn::Join" : ["-", ["standard-bucket", {"Ref" : "AWS::StackName"}]]}
         }
      },
      "RestrictedResource" : {
         "Type" : "AWS::SNS::Topic",
         "Condition" : "ExcludeBothAccounts",
         "Properties" : {
            "TopicName" : {"Fn::Join" : ["-", ["restricted-topic", {"Ref" : "AWS::StackName"}]]}
         }
      }
   }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Conditions:
  ExcludeAccount1: !Not [!Equals [!Ref 'AWS::AccountId', '111111111111']]
  ExcludeAccount2: !Not [!Equals [!Ref 'AWS::AccountId', '222222222222']]
  ExcludeBothAccounts: !And
    - !Condition ExcludeAccount1
    - !Condition ExcludeAccount2
Resources:
  StandardBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Sub standard-bucket-${AWS::StackName}
  RestrictedResource:
    Type: AWS::SNS::Topic
    Condition: ExcludeBothAccounts
    Properties:
      TopicName: !Sub restricted-topic-${AWS::StackName}