AWS::CloudFormation::Interface

AWS::CloudFormation::Interface는 AWS CloudFormation 콘솔에서 파라미터가 그룹화되고 정렬되는 방식을 정의하는 메타데이터 키입니다. 콘솔에서 스택을 생성하거나 업데이트하면 콘솔에는 입력 파라미터가 논리적 ID를 기준으로 사전순으로 나열됩니다. 이 키를 사용하면 사용자가 파라미터 값을 효율적으로 지정할 수 있도록 고유의 파라미터 그룹화 및 정렬을 정의할 수 있습니다. 예를 들어, 모든 EC2 관련 파라미터를 한 그룹으로 그룹화하고 모든 VPC 관련 파라미터를 다른 한 그룹으로 그룹화할 수 있습니다.

파라미터 그룹화 및 정렬 외에도 파라미터의 레이블을 정의할 수 있습니다. 레이블은 파라미터의 논리적 ID 대신 콘솔에 표시되는 표시 이름 또는 설명입니다. 레이블은 사용자가 각 파라미터에 지정할 값을 이해하도록 돕는 데 유용합니다. 예를 들어, KeyPair 파라미터에 Select an EC2 key pair라는 레이블을 지정할 수 있습니다.

참고

CloudFormation 콘솔만 AWS::CloudFormation::Interface 메타데이터 키를 사용합니다. AWS CLI 및 API 호출은 이 키를 사용하지 않습니다.

명령문

CloudFormation 템플릿에서 이 객체를 선언하려면 다음 구문을 사용합니다.

JSON

"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups" : [ ParameterGroup, ... ],
    "ParameterLabels" : ParameterLabel
  }
}

YAML

Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - ParameterGroup
    ParameterLabels:
      ParameterLabel

속성

ParameterGroups

그룹 이름, 각 그룹의 파라미터 및 파라미터가 표시되는 순서를 지정하는 파라미터 그룹 유형의 목록입니다.

필수 항목 여부: 아니요

유형: AWS::CloudFormation::Interface ParameterGroup

업데이트 필요 조건: 무중단

ParameterLabels

스택을 생성하거나 업데이트할 때 CloudFormation 콘솔에 표시되는 파라미터 및 해당 표시 이름의 매핑입니다.

필수 항목 여부: 아니요

유형: AWS::CloudFormation::Interface ParameterLabel

업데이트 필요 조건: 무중단

예

다음 예제에서는 Network Configuration 및 Amazon EC2 Configuration이라는 두 개의 파라미터 그룹을 정의합니다. Network Configuration 그룹에는 템플릿(표시되지 않음)의 VPCID 섹션에서 정의되는 SubnetId, SecurityGroupID 및 Parameters 파라미터가 포함됩니다. 이러한 파라미터가 콘솔에 표시되는 순서는 VPCID 파라미터로 시작하여 파라미터가 나열되는 순서에 따라 정의됩니다. 예제에서는 비슷한 방식으로 Amazon EC2 Configuration 파라미터를 그룹화하고 정렬합니다.

예제에서는 VPCID 파라미터의 레이블도 정의합니다. 콘솔에서 파라미터의 논리적 ID(VPCID) 대신 Which VPC should this be deployed to?(어떤 VPC에 배포합니까?)가 표시됩니다.

JSON

"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups" : [
      {
        "Label" : { "default" : "Network Configuration" },
        "Parameters" : [ "VPCID", "SubnetId", "SecurityGroupID" ]
      },
      {
        "Label" : { "default":"Amazon EC2 Configuration" },
        "Parameters" : [ "InstanceType", "KeyName" ]
      }
    ],
    "ParameterLabels" : {
      "VPCID" : { "default" : "Which VPC should this be deployed to?" }
    }
  }
}

YAML

Metadata: 
  AWS::CloudFormation::Interface: 
    ParameterGroups: 
      - 
        Label: 
          default: "Network Configuration"
        Parameters: 
          - VPCID
          - SubnetId
          - SecurityGroupID
      - 
        Label: 
          default: "Amazon EC2 Configuration"
        Parameters: 
          - InstanceType
          - KeyName
    ParameterLabels: 
      VPCID: 
        default: "Which VPC should this be deployed to?"

콘솔의 파라미터 그룹

다음 그림에서는 이 예제의 메타데이터 키를 사용하여 스택을 생성하거나 업데이트할 때 파라미터 그룹이 콘솔에 표시되는 방식을 보여 줍니다. 콘솔의 파라미터 그룹