Accesso Sintassi e struttura Tipi e parametri di configurazione

Configurazioni dei servizi per gruppi di risorse

I gruppi di risorse consentono di gestire le raccolte delleAWS risorse come unità. AlcuniAWS servizi supportano questa operazione eseguendo le operazioni richieste su tutti i membri del gruppo. Tali servizi possono memorizzare le impostazioni da applicare ai membri del gruppo come configurazione sotto forma di una struttura dati JSON allegata al gruppo.

Questo argomento illustra le impostazioni di configurazione disponibili perAWS i servizi supportati.

Argomenti

Come accedere alla configurazione del servizio collegata a un gruppo di risorse
Sintassi JSON di una configurazione di servizio
Tipi e parametri di configurazione supportati

Come accedere alla configurazione del servizio collegata a un gruppo di risorse

I servizi che supportano i gruppi collegati ai servizi in genere impostano la configurazione automaticamente quando utilizzi gli strumenti forniti da quel servizio, come la console di gestione di quel servizio o le sue operazioniAWS CLI eAWS SDK. Alcuni servizi gestiscono completamente i loro gruppi collegati ai servizi e non è possibile modificarli in alcun modo se non come consentito dalla console o dai comandi forniti dalAWS servizio proprietario. Tuttavia, in alcuni casi, è possibile interagire con la configurazione del servizio utilizzando le seguenti operazioni API negliAWS SDK o nei loroAWS CLI equivalenti:

È possibile allegare la propria configurazione a un gruppo quando si crea il gruppo utilizzando l'CreateGroupoperazione.
È possibile modificare la configurazione corrente associata a un gruppo utilizzando l'PutGroupConfigurationoperazione.
È possibile visualizzare la configurazione corrente di un gruppo di risorse chiamando l'GetGroupConfigurationoperazione.

Sintassi JSON di una configurazione di servizio

Un gruppo di risorse può contenere una configurazione che definisce le impostazioni specifiche del servizio che si applicano alle risorse che sono membri di quel gruppo.

Una configurazione è espressa come oggetto JSON. Al livello più alto, una configurazione è una serie di elementi di configurazione di gruppo. Ogni elemento di configurazione del gruppo contiene due elementi: unType per la configurazione e un insiemeParameters definito da quel tipo. Ogni parametro contiene unoName e un array di uno o piùValues. L'esempio seguente con segnaposti mostra la sintassi di base per una configurazione per un singolo tipo di risorsa di esempio. Questo esempio mostra un tipo con due parametri e ogni parametro con due valori. I tipi, i parametri e i valori effettivi validi sono discussi nella sezione successiva.


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

Tipi e parametri di configurazione supportati

Resource Groups supporta l'utilizzo dei seguenti tipi di configurazione. Ogni tipo di configurazione ha un set di parametri validi per quel tipo.

`AWS::ResourceGroups::Generic`

Questo tipo di configurazione specifica le impostazioni che impongono i requisiti di appartenenza al gruppo di risorse, anziché configurare il comportamento di un tipo di risorsa specifico per unAWS servizio. Questo tipo di configurazione viene aggiunto automaticamente dai gruppi collegati al servizio che ne hanno bisogno, ad esempio iAWS::EC2::HostManagment tipiAWS::EC2::CapacityReservationPool and.

Quanto segueParameters è valido per il gruppoAWS::ResourceGroups::Generic collegato al servizioType.

allowed-resource-types

Questo parametro specifica che il gruppo di risorse può essere composto solo da risorse del tipo o dei tipi specificati.

Tipo di dati dei valori: String

Valori consentiti:
- AWS::EC2::Host— UnaConfiguration con questo parametro e valore è necessaria quando la configurazione del servizio contiene anche un tipoConfiguration diAWS::EC2::HostManagement. Ciò garantisce che ilHostManagement gruppo possa contenere solo host dedicati Amazon EC2.
- AWS::EC2::CapacityReservation— UnaConfiguration con questo parametro e valore è necessaria quando la configurazione del servizio contiene anche unConfiguration elemento di tipoAWS::EC2::CapacityReservationPool. Ciò garantisce che unCapacityReservation gruppo possa contenere solo la capacità di prenotazione di Amazon EC2.
Obbligatorio: condizionale, basato su altriConfiguration elementi collegati al gruppo di risorse. Vedi la voce precedente per i valori consentiti.

L'esempio seguente limita i membri del gruppo alle sole istanze host Amazon EC2.
```
{
    "Configuration": [
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": ["AWS::EC2::Host"]
                }
            ]
        }
    ]
}
```
deletion-protection

Questo parametro specifica che il gruppo di risorse non può essere eliminato a meno che non contenga membri. Per ulteriori informazioni, consulta Eliminazione di un gruppo di risorse host nella Guida per l'utente di License Manager

Tipo di dati di valori: matrice di stringhe

Valori consentiti: l'unico valore consentito è[ "UNLESS_EMPTY" ] (il valore deve essere in maiuscolo).

Obbligatorio: condizionale, basato su altriConfiguration elementi collegati al gruppo di risorse. Questo parametro è richiesto solo quando il gruppo di risorse ha anche un altroConfiguration elemento con il valoreType ofAWS::EC2::HostManagement.

L'esempio seguente abilita la protezione dall'eliminazione per il gruppo a meno che il gruppo non abbia membri.
```
{
    "Configuration": [
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "deletion-protection",
                    "Values": [ "UNLESS_EMPTY" ]
                }
            ]
        }
    ]
}
```

`AWS::AppRegistry::Application`

QuestoConfiguration tipo specifica che il gruppo di risorse rappresenta un'applicazione creata daAWS Service Catalog AppRegistry.

I gruppi di risorse di questo tipo sono completamente gestiti dal AppRegistry servizio e non possono essere creati, aggiornati o eliminati dagli utenti se non utilizzando gli strumenti forniti da AppRegistry.

Nota

Poiché i gruppi di risorse di questo tipo vengono creati e gestiti automaticamente dall'utenteAWS e non vengono gestiti dall'utente, questi gruppi di risorse non vengono conteggiati nel limite di quota per il numero massimo di gruppi di risorse che è possibile creare nel proprioAccount AWS.

Per ulteriori informazioni, vedere Using AppRegistry in the Service Catalog User Guide.

Quando AppRegistry crea un gruppo di risorse di questo tipo collegato ai servizi, crea automaticamente anche un gruppo separato e aggiuntivoAWS CloudFormation collegato ai servizi per ogniAWS CloudFormation stack associato all'applicazione.

AppRegistry nomina automaticamente i gruppi collegati al servizio di questo tipo che crea con il prefissoAWS_AppRegistry_Application- seguito dal nome dell'applicazione:AWS_AppRegistry_Application-MyAppName

I seguenti parametri sono supportati per il tipoAWS::AppRegistry::Application di gruppo collegato al servizio.

Name

Questo parametro specifica il nome intuitivo dell'applicazione che è stato assegnato dall'utente al momento della sua creazione in AppRegistry.

Tipo di dati dei valori: String

Valori consentiti: qualsiasi stringa di testo consentita dal AppRegistry servizio per il nome di un'applicazione.

Required: Yes

Arn

Questo parametro specifica il percorso Amazon Resource Name (ARN) dell'applicazione assegnato da AppRegistry.

Tipo di dati dei valori: String

Valori consentiti: un ARN valido.

Required: Yes

Nota

Per modificare uno di questi elementi, è necessario modificare l'applicazione utilizzando la AppRegistry console o l'AWSSDK eAWS CLI le operazioni di quel servizio.

Questo gruppo di risorse dell'applicazione include automaticamente come membri del gruppo i gruppi di risorse creati per gliAWS CloudFormation stack associati all' AppRegistry applicazione. Puoi usare l'ListGroupResourcesoperazione per vedere quei gruppi di bambini.

L'esempio seguente mostra l'aspetto della sezione di configurazione di un gruppoAWS::AppRegistry::Application collegato al servizio.


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

QuestoConfiguration tipo specifica che il gruppo rappresenta unoAWS CloudFormation stack e i suoi membri sono leAWS risorse create da quello stack.

I gruppi di risorse di questo tipo vengono creati automaticamente quando si associa unoAWS CloudFormation stack al AppRegistry servizio. Non puoi creare, aggiornare o eliminare questi gruppi se non utilizzando gli strumenti forniti da AppRegistry.

AppRegistry nomina automaticamente i gruppi collegati al servizio di questo tipo che crea con il prefissoAWS_CloudFormation_Stack- seguito dal nome dello stack:AWS_CloudFormation_Stack-MyStackName

Nota

Per ulteriori informazioni, vedere Using AppRegistry in the Service Catalog User Guide.

AppRegistry crea automaticamente un gruppo di risorse di questo tipo collegato al servizio per ogniAWS CloudFormation stack associato all' AppRegistry applicazione. Questi gruppi di risorse diventano membri secondari del gruppo di risorse principale dell' AppRegistryapplicazione.

I membri di questo gruppo diAWS CloudFormation risorse sono leAWS risorse create come parte dello stack.

I seguenti parametri sono supportati per il tipoAWS::CloudFormation::Stack di gruppo collegato al servizio.

Name

Questo parametro specifica il nome intuitivo delloAWS CloudFormation stack assegnato dall'utente al momento della creazione dello stack.

Tipo di dati dei valori: String

Valori consentiti: qualsiasi stringa di testo consentita dalAWS CloudFormation servizio per il nome di uno stack.

Required: Yes

Arn

Questo parametro specifica il percorso Amazon Resource Name (ARN) delloAWS CloudFormation stack collegato all'applicazione in AppRegistry.

Tipo di dati dei valori: String

Valori consentiti: un ARN valido.

Required: Yes

Nota

Per modificare uno di questi elementi, è necessario modificare l'applicazione utilizzando la AppRegistry console o l'AWSSDK eAWS CLI le operazioni equivalenti.

L'esempio seguente mostra l'aspetto della sezione di configurazione di un gruppoAWS::CloudFormation::Stack collegato al servizio.


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

QuestoConfiguration tipo specifica che il gruppo di risorse rappresenta un pool comune di capacità fornito dai membri del gruppo. I membri di questo gruppo di risorse devono essere prenotazioni di capacità Amazon EC2. Un gruppo di risorse può includere sia le prenotazioni di capacità che possiedi nel tuo account sia le prenotazioni di capacità che vengono condivise con te da altri account utilizzandoAWS Resource Access Manager. Ciò consente di avviare un'istanza Amazon EC2 utilizzando questo gruppo di risorse come valore per il parametro di prenotazione della capacità. Quando si esegue questa operazione, l'istanza utilizza la capacità riservata disponibile nel gruppo. Se il gruppo di risorse non ha capacità disponibile, l'istanza viene avviata come istanza autonoma su richiesta all'esterno del pool. Per ulteriori informazioni, consulta Utilizzo dei gruppi di prenotazione della capacità nella Guida per l'utente di Amazon EC2 per le istanze Linux.

Se si configura un gruppo di risorse collegato al servizio con unConfiguration elemento di questo tipo, è necessario specificare ancheConfiguration elementi separati con i seguenti valori:

QualsiasiAWS::ResourceGroups::Generic tipo con un solo parametro:
- Il parametroallowed-resource-types e un singolo valore diAWS::EC2::CapacityReservation. Ciò garantisce che solo le prenotazioni di capacità di Amazon EC2 possano essere membri del gruppo di risorse.

L'AWS::EC2::CapacityReservationPoolelemento in una configurazione di gruppo non supporta alcun parametro.

L'esempio seguente mostra l'aspetto dellaConfiguration sezione di tale gruppo.


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

`AWS::EC2::HostManagement`

Questo identificatore specifica le impostazioni per la gestione degli host Amazon EC2 eAWS License Manager che vengono applicate ai membri del gruppo. Per ulteriori informazioni, consulta Gruppi di risorse host inAWS License Manager.

Se si configura un gruppo di risorse collegato al servizio con unConfiguration elemento di questo tipo, è necessario specificare ancheConfiguration elementi separati con i seguenti valori:

QualsiasiAWS::ResourceGroups::Generic tipo, con un parametro diallowed-resource-types e un singolo valore diAWS::EC2::Host. Ciò garantisce che solo gli host dedicati di Amazon EC2 possano essere membri del gruppo.
QualsiasiAWS::ResourceGroups::Generic tipo, con un parametro dideletion-protection e un singolo valore diUNLESS_EMPTY. Ciò garantisce che il gruppo non possa essere eliminato a meno che il gruppo non sia vuoto.

I seguenti parametri sono supportati per il tipoAWS::EC2::HostManagement di gruppo collegato al servizio.

auto-allocate-host

Questo parametro consente di specificare se le istanze vengono avviate su un host dedicato specifico o su qualsiasi host disponibile che dispone di una configurazione corrispondente. Per ulteriori informazioni, consulta Informazioni sul posizionamento automatico e sull'affinità nella Guida per l'utente di Amazon EC2 per le istanze Linux.

Tipo di dati: valori booleani

Valori consentiti: «vero» o «falso» (deve essere in minuscolo).

Required: No


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

auto-release-host

Questo parametro specifica se un host dedicato del gruppo viene rilasciato automaticamente dopo la chiusura dell'ultima istanza in esecuzione. Per ulteriori informazioni, consulta Relazione di host dedicati nella Guida per l'utente di Amazon EC2 per le istanze Linux.

Tipo di dati: valori booleani

Valori consentiti: «vero» o «falso» (deve essere in minuscolo).

Required: No


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

allowed-host-families

Questo parametro specifica quali famiglie di tipi di istanze possono essere utilizzate dalle istanze membri di questo gruppo.

Tipo di dati di valori: una matrice di stringhe.

Valori consentiti: ognuno deve essere un identificatore valido della famiglia del tipo di istanza Amazon EC2C4, ad esempioM5,P3dn, oR5d.

Required: No

Il seguente elemento di configurazione di esempio specifica che le istanze avviate possono essere solo membri delle famiglie di tipi di istanze C5 o M5.


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

allowed-host-based-license-configurations

Questo parametro specifica i percorsi Amazon Resource Name (ARN) di una o più configurazioni di licenza basate su core/socket che desideri applicare ai membri del gruppo.

Tipo di dati di valori: una matrice di ARN.

Valori consentiti: ognuno deve essere un ARN di configurazione di License Manager valido.

Obbligatorio: condizionale. È necessario specificare questo parametro oany-host-based-license-configuration, ma non entrambi. Sono si escludono a vicenda.

Il seguente elemento di configurazione di esempio specifica che i membri del gruppo possono utilizzare le due configurazioni di License Manager specificate.


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

Questo parametro specifica che non si desidera associare una configurazione di licenza specifica al gruppo. In questo caso, tutte le configurazioni di licenza basate su core/socket sono disponibili per i membri del gruppo di risorse host. Utilizza questa impostazione se disponi di un numero illimitato di licenze e desideri ottimizzare l'utilizzo dell'host.

Tipo di dati: valori booleani

Valori consentiti: «vero» o «falso» (deve essere in minuscolo).

Obbligatorio: condizionale. È necessario specificare questo parametro oallowed-host-based-license-configurations, ma non entrambi. Sono si escludono a vicenda.

Il seguente elemento di configurazione di esempio specifica che i membri del gruppo possono utilizzare qualsiasi configurazione di licenza basata su core/socket.


{
    "Configuration": [
        {
            "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"]
                }
            ]
        }
    ]
}

L'esempio seguente illustra come includere tutte le impostazioni di gestione dell'host in un'unica configurazione.


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

Questo identificatore specifica le impostazioni per i gruppi diAWS Network Firewall regole che vengono applicate ai membri del gruppo. Gli amministratori del firewall possono specificare l'ARN di un gruppo di risorse di questo tipo per risolvere automaticamente gli indirizzi IP dei membri del gruppo per una regola firewall invece di dover elencare ogni indirizzo manualmente. Per ulteriori informazioni, consulta Utilizzo di gruppi di risorse basati su tag inAWS Network Firewall.

È possibile creare gruppi di risorse di questo tipo di configurazione utilizzando la console Network Firewall o eseguendo unAWS CLI comando o un'operazioneAWS SDK.

I gruppi di risorse di questo tipo di configurazione hanno le seguenti restrizioni:

I membri del gruppo sono costituiti solo da risorse di tipo supportato da Network Firewall.
Il gruppo deve contenere una query basata su tag per gestire l'appartenenza al gruppo; tutte le risorse dei tipi supportati con tag che corrispondono alla query sono automaticamente membri del gruppo.
Non sonoParameters supportati per questo tipo di configurazione.
Per eliminare un gruppo di risorse di questo tipo di configurazione, non può essere referenziato da alcun gruppo di regole di Network Firewall.

L'esempio seguente illustra leResourceQuery sezioniConfiguration e per un gruppo di questo tipo.


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

Il seguenteAWS CLI comando di esempio crea un gruppo di risorse con la configurazione e la query precedenti.


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

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Servizi AWS supportati da AWS Resource Groups

Tipi di risorse supportati