使用 CloudFormation提供的參數類型參考現有的資源和 Systems Manager 參數

建立範本時，您可以使用 提供的專用參數類型，建立參數，要求使用者輸入現有 AWS 資源或 Systems Manager 參數的識別碼 CloudFormation。

概觀

在 中 CloudFormation，您可以在堆疊建立或更新期間提供輸入值，藉此使用參數來自訂堆疊。此功能可讓您的範本在不同案例之間重複使用和靈活。

參數定義於 範本的 CloudFormation Parameters區段。每個參數都有一個名稱和一個類型，並且可以有額外的設定，例如預設值和允許的值。如需詳細資訊，請參閱Parameters CloudFormation 範本的 區段語法參考。

參數類型決定參數可接受之輸入值的類型。例如， Number只接受數值，而 String接受文字輸入。

CloudFormation 提供數種額外的參數類型，您可以在範本中使用，以參考現有的 AWS 資源和 Systems Manager 參數。

這些參數類型分為兩個類別：

在Parameters區段中定義參數後，您可以使用 Ref函數在整個 CloudFormation 範本中參考參數值。

範例

下列範例顯示使用下列參數類型的範本。

若要從此範本建立堆疊，您必須從您的帳戶指定現有的 VPC ID、子網路 ID 和金鑰對名稱。您也可以指定參考所需 AMI ID 的現有參數存放區金鑰，或保留預設值 /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2。此公有參數是最新 Amazon Linux 2 的區域 AMI ID 別名AMI。如需公有參數的詳細資訊，請參閱 AWS Systems Manager 使用者指南 中的探索參數存放區中的公有參數。

{
    "Parameters": {
        "VpcId": {
            "Description": "ID of an existing Virtual Private Cloud (VPC).",
            "Type": "AWS::EC2::VPC::Id"
        },
        "PublicSubnetId": {
            "Description": "ID of an existing public subnet within the specified VPC.",
            "Type": "AWS::EC2::Subnet::Id"
        },
        "KeyName": {
            "Description": "Name of an existing EC2 key pair to enable SSH access to the instance.",
            "Type": "AWS::EC2::KeyPair::KeyName"
        },
        "AMIId": {
            "Description": "Name of a Parameter Store parameter that stores the ID of the Amazon Machine Image (AMI).",
            "Type": "AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>",
            "Default": "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2"
        }
    },
    "Resources": {
        "InstanceSecurityGroup": {
            "Type": "AWS::EC2::SecurityGroup",
            "Properties": {
                "GroupDescription": "Enable SSH access via port 22",
                "VpcId": { "Ref": "VpcId" },
                "SecurityGroupIngress": [
                    {
                        "IpProtocol": "tcp",
                        "FromPort": 22,
                        "ToPort": 22,
                        "CidrIp": "0.0.0.0/0"
                    }
                ]
            }
        },
        "Ec2Instance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "KeyName": { "Ref": "KeyName" },
                "ImageId": { "Ref": "AMIId" },
                "NetworkInterfaces": [
                    {
                        "AssociatePublicIpAddress": "true",
                        "DeviceIndex": "0",
                        "SubnetId": { "Ref": "PublicSubnetId" },
                        "GroupSet": [{ "Ref": "InstanceSecurityGroup" }]
                    }
                ]
            }
        }
    },
    "Outputs": {
        "InstanceId": {
            "Value": { "Ref": "Ec2Instance" }
        }
    }
}

Parameters:
  VpcId:
    Description: ID of an existing Virtual Private Cloud (VPC).
    Type: 'AWS::EC2::VPC::Id'
  PublicSubnetId:
    Description: ID of an existing public subnet within the specified VPC.
    Type: 'AWS::EC2::Subnet::Id'
  KeyName:
    Description: Name of an existing EC2 KeyPair to enable SSH access to the instance.
    Type: 'AWS::EC2::KeyPair::KeyName' 
  AMIId:
    Description: Name of a Parameter Store parameter that stores the ID of the Amazon Machine Image (AMI).
    Type: 'AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>'
    Default: '/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2'
Resources:
  InstanceSecurityGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupDescription: Enable SSH access via port 22
      VpcId: !Ref VpcId
      SecurityGroupIngress:
        - IpProtocol: tcp
          FromPort: 22
          ToPort: 22
          CidrIp: 0.0.0.0/0
  Ec2Instance:
    Type: 'AWS::EC2::Instance'
    Properties:
      KeyName: !Ref KeyName
      ImageId: !Ref AMIId
      NetworkInterfaces:
        - AssociatePublicIpAddress: "true"
          DeviceIndex: "0"
          SubnetId: !Ref PublicSubnetId
          GroupSet:
            - !Ref InstanceSecurityGroup
Outputs:
  InstanceId:
    Value: !Ref Ec2Instance

AWS CLI 命令來建立堆疊

下列項目 create-stack 命令會根據範例範本建立堆疊。

aws cloudformation create-stack --stack-name MyStack \
  --template-body file://sampletemplate.json \
  --parameters \
ParameterKey="VpcId",ParameterValue="vpc-a123baa3" \
ParameterKey="PublicSubnetId",ParameterValue="subnet-123a351e" \
ParameterKey="KeyName",ParameterValue="MyKeyName" \
ParameterKey="AMIId",ParameterValue="MyParameterKey"

若要使用接受字串清單的參數類型，例如 List<AWS::EC2::Subnet::Id>，您必須ParameterValue使用雙反斜線逸出 內的逗號，如下列範例所示。

--parameters ParameterKey="SubnetIDs",ParameterValue="subnet-5ea0c127\\,subnet-6194ea3b\\,subnet-c87f2be0"

考量事項

強烈建議您使用動態參考來限制存取敏感組態定義，例如第三方憑證。如需詳細資訊，請參閱使用動態引用獲取存儲在其他服務中的值。

如果您想要允許範本使用者指定來自不同 的值 AWS 帳戶，請勿使用 AWS特定的參數類型。反之，請定義類型 String或 的參數CommaDelimitedList。

Systems Manager 參數類型需要記住幾件事：

支援的 AWS特定參數類型

CloudFormation 支援下列 AWS特定類型：

支援的 Systems Manager 參數類型

CloudFormation 支援下列 Systems Manager 參數類型：

不支援的 Systems Manager 參數類型

CloudFormation 不支援下列 Systems Manager 參數類型：

此外， CloudFormation 不支援將範本參數定義為 SecureString Systems Manager 參數類型。不過，您可以將安全字串指定為特定資源的參數值。如需詳細資訊，請參閱使用動態引用獲取存儲在其他服務中的值。