AWS::ResourceGroups::Generic AWS::AppRegistry::Application AWS::CloudFormation::Stack AWS::EC2::CapacityReservationPool AWS::EC2::HostManagement AWS::NetworkFirewall::RuleGroup

支援的組態類型和參數

資源群組支援使用下列組態類型。每個組態類型都有一組對該類型有效的參數。

主題

AWS::ResourceGroups::Generic
AWS::AppRegistry::Application
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup

`AWS::ResourceGroups::Generic`

此組態類型會指定對資源群組強制執行成員資格需求的設定，而不是為 AWS 服務設定特定資源類型的行為。需要此組態類型的服務連結群組會自動新增此組態類型，例如 AWS::EC2::CapacityReservationPool和 AWS::EC2::HostManagment類型。

下列Parameters適用於AWS::ResourceGroups::Generic服務連結群組 Type。

allowed-resource-types

此參數指定資源群組只能包含指定類型或類型的資源。

值的資料類型：字串

允許的值：
- AWS::EC2::Host – 當服務組態也包含類型的時，需要Configuration具有此參數和值Configuration的 AWS::EC2::HostManagement。這可確保HostManagement群組只能包含 Amazon EC2 專用主機。
- AWS::EC2::CapacityReservation – 當服務組態也包含類型 Configuration的項目時，需要Configuration具有此參數和值的 AWS::EC2::CapacityReservationPool。這可確保CapacityReservation群組只能包含 Amazon EC2 容量保留容量。
必要：條件式，根據連接至資源群組的其他Configuration元素。如需允許的值，請參閱先前的項目。

下列範例將群組成員限制為僅限 Amazon EC2 主機執行個體。
```
[
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      }
    ]
  }
]
```
deletion-protection

此參數指定無法刪除資源群組，除非它不包含任何成員。如需詳細資訊，請參閱《 License Manager 使用者指南》中的刪除主機資源群組

值的資料類型：字串陣列

允許的值：唯一允許的值為 [ "UNLESS_EMPTY" ]（值必須為大寫）。

必要：條件式，以連接至資源群組的其他Configuration元素為基礎。只有在資源群組也有另一個具有 Type之的 Configuration元素時，才需要此參數AWS::EC2::HostManagement。

除非群組沒有成員，否則下列範例會啟用群組的刪除保護。
```
[
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]
```

`AWS::AppRegistry::Application`

此Configuration類型指定資源群組代表由建立的應用程式 AWS Service Catalog AppRegistry。

此類型的資源群組完全由 AppRegistry 服務管理，除非使用 AppRegistry 提供的工具，否則無法由使用者建立、更新或刪除。

注意

由於此類型的資源群組是由自動建立和維護 AWS ，而非由使用者管理，因此這些資源群組不會計入您在中可建立之資源群組數目上限 AWS 帳戶的配額限制。

如需詳細資訊，請參閱《Service Catalog 使用者指南》中的使用 AppRegistry。

當 AppRegistry 建立此類型的服務連結資源群組時，也會為與應用程式相關聯的每個 AWS CloudFormation 堆疊自動建立個別的額外AWS CloudFormation 服務連結群組。

AppRegistry 會自動命名其建立的此類服務連結群組，字首為，AWS_AppRegistry_Application-後面接著應用程式的名稱： AWS_AppRegistry_Application-MyAppName

AWS::AppRegistry::Application 服務連結群組類型支援下列參數。

Name

此參數指定使用者在 AppRegistry 中建立應用程式時所指派的易記名稱。

值的資料類型：字串

允許的值：AppRegistry 服務針對應用程式名稱允許的任何文字字串。

必要：是

Arn

此參數指定 AppRegistry 所指派應用程式的 Amazon Resource Name (ARN) 路徑。

值的資料類型：字串

允許的值：有效的 ARN。

必要：是

注意

若要變更任何這些元素，您必須使用 AppRegistry 主控台或該服務的 AWS SDK 和 AWS CLI 操作來修改應用程式。

此應用程式資源群組會自動將為 AWS CloudFormation 與 AppRegistry 應用程式相關聯的堆疊建立的資源群組納入為群組成員。 AppRegistry 您可以使用 ListGroupResources 操作來查看這些子群組。

下列範例顯示AWS::AppRegistry::Application服務連結群組的組態區段的外觀。


[
  {
    "Type": "AWS::AppRegistry::Application",
    "Parameters": [
      {
        "Name": "Name",
        "Values": [
          "MyApplication"
        ]
      },
      {
        "Name": "Arn",
        "Values": [
          "arn:aws:servicecatalog:us-east-1:123456789012:/applications/<application-id>"
        ]
      }
    ]
  }
]

`AWS::CloudFormation::Stack`

此Configuration類型指定群組代表 AWS CloudFormation 堆疊，其成員是該堆疊建立 AWS 的資源。

當您將 AWS CloudFormation 堆疊與 AppRegistry 服務建立關聯時，系統會自動為您建立此類型的資源群組。除非使用 AppRegistry 提供的工具，否則您無法建立、更新或刪除這些群組。

AppRegistry 會自動為其建立的此類服務連結群組命名，字首為，AWS_CloudFormation_Stack-後面接著堆疊的名稱： AWS_CloudFormation_Stack-MyStackName

注意

如需詳細資訊，請參閱《Service Catalog 使用者指南》中的使用 AppRegistry。

AppRegistry 會自動為您與 AppRegistry 應用程式相關聯的每個 AWS CloudFormation 堆疊建立此類型的服務連結資源群組。這些資源群組會成為 AppRegistry 應用程式父資源群組的子成員。

此 AWS CloudFormation 資源群組的成員是建立為堆疊一部分 AWS 的資源。

AWS::CloudFormation::Stack 服務連結群組類型支援下列參數。

Name

此參數指定建立 AWS CloudFormation 堆疊時，使用者指派的堆疊易記名稱。

值的資料類型：字串

允許的值： AWS CloudFormation 服務針對堆疊名稱允許的任何文字字串。

必要：是

Arn

此參數指定連接到 AppRegistry 中應用程式的 AWS CloudFormation 堆疊的 Amazon Resource Name (ARN) 路徑。

值的資料類型：字串

允許的值：有效的 ARN。

必要：是

注意

若要變更任何這些元素，您必須使用 AppRegistry 主控台或同等 AWS SDK 和 AWS CLI 操作來修改應用程式。

下列範例顯示AWS::CloudFormation::Stack服務連結群組的組態區段的外觀。


[
  {
    "Type": "AWS::CloudFormation::Stack",
    "Parameters": [
      {
        "Name": "Name",
        "Values": [
          "MyStack"
        ]
      },
      {
        "Name": "Arn",
        "Values": [
          "arn:aws:cloudformation:us-east-1:123456789012:stack/MyStack/<stack-id>"
        ]
      }
    ]
  }
]

`AWS::EC2::CapacityReservationPool`

此Configuration類型指定資源群組代表群組成員提供的常見容量集區。此資源群組的成員必須是 Amazon EC2 容量保留。資源群組可以包含您在帳戶中擁有的容量保留，以及使用與您共用的容量保留 AWS Resource Access Manager。這可讓您使用此資源群組做為容量保留參數的值來啟動 Amazon EC2 執行個體。當您執行此操作時，執行個體會使用群組中可用的預留容量。

如果資源群組沒有可用容量，除非您將資源群組設定為使用 Amazon EC2 UltraServer 容量區塊，否則執行個體會在集區外以獨立的隨需執行個體啟動。如需詳細資訊，請參閱《Amazon EC2 使用者指南》中的使用容量保留群組。

如果您設定具有此類型Configuration項目的服務連結資源群組，則也必須指定具有下列值的個別Configuration項目：

具有一個參數的AWS::ResourceGroups::Generic類型：
- 參數allowed-resource-types和的單一值AWS::EC2::CapacityReservation。這可確保只有 Amazon EC2 容量保留可以是資源群組的成員。
具有兩個參數的AWS::EC2::CapacityReservationPool類型：
- reservation-type— 只有在您為 Amazon EC2 UltraServer 容量區塊設定容量保留群組時才需要。此欄位中唯一允許的值為 capacity-block。
- instance-type— 只有在您為 Amazon EC2 UltraServer 容量區塊設定容量保留群組時才需要。此欄位中允許的值為 trn2u.48xlarge和 p6e-gb200.36xlarge。

下列範例顯示隨需容量保留的 Configuration區段：


{
  "Configuration": [
    {
      "Type": "AWS::EC2::CapacityReservationPool",
      "Parameters": []
    },
    {
      "Type": "AWS::ResourceGroups::Generic",
      "Parameters": [
        {
          "Name": "allowed-resource-types",
          "Values": [
            "AWS::EC2::CapacityReservation"
          ]
        }
      ]
    }
  ]
}

下列範例顯示支援 Amazon EC2 UltraServer 容量區塊的 Configuration區段：


{
  "Configuration": [
    {
      "Type": "AWS::EC2::CapacityReservationPool",
      "Parameters": [
        {
          "Name": "instance-type",
          "Values": [
            "trn2u.48xlarge"
          ]
        },
        {
          "Name": "reservation-type",
          "Values": [
            "capacity-block"
          ]
        }
      ]
    },
    {
      "Type": "AWS::ResourceGroups::Generic",
      "Parameters": [
        {
          "Name": "allowed-resource-types",
          "Values": [
            "AWS::EC2::CapacityReservation"
          ]
        }
      ]
    }
  ]
}

當您使用 Amazon EC2 UltraServer 容量區塊時reservation-type，將 instance-type和新增至資源群組組態後，下列行為適用於該資源群組：

您可以將其他容量保留新增至此資源群組組態，但其他保留也必須將 reservation-type設定為 capacity-block，並將 instance-type設定為 trn2u.48xlarge或 p6e-gb200.48xlarge。
目前，的唯一允許值reservation-type為 capacity-block，而的唯一允許值instance-type為 trn2u.48xlarge和 p6e-gb200.48xlarge。
您無法將適用於 ML 的 Amazon EC2 容量區塊新增至不包含 reservation-type和 instance-type組態的資源群組。
新增 reservation-type和 capacity-block組態參數不會變更新增或移除群組保留的程序。
如果您從群組移除容量保留或刪除群組，則群組內的保留會一直保持使用中，直到執行個體終止為止。
目前，具有 reservation-type和 instance-type組態參數的資源群組無法在初始設定後更新。若要變更或移除組態，您必須刪除群組，然後使用新組態建立新的群組。
您無法在空白群組中啟動執行個體，或修改執行個體以鎖定空白群組。

`AWS::EC2::HostManagement`

此識別符會指定 Amazon EC2 主機管理的設定 AWS License Manager ，以及群組成員強制執行的設定。如需詳細資訊，請參閱中的主機資源群組 AWS License Manager。

如果您設定具有此類型Configuration項目的服務連結資源群組，則也必須指定具有下列值的個別Configuration項目：

AWS::ResourceGroups::Generic 類型，參數為 allowed-resource-types，單一值為 AWS::EC2::Host。這可確保只有 Amazon EC2 專用主機可以是群組的成員。
AWS::ResourceGroups::Generic 類型，參數為 deletion-protection，單一值為 UNLESS_EMPTY。這可確保除非群組為空，否則無法刪除群組。

AWS::EC2::HostManagement 服務連結群組類型支援下列參數。

auto-allocate-host

此參數指定執行個體是在特定專用主機上啟動，還是在任何具有相符組態的可用主機上啟動。如需詳細資訊，請參閱《Amazon EC2 使用者指南》中的了解自動配置和親和性。

值的資料類型：布林值

允許的值：「true」或「false」（必須是小寫）。

必要：否


[
  {
    "Type": "AWS::EC2::HostManagement",
    "Parameters": [
      {
        "Name": "auto-allocate-host",
        "Values": [
          "true"
        ]
      },
      {
        "Name": "any-host-based-license-configuration",
        "Values": [
          "true"
        ]
      }
    ]
  },
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      },
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]

auto-release-host

此參數會指定群組中的專用主機是否在其上次執行的執行個體終止後自動釋出。如需詳細資訊，請參閱《Amazon EC2 使用者指南》中的釋出專用主機。

值的資料類型：布林值

允許的值：「true」或「false」（必須是小寫）。

必要：否


[
  {
    "Type": "AWS::EC2::HostManagement",
    "Parameters": [
      {
        "Name": "auto-release-host",
        "Values": [
          "false"
        ]
      },
      {
        "Name": "any-host-based-license-configuration",
        "Values": [
          "true"
        ]
      }
    ]
  },
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      },
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]

allowed-host-families

此參數指定做為此群組成員的執行個體可以使用哪些執行個體類型系列。

值的資料類型：字串陣列。

允許的值：每個必須是有效的 Amazon EC2 執行個體類型系列識別符，例如 C4、P3dn、 M5或 R5d。

必要：否

下列範例組態項目指定啟動的執行個體只能是 C5 或 M5 執行個體類型系列的成員。


[
  {
    "Type": "AWS::EC2::HostManagement",
    "Parameters": [
      {
        "Name": "allowed-host-families",
        "Values": [
          "c5",
          "m5"
        ]
      },
      {
        "Name": "any-host-based-license-configuration",
        "Values": [
          "true"
        ]
      }
    ]
  },
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      },
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]

allowed-host-based-license-configurations

此參數指定您要套用至群組成員的一或多個核心/插槽型授權組態的 Amazon Resource Name (ARN) 路徑。

值的資料類型：ARNs陣列。

允許的值：每個值必須是有效的 License Manager 組態 ARN。

必要：有條件限制。您必須指定此參數或 any-host-based-license-configuration，但不能同時指定兩者。它們是互斥的。

下列範例組態項目指定群組成員可以使用兩個指定的 License Manager 組態。


[
  {
    "Type": "AWS::EC2::HostManagement",
    "Parameters": [
      {
        "Name": "allowed-host-based-license-configurations",
        "Values": [
          "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111",
          "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-8a786a26f50ba416eb658EXAMPLE2222"
        ]
      }
    ]
  },
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      },
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]

any-host-based-license-configuration

此參數指定您不想將特定授權組態與群組建立關聯。在此情況下，您的主機資源群組成員可以使用所有核心/通訊端型授權組態。如果您有不限數量的授權，並想要最佳化主機使用率，請使用此設定。

值的資料類型：布林值

允許的值：「true」或「false」（必須是小寫）。

必要：有條件限制。您必須指定此參數或 allowed-host-based-license-configurations，但不能同時指定兩者。它們是互斥的。

下列範例組態項目指定群組成員可以使用任何核心/通訊端型授權組態。
```
[
  {
    "Type": "AWS::EC2::HostManagement",
    "Parameters": [
      {
        "Name": "any-host-based-license-configuration",
        "Values": [
          "true"
        ]
      }
    ]
  },
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      },
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]
```

下列範例說明如何將所有主機管理設定包含在單一組態中。


[
  {
    "Type": "AWS::EC2::HostManagement",
    "Parameters": [
      {
        "Name": "auto-allocate-host",
        "Values": [
          "true"
        ]
      },
      {
        "Name": "auto-release-host",
        "Values": [
          "false"
        ]
      },
      {
        "Name": "allowed-host-families",
        "Values": [
          "c5",
          "m5"
        ]
      },
      {
        "Name": "allowed-host-based-license-configurations",
        "Values": [
          "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111",
          "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-8a786a26f50ba416eb658EXAMPLE2222"
        ]
      }
    ]
  },
  {
    "Type": "AWS::ResourceGroups::Generic",
    "Parameters": [
      {
        "Name": "allowed-resource-types",
        "Values": [
          "AWS::EC2::Host"
        ]
      },
      {
        "Name": "deletion-protection",
        "Values": [
          "UNLESS_EMPTY"
        ]
      }
    ]
  }
]

`AWS::NetworkFirewall::RuleGroup`

此識別符會指定針對群組成員強制執行的 AWS Network Firewall 規則群組設定。防火牆管理員可以指定此類型資源群組的 ARN，以自動解析防火牆規則群組成員的 IP 地址，而不必手動列出每個地址。如需詳細資訊，請參閱在中使用標籤型資源群組 AWS Network Firewall。

您可以使用 Network Firewall 主控台或執行 AWS CLI 命令或 AWS SDK 操作來建立此組態類型的資源群組。

此組態類型的資源群組具有下列限制：

群組的成員僅由 Network Firewall 支援的類型資源組成。
群組必須包含標籤型查詢來管理群組的成員資格；任何具有符合查詢之標籤的支援類型資源，都會自動成為群組的成員。
此組態類型Parameters不支援。
若要刪除此組態類型的資源群組，任何 Network Firewall 規則群組都無法參考它。

下列範例說明此類型群組的 Configuration和 ResourceQuery區段。


{
  "Configuration": [
    {
      "Type": "AWS::NetworkFirewall::RuleGroup",
      "Parameters": []
    }
  ],
  "ResourceQuery": {
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"environment\",\"Values\":[\"production\"]}]}",
    "Type": "TAG_FILTERS_1_0"
  }
}

下列範例 AWS CLI 命令會使用先前的組態和查詢建立資源群組。


$ aws resource-groups create-group \
    --name test-group \
    --resource-query '{"Type": "TAG_FILTERS_1_0", "Query": "{\"ResourceTypeFilters\": [\"AWS::EC2::Instance\"], \"TagFilters\": [{\"Key\": \"environment\", \"Values\": [\"production\"]}]}"}' \
    --configuration '[{"Type": "AWS::NetworkFirewall::RuleGroup", "Parameters": []}]'
{
    "Group":{
        "GroupArn":"arn:aws:resource-groups:us-west-2:123456789012:group/test-group",
        "Name":"test-group",
        "OwnerId":"123456789012"
    },
    "Configuration": [
        {
            "Type": "AWS::NetworkFirewall::RuleGroup",
            "Parameters": []
        }
    ],
    "ResourceQuery": { 
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"environment\",\"Values\":[\"production\"]}]}",
        "Type": "TAG_FILTERS_1_0"
    }
}

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

服務組態

建立群組