Acesso Sintaxe e estrutura Tipos e parâmetros de configuração

Configurações de serviço para grupos de recursos

Os grupos de recursos permitem que você gerencie coleções de seus AWS recursos como uma unidade. Alguns produtos da AWS oferecem suporte a isso executando as operações solicitadas em todos os membros do grupo. Esses serviços podem armazenar as configurações a serem aplicadas aos membros do grupo como uma configuração na forma de uma estrutura de JSONdados anexada ao grupo.

Este tópico descreve as definições de configuração disponíveis para os produtos da AWS compatíveis.

Tópicos

Como acessar a configuração do serviço anexada a um grupo de recursos
JSONsintaxe de uma configuração de serviço
Tipos e parâmetros de configuração compatíveis

Como acessar a configuração do serviço anexada a um grupo de recursos

Os serviços que oferecem suporte a grupos vinculados a serviços geralmente definem a configuração para você quando você usa as ferramentas fornecidas por esse serviço, como o console de gerenciamento desse serviço ou suas operações AWS CLI . AWS SDK Alguns serviços gerenciam totalmente seus grupos vinculados a serviços e você não pode modificá-los de nenhuma forma, exceto conforme permitido pelo console ou pelos comandos fornecidos pelo serviço proprietário AWS . No entanto, em alguns casos, você pode interagir com a configuração do serviço usando as seguintes API operações no AWS SDKs ou em seus AWS CLI equivalentes:

Você pode anexar sua própria configuração a um grupo ao criar o grupo usando a CreateGroupoperação.
Você pode modificar a configuração atual anexada a um grupo usando a PutGroupConfigurationoperação.
Você pode ver a configuração atual de um grupo de recursos chamando a GetGroupConfigurationoperação.

JSONsintaxe de uma configuração de serviço

Um grupo de recursos pode conter uma configuração que define configurações específicas do serviço que se aplicam aos recursos que são membros desse grupo.

Uma configuração é expressa como um JSONobjeto. No nível mais alto, uma configuração é uma matriz de itens de configuração de grupo. Cada item de configuração de grupo contém dois elementos: um Type para a configuração e um conjunto de Parameters definidos por esse tipo. Cada parâmetro contém um Name e uma matriz de um ou mais Values. O exemplo a seguir com placeholders mostra a sintaxe básica de uma configuração para um único tipo de recurso de amostra. Este exemplo mostra um tipo com dois parâmetros e cada parâmetro com dois valores. Os tipos, parâmetros e valores reais válidos são discutidos na próxima seção.


[
    {
        "Type": "configuration-type",
        "Parameters": [
            {
                "Name": "parameter1-name",
                "Values": [
                    "value1",
                    "value2"
                ]
            },
            {
                "Name": "parameter2-name",
                "Values": [
                    "value3",
                    "value4"
                ]
            }
        ]
    }
]

Tipos e parâmetros de configuração compatíveis

Os Grupos de recursos são compatíveis usando estes tipos de configuração. Cada tipo de configuração tem um conjunto de parâmetros que são válidos para esse tipo.

`AWS::ResourceGroups::Generic`

Esse tipo de configuração especifica as configurações que impõem os requisitos de associação ao grupo de recursos, em vez de definir o comportamento de um tipo de recurso específico para um serviço. AWS Este tipo de configuração é adicionado automaticamente pelos grupos vinculados ao serviço que precisam dele, como os tipos AWS::EC2::CapacityReservationPool e AWS::EC2::HostManagment.

Os Parameters a seguir são válidos para o grupo vinculado ao serviço AWS::ResourceGroups::Generic Type.

allowed-resource-types

Este parâmetro especifica que o grupo de recursos pode consistir somente em recursos do tipo ou tipos especificados.

Tipo de dados dos valores: cadeia de caracteres

Valores permitidos:
- AWS::EC2::Host — Um Configuration com esse parâmetro e valor é necessário quando a configuração do serviço também contém uma Configuration do tipo AWS::EC2::HostManagement. Isso garante que o HostManagement grupo possa conter somente hosts EC2 dedicados da Amazon.
- AWS::EC2::CapacityReservation — Um Configuration com esse parâmetro e valor é necessário quando a configuração do serviço também contém um item Configuration do tipo AWS::EC2::CapacityReservationPool. Isso garante que um CapacityReservation grupo possa conter somente a capacidade de reserva EC2 de capacidade da Amazon.
Obrigatório: condicional, com base em outros elementos de Configuration anexados ao grupo de recursos. Consulte a entrada anterior a respeito de Valores permitidos.

O exemplo a seguir restringe os membros do grupo somente às instâncias de EC2 host da Amazon.
```
[
    {
        "Type": "AWS::ResourceGroups::Generic",
        "Parameters": [
            {
                "Name": "allowed-resource-types",
                "Values": ["AWS::EC2::Host"]
            }
        ]
    }
]
```
deletion-protection

Esse parâmetro especifica que o grupo de recursos não pode ser excluído a menos que não contenha membros. Para obter mais informações, consulte Excluir um grupo de recursos de host no Guia do usuário do License Manager

Tipo de dados dos valores: matriz de cadeia de caracteres

Valores permitidos: o único valor permitido é [ "UNLESS_EMPTY" ] (o valor deve estar em maiúsculas).

Obrigatório: condicional, com base em outros elementos de Configuration anexados ao grupo de recursos. Esse parâmetro é necessário somente quando o grupo de recursos também tem outro elemento Configuration com o Type de AWS::EC2::HostManagement.

O exemplo a seguir permite a proteção contra exclusão do grupo, a menos que o grupo não tenha membros.
```
[
    {
        "Type": "AWS::ResourceGroups::Generic",
        "Parameters": [
            {
                "Name": "deletion-protection",
                "Values": [ "UNLESS_EMPTY" ]
            }
        ]
    }
]
```

`AWS::AppRegistry::Application`

Esse Configuration tipo especifica que o grupo de recursos representa um aplicativo criado por AWS Service Catalog AppRegistry.

Grupos de recursos desse tipo são totalmente gerenciados pelo AppRegistry serviço e não podem ser criados, atualizados ou excluídos por usuários, exceto usando as ferramentas fornecidas pelo AppRegistry.

nota

Como os grupos de recursos desse tipo são criados e mantidos automaticamente pelo usuário AWS e não são gerenciados pelo usuário, esses grupos de recursos não contam no limite de cota para o número máximo de grupos de recursos que você pode criar no seu Conta da AWS.

Para obter mais informações, consulte Using AppRegistry in the Service Catalog User Guide.

Ao AppRegistry criar um grupo de recursos vinculado a serviços desse tipo, ele também cria automaticamente um grupo AWS CloudFormation vinculado a serviços adicional separado para cada AWS CloudFormation pilha associada ao aplicativo.

AppRegistry nomeia automaticamente os grupos vinculados a serviços desse tipo que ele cria com o prefixo AWS_AppRegistry_Application- seguido pelo nome do aplicativo: AWS_AppRegistry_Application-MyAppName

Os parâmetros a seguir são compatíveis com o tipo de grupo vinculado ao serviço de AWS::AppRegistry::Application.

Name

Esse parâmetro especifica o nome amigável do aplicativo que foi atribuído pelo usuário quando ele foi criado no AppRegistry.

Tipo de dados dos valores: cadeia de caracteres

Valores permitidos: qualquer sequência de texto permitida pelo AppRegistry serviço para o nome de um aplicativo.

Obrigatório: Sim

Arn

Esse parâmetro especifica o caminho do Amazon Resource Name (ARN) do aplicativo atribuído por AppRegistry.

Tipo de dados dos valores: cadeia de caracteres

Valores permitidos: um válidoARN.

Obrigatório: Sim

nota

Para alterar qualquer um desses elementos, você deve modificar o aplicativo usando o AppRegistry console ou as AWS CLI operações AWS SDK e serviços desse serviço.

Esse grupo de recursos do aplicativo inclui automaticamente como membros do grupo os grupos de recursos criados para as AWS CloudFormation pilhas associadas ao AppRegistry aplicativo. Você pode usar a ListGroupResourcesoperação para ver esses grupos de filhos.

O exemplo a seguir mostra a aparência da seção de configuração de um grupo vinculado a serviços do 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`

Esse Configuration tipo especifica que o grupo representa uma AWS CloudFormation pilha e seus membros são os AWS recursos criados por essa pilha.

Grupos de recursos desse tipo são criados automaticamente para você quando você associa uma AWS CloudFormation pilha ao AppRegistry serviço. Você não pode criar, atualizar ou excluir esses grupos, exceto usando as ferramentas fornecidas pelo AppRegistry.

AppRegistry nomeia automaticamente os grupos vinculados a serviços desse tipo que ele cria com o prefixo AWS_CloudFormation_Stack- seguido pelo nome da pilha: AWS_CloudFormation_Stack-MyStackName

nota

Para obter mais informações, consulte Using AppRegistry in the Service Catalog User Guide.

AppRegistry cria automaticamente um grupo de recursos vinculado a serviços desse tipo para cada AWS CloudFormation pilha que você associa ao aplicativo. AppRegistry Esses grupos de recursos se tornam membros secundários do grupo de recursos principal do AppRegistry aplicativo.

Os membros desse grupo de AWS CloudFormation recursos são os AWS recursos criados como parte da pilha.

Os parâmetros a seguir são compatíveis com o tipo de grupo vinculado ao serviço de AWS::CloudFormation::Stack.

Name

Esse parâmetro especifica o nome amigável da AWS CloudFormation pilha atribuída pelo usuário quando a pilha foi criada.

Tipo de dados dos valores: cadeia de caracteres

Valores permitidos: qualquer sequência de texto permitida pelo AWS CloudFormation serviço para o nome de uma pilha.

Obrigatório: Sim

Arn

Esse parâmetro especifica o caminho do Amazon Resource Name (ARN) da AWS CloudFormation pilha anexada ao aplicativo em. AppRegistry

Tipo de dados dos valores: cadeia de caracteres

Valores permitidos: um válidoARN.

Obrigatório: Sim

nota

Para alterar qualquer um desses elementos, você deve modificar o aplicativo usando o AppRegistry console ou equivalente AWS SDK e AWS CLI operações.

O exemplo a seguir mostra a aparência da seção de configuração de um grupo vinculado a serviços do 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`

Esse tipo Configuration especifica que o grupo de recursos representa um pool comum de capacidade fornecido pelos membros do grupo. Os membros desse grupo de recursos devem ser reservas de EC2 capacidade da Amazon. Um grupo de recursos pode incluir reservas de capacidade que você possui em sua conta e reservas de capacidade que são compartilhadas com você de outras contas usando AWS Resource Access Manager. Isso permite que você execute uma EC2 instância da Amazon usando esse grupo de recursos como o valor do parâmetro de reserva de capacidade. Quando você faz isso, a instância usa a capacidade reservada disponível no grupo. Se o grupo de recursos não tiver capacidade disponível, a instância será executada como uma instância autônoma sob demanda fora do pool. Para obter mais informações, consulte Como trabalhar com grupos de reserva de capacidade no Guia EC2 do usuário da Amazon.

Se você configurar um grupo de recursos vinculado ao serviço com um item de Configuration deste tipo, também deverá especificar itens diferentes de Configuration com os seguintes valores:

Um tipo AWS::ResourceGroups::Generic com um parâmetro:
- O parâmetro allowed-resource-types e um valor único de AWS::EC2::CapacityReservation. Isso garante que somente as reservas EC2 de capacidade da Amazon possam ser membros do grupo de recursos.

O item AWS::EC2::CapacityReservationPool em uma configuração de grupo não oferece suporte a nenhum parâmetro.

O exemplo a seguir mostra a aparência da seção Configuration de um grupo como esse.


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

`AWS::EC2::HostManagement`

Esse identificador especifica as configurações para o gerenciamento de EC2 hosts da Amazon e AWS License Manager que são aplicadas aos membros do grupo. Para obter mais informações, consulte Hospedar grupos de recursos em AWS License Manager.

Se você configurar um grupo de recursos vinculado ao serviço com um item de Configuration deste tipo, também deverá especificar itens diferentes de Configuration com os seguintes valores:

Um tipo AWS::ResourceGroups::Generic, com um parâmetro de allowed-resource-types e um valor único de AWS::EC2::Host. Isso garante que somente anfitriões EC2 dedicados da Amazon possam ser membros do grupo.
Um tipo AWS::ResourceGroups::Generic, com um parâmetro de deletion-protection e um valor único de UNLESS_EMPTY. Isso garante que o grupo não possa ser excluído, a menos que esteja vazio.

Os parâmetros a seguir são compatíveis com o tipo de grupo vinculado ao serviço de AWS::EC2::HostManagement.

auto-allocate-host

Esse parâmetro permite que você gerencie se as instâncias são executadas em um host dedicado específico ou em qualquer host disponível com as configurações correspondentes. Para obter mais informações, consulte Entendendo o posicionamento automático e a afinidade no Guia do usuário da Amazon EC2.

Tipo de dados dos valores: booleano

Valores permitidos: "true" or "false" (devem estar em minúsculas).

Obrigatório: não


[
    {
        "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

Esse parâmetro especifica se um host dedicado no grupo é liberado automaticamente após o encerramento da última instância em execução. Para obter mais informações, consulte Lançamento de hosts dedicados no Guia do EC2 usuário da Amazon.

Tipo de dados dos valores: booleano

Valores permitidos: "true" or "false" (devem estar em minúsculas).

Obrigatório: não


[ 
    {
        "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

Esse parâmetro especifica quais famílias de tipos de instância podem ser usadas por instâncias que são membros desse grupo.

Tipo de dados dos valores: matriz de cadeia de caracteres.

Valores permitidos: cada um deve ser um identificador válido da família do tipo de EC2 instância da AmazonC4, comoM5,P3dn, ouR5d.

Obrigatório: não

O exemplo de item de configuração a seguir especifica que as instâncias executadas só podem ser membros das famílias de tipos de instância C5 ou 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

Esse parâmetro especifica os caminhos do Amazon Resource Name (ARN) de uma ou mais configurações de licença baseadas em core/soquete que você deseja aplicar aos membros do grupo.

Tipo de dados de valores: uma matriz deARNs.

Valores permitidos: cada um deve ser uma configuração válida do License Manager ARN.

Obrigatório: condicional. Você deve especificar este parâmetro ou any-host-based-license-configuration, mas não ambos. Os parâmetros são mutuamente exclusivos.

O exemplo de item de configuração a seguir especifica que os membros do grupo podem usar as duas configurações especificadas do 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

Esse parâmetro especifica que você não deseja associar uma configuração de licença específica ao seu grupo. Nesse caso, todas as configurações de licença baseadas em core/soquete estão disponíveis para os membros do seu grupo de recursos do host. Use essa configuração se você tiver um número ilimitado de licenças e quiser otimizar a utilização do host.

Tipo de dados dos valores: booleano

Valores permitidos: "true" or "false" (devem estar em minúsculas).

Obrigatório: condicional. Você deve especificar este parâmetro ou allowed-host-based-license-configurations, mas não ambos. Os parâmetros são mutuamente exclusivos.

O exemplo de item de configuração a seguir especifica que os membros do grupo podem usar qualquer configuração de licença baseada em core/soquete.
```
[
    {
        "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"]
            }
        ]
    }
]
```

O exemplo a seguir ilustra como incluir todas as configurações de gerenciamento do host em uma única configuração.


[
    {
        "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`

Esse identificador especifica configurações para grupos de AWS Network Firewall regras que são aplicadas aos membros do grupo. Os administradores de firewall podem especificar o ARN de um grupo de recursos desse tipo para resolver automaticamente os endereços IP dos membros do grupo para uma regra de firewall, em vez de precisar listar cada endereço manualmente. Para obter mais informações, consulte Usar grupos de recursos baseados em tags no AWS Network Firewall.

Você pode criar grupos de recursos desse tipo de configuração usando o console do Network Firewall ou executando um AWS CLI comando ou AWS SDK operação.

Grupos de recursos desse tipo de configuração têm as seguintes restrições:

Os membros do grupo consistem somente em recursos dos tipos suportados pelo Network Firewall.
O grupo deve conter uma consulta baseada em tags para gerenciar a associação do grupo; quaisquer recursos de tipos compatíveis com tags que correspondam à consulta são automaticamente membros do grupo.
Não há suporte a Parameters para esse tipo de configuração.
Para excluir um grupo de recursos desse tipo de configuração, ele não pode ser referenciado por nenhum grupo de regras do Network Firewall.

O exemplo a seguir ilustra as seções ResourceQuery e Configuration e de um grupo desse tipo.


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

O AWS CLI comando de exemplo a seguir cria um grupo de recursos com a configuração e a consulta anteriores.


$ 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"
    }
}

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

AWS serviços que funcionam com AWS Resource Groups

Tipos de recursos compatíveis