伪参数参考
伪参数是 Amazon CloudFormation 预定义的参数。请您不要在您的模板中声明它们。采用跟参数一样的方法来将其他们用作 Ref
函数的参数。
示例
以下代码段将 AWS::Region
伪参数的值分配给输出值:
JSON
"Outputs" : { "MyStacksRegion" : { "Value" : { "Ref" : "AWS::Region" } } }
YAML
Outputs: MyStacksRegion: Value: !Ref "AWS::Region"
AWS::AccountId
返回在其中创建堆栈的账户的 Amazon 账户 ID,如 123456789012
。
AWS::NotificationARNs
返回当前堆栈的通知Amazon 资源名称(ARN) 列表。
要从列表中获取单个 ARN,请使用 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
如果在 Fn::If
内部函数中指定为返回值,则删除相应的资源属性。
例如,如果要在仅当提供了快照 ID 时使用 Amazon RDS 数据库实例的快照,您可以使用 AWS::NoValue
参数。如果 UseDBSnapshot
条件计算为 true,则 CloudFormation 对 DBSnapshotIdentifier
属性使用 DBSnapshotName
参数值。如果条件计算为 false,则 CloudFormation 删除 DBSnapshotIdentifier
属性。
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
返回资源所处的分区。对于标准 Amazon 区域,分区是 aws
。对于位于其他分区中的资源,则分区是 aws-
partitionname
。例如,中国(北京和宁夏)区域中的资源的分区为 aws-cn
,Amazon GovCloud(US-West)区域中的资源的分区为 aws-us-gov
。
AWS::Region
返回代表在其中创建包容性资源的区域的字符串,如 us-west-2
。
AWS::StackId
返回使用 aws cloudformation create-stack
命令指定的堆栈的 ID,如 arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123
。
AWS::StackName
返回使用 aws cloudformation create-stack
命令指定的堆栈的名称,如 teststack
。
AWS::URLSuffix
返回某个域的后缀。后缀通常是 amazonaws.com
,但也可能根据区域而不同。例如,中国(北京) 区域的后缀为 amazonaws.com.cn
。