

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# Mengatur CloudFormation parameter dengan `AWS::CloudFormation::Interface` metadata
<a name="aws-cloudformation-interface"></a>

`AWS::CloudFormation::Interface`adalah kunci metadata yang mendefinisikan bagaimana parameter dikelompokkan dan diurutkan di konsol. CloudFormation Secara default, konsol mencantumkan parameter input dalam urutan abjad berdasarkan ID logisnya saat Anda membuat atau memperbarui tumpukan di konsol. Dengan menggunakan kunci ini, Anda dapat menentukan pengelompokan parameter dan pengurutan Anda sendiri agar pengguna dapat secara efisien menentukan nilai parameter. Misalnya, Anda bisa mengelompokkan semua parameter terkait EC2 di satu grup dan semua parameter yerkait VPC di grup lain.

Pada kunci metadata, Anda dapat menentukan grup yang akan dibuat, parameter yang akan disertakan di setiap grup, dan urutan saat konsol menampilkan setiap parameter dalam kelompoknya. 

Anda juga dapat menentukan label untuk parameter. Label adalah nama atau deskripsi yang mudah dimengerti yang ditampilkan oleh konsol sebagai pengganti ID logis parameter. Label berguna untuk membantu pengguna memahami nilai yang ditentukan untuk setiap parameter. Misalnya, Anda dapat melabeli parameter `KeyPair` `Select an EC2 key pair`.

Semua parameter yang Anda referensikan dalam kunci metadata harus dinyatakan dalam `Parameters` bagian dari template.

**catatan**  
Hanya CloudFormation konsol yang menggunakan kunci `AWS::CloudFormation::Interface` metadata. AWS CLI dan panggilan API tidak menggunakan kunci ini.

## Sintaksis
<a name="aws-resource-cloudformation-interface-syntax"></a>

Untuk mendeklarasikan entitas ini di CloudFormation template Anda, gunakan sintaks berikut:

### JSON
<a name="aws-resource-cloudformation-interface-syntax.json"></a>

```
"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups": [
      {
        "Label": {
          "default": "Group Label"
        },
        "Parameters": [
          "Parameter1",
          "Parameter2"
        ]
      }
    ],
    "ParameterLabels": {
      "Parameter1": {
        "default": "Friendly Name for Parameter1"
      }
    }
  }
}
```

### YAML
<a name="aws-resource-cloudformation-interface-syntax.yaml"></a>

```
Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - Label:
          default: Group Label
        Parameters:
          - Parameter1
          - Parameter2
    ParameterLabels:
      Parameter1:
        default: Friendly Name for Parameter1
```

## Sifat-sifat
<a name="w2aac11c23c29c17c17"></a>

`ParameterGroups`  
Daftar jenis grup parameter, di mana Anda menentukan nama grup, parameter di setiap grup, dan urutan parameter yang ditampilkan.  
*Wajib*: Tidak    
`Label`  
Nama untuk grup parameter.  
*Wajib*: Tidak  
`default`  
Label default yang digunakan CloudFormation konsol untuk memberi nama grup parameter.  
*Wajib*: Tidak  
*Tipe*: String  
`Parameters`  
Daftar parameter case-sensitive logis IDs untuk disertakan dalam grup. Parameter harus sudah didefinisikan dalam `Parameters` bagian dari templat. Parameter dapat dimasukkan hanya dalam satu kelompok parameter.  
Konsol mencantumkan parameter yang tidak Anda kaitkan dengan grup parameter dalam urutan abjad di `Other parameters` grup.  
*Wajib*: Tidak  
*Jenis*: Daftar nilai String

`ParameterLabels`  
Pemetaan parameter dan nama ramahnya yang ditampilkan CloudFormation konsol saat tumpukan dibuat atau diperbarui.  
*Wajib*: Tidak    
Label parameter  
Label untuk parameter. Label mendefinisikan nama atau deskripsi ramah yang ditampilkan CloudFormation konsol di halaman **Tentukan Parameter** saat tumpukan dibuat atau diperbarui. Label parameter harus berupa ID logis peka huruf besar/kecil dari parameter yang valid yang telah dideklarasikan di `Parameters` bagian template.  
*Wajib*: Tidak  
`default`  
Label default yang digunakan CloudFormation konsol untuk memberi nama parameter.  
*Wajib*: Tidak  
*Tipe*: String

## Contoh
<a name="w2aac11c23c29c17c19"></a>

Contoh berikut menentukan dua grup parameter: `Network Configuration` dan `Amazon EC2 Configuration`. Grup `Network Configuration` mencakup parameter `VPCID`, `SubnetId`, dan `SecurityGroupID`, yang ditentukan di bagian `Parameters` dari templat (tidak ditampilkan). Urutan di mana konsol menunjukkan parameter ini ditentukan berdasarkan urutan parameter yang tercantum, yang dimulai dengan parameter `VPCID`. Contoh secara identik mengelompokkan dan mengurutkan parameter `Amazon EC2 Configuration`.

Contoh ini juga menentukan label untuk parameter `VPCID`. Konsol akan menunjukkan **Di VPC mana ini harus di-deploy?** dan bukan ID logis parameter (`VPCID`).

### JSON
<a name="aws-cloudformation-interface-example.json"></a>

```
"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
<a name="aws-cloudformation-interface-example.yaml"></a>

```
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?"
```

### Grup parameter di konsol
<a name="w2aac11c23c29c17c19c11"></a>

Penggunaan kunci metadata dari contoh ini, gambar berikut menunjukkan cara konsol menampilkan grup parameter saat tumpukan dibuat atau diperbarui: **Grup parameter di konsol** 

![\[Konsol menunjukkan grup parameter untuk contoh ini.\]](http://docs.aws.amazon.com/id_id/AWSCloudFormation/latest/UserGuide/images/console-create-stack-parameter-groups.png)
