Référence des pseudo-paramètres

Filtrer la vue

All

Les pseudo-paramètres sont des paramètres prédéfinis par AWS CloudFormation. Vous ne les déclarez pas dans le modèle. Utilisez-les comme que vous le feriez avec un paramètre, comme argument de la fonction Ref.

exemple

L'extrait suivant affecte la valeur du pseudo-paramètre AWS::Region à une valeur de sortie :

JSON

"Outputs" : {
   "MyStacksRegion" : { "Value" : { "Ref" : "AWS::Region" } }
}

YAML

Outputs:
  MyStacksRegion:
    Value: !Ref "AWS::Region"

AWS::AccountId

Renvoie l' AWS identifiant du compte dans lequel la pile est créée, par exemple123456789012.

AWS::NotificationARNs

Renvoie la liste des notifications Amazon Resource Names (ARNs) pour la pile actuelle.

Pour obtenir un seul ARN à partir de la liste, utilisez Fn::Select.

JSON

"myASGrpOne" : {
   "Type" : "AWS::AutoScaling::AutoScalingGroup",
   "Version" : "2009-05-15",
   "Properties" : {
      "AvailabilityZones" : [ "us-east-1a" ],
      "LaunchConfigurationName" : { "Ref" : "MyLaunchConfiguration" },
      "MinSize" : "0",
      "MaxSize" : "0",
      "NotificationConfigurations" : [{
         "TopicARN" : { "Fn::Select" : [ "0", { "Ref" : "AWS::NotificationARNs" } ] },
         "NotificationTypes" : [ "autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR" ]
      }]
   }
}

YAML

myASGrpOne:
  Type: AWS::AutoScaling::AutoScalingGroup
  Version: '2009-05-15'
  Properties:
    AvailabilityZones:
    - "us-east-1a"
    LaunchConfigurationName:
      Ref: MyLaunchConfiguration
    MinSize: '0'
    MaxSize: '0'
    NotificationConfigurations:
    - TopicARN:
        Fn::Select:
        - '0'
        - Ref: AWS::NotificationARNs
      NotificationTypes:
      - autoscaling:EC2_INSTANCE_LAUNCH
      - autoscaling:EC2_INSTANCE_LAUNCH_ERROR

AWS::NoValue

Supprime la propriété de ressource correspondante lorsqu'elle est spécifiée comme valeur de retour dans la fonction intrinsèque Fn::If.

Par exemple, vous pouvez utiliser le paramètre AWS::NoValue lorsque vous souhaitez employer un instantané pour une instance de base de données Amazon RDS seulement si un ID d'instantané est fourni. Si la UseDBSnapshot condition est vraie, CloudFormation utilise la valeur du DBSnapshotName paramètre de la DBSnapshotIdentifier propriété. Si la condition est fausse, la DBSnapshotIdentifier propriété CloudFormation est supprimée.

JSON

"MyDB" : {
  "Type" : "AWS::RDS::DBInstance",
  "Properties" : {
    "AllocatedStorage" : "5",
    "DBInstanceClass" : "db.t2.small",
    "Engine" : "MySQL",
    "EngineVersion" : "5.5",
    "MasterUsername" : { "Ref" : "DBUser" },
    "MasterUserPassword" : { "Ref" : "DBPassword" },
    "DBParameterGroupName" : { "Ref" : "MyRDSParamGroup" },
    "DBSnapshotIdentifier" : {
      "Fn::If" : [
        "UseDBSnapshot",
        {"Ref" : "DBSnapshotName"},
        {"Ref" : "AWS::NoValue"}
      ]
    }
  }
}

YAML

MyDB:
  Type: AWS::RDS::DBInstance
  Properties:
    AllocatedStorage: '5'
    DBInstanceClass: db.t2.small
    Engine: MySQL
    EngineVersion: '5.5'
    MasterUsername:
      Ref: DBUser
    MasterUserPassword:
      Ref: DBPassword
    DBParameterGroupName:
      Ref: MyRDSParamGroup
    DBSnapshotIdentifier:
      Fn::If:
        - UseDBSnapshot
        - Ref: DBSnapshotName
        - Ref: AWS::NoValue

AWS::Partition

Renvoie la partition dans laquelle se trouve la ressource. Pour les AWS régions standard, la partition estaws. Pour les ressources dans d'autres partitions, la partition est aws-partitionname. Par exemple, la partition pour les ressources dans la région de Chine (Pékin et Ningxia) est aws-cn et la partition pour les ressources dans la région AWS GovCloud (ouest des États-Unis) est. aws-us-gov

AWS::Region

Renvoie une chaîne représentant la région dans laquelle la ressource globale est créée, comme us-west-2.

AWS::StackId

Renvoie l'ID de la pile comme indiqué avec la commande aws cloudformation create-stack (arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123, par exemple).

AWS::StackName

Renvoie le nom de la pile comme indiqué avec la commande aws cloudformation create-stack (teststack, par exemple).

AWS::URLSuffix

Renvoie le suffixe pour un domaine. Le suffixe est en général amazonaws.com, mais il peut varier d'une région à l'autre. Par exemple, le suffixe pour la région Chine (Pékin) est amazonaws.com.cn.