CloudFormation에서 제공하는 파라미터 유형을 사용하여 런타임 시 기존 리소스 지정

템플릿을 생성할 때 CloudFormation에서 제공하는 특수 파라미터 유형을 사용하여 사용자가 기존 AWS 리소스의 식별자 또는 Systems Manager 파라미터의 식별자를 입력해야 하는 파라미터를 생성할 수 있습니다.

개요

CloudFormation에서 파라미터를 사용하여 스택 생성 또는 업데이트 중에 입력 값을 제공하여 스택을 사용자 지정할 수 있습니다. 이 특성을 통해 템플릿을 다양한 시나리오에서 유연하게 재사용할 수 있습니다.

파라미터는 CloudFormation 템플릿의 Parameters 섹션에 정의되어 있습니다. 파라미터마다 이름과 유형이 있으며, 기본값과 허용되는 값 등의 추가 설정이 있을 수 있습니다. 자세한 내용은 CloudFormation 템플릿 Parameters 구문 단원을 참조하십시오.

파라미터 유형에 따라 파라미터가 허용할 수 있는 입력 값의 종류가 결정됩니다. 예를 들어, Number는 숫자 값만 허용하고 String은 텍스트 입력을 허용합니다.

CloudFormation은 템플릿에서 기존 AWS 리소스 및 Systems Manager 파라미터를 참조하는 데 사용할 수 있는 몇 가지 추가 파라미터 유형을 제공합니다.

이러한 파라미터 유형은 두 가지 범주로 분류됩니다.

Parameters 섹션에 파라미터가 정의되면 Ref 함수를 사용하여 CloudFormation 템플릿 전체에서 파라미터 값을 참조할 수 있습니다.

예제

다음 예에서는 다음 파라미터 유형을 사용하는 템플릿을 보여줍니다.

이 템플릿에서 스택을 생성하려면 계정에서 기존 VPC ID, 서브넷 ID 및 키 페어 이름을 지정해야 합니다. 원하는 AMI ID를 참조하는 기존 Parameter Store 키를 지정하거나 기본값인 /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2를 유지할 수도 있습니다. 이 공용 파라미터는 최신 Amazon Linux 2 AMI의 리전 AMI ID에 대한 별칭입니다. 공용 파라미터에 대한 자세한 내용은 AWS Systems Manager 사용 설명서의 Parameter Store에서 퍼블릭 파라미터 검색을 참조하세요.

{
    "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 파라미터 유형으로 템플릿 파라미터를 정의하는 것을 지원하지 않습니다. 하지만 보안 문자열을 특정 리소스에 대한 파라미터 값으로 지정할 수 있습니다. 자세한 내용은 동적 참조를 사용하여 다른 서비스에 저장된 값 가져오기 단원을 참조하십시오.