Esempi di Resource Groups utilizzando AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando il AWS Command Line Interface con Resource Groups.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Azioni

Il seguente esempio di codice mostra come utilizzarecreate-group.

AWS CLI

Esempio 1: come creare un gruppo di risorse basato su tag

L'create-groupesempio seguente crea un gruppo di risorse basato su tag di EC2 istanze Amazon nella regione corrente. Si basa su una query relativa alle risorse taggate con la chiave Name e il valore WebServers. Il nome del gruppo è tbq-WebServer. La query si trova in un file JSON separato che viene passato al comando.


aws resource-groups create-group \
    --name tbq-WebServer \
    --resource-query file://query.json

Contenuto di query.json:


{
    "Type": "TAG_FILTERS_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
}

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}

Esempio 2: creare un gruppo di risorse basato sullo CloudFormation stack

L'create-groupesempio seguente crea un gruppo di risorse AWS CloudFormation basato sullo stack denominato. sampleCFNstackgroup La query include tutte le risorse nello CloudFormation stack specificato supportate da AWS Resource Groups.


aws resource-groups create-group \
    --name cbq-CFNstackgroup \
    --resource-query file://query.json

Contenuto di query.json:


{
    "Type": "CLOUDFORMATION_STACK_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
}

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'
    }
}

Per ulteriori informazioni, consulta Creazione di gruppi nella Guida per l’utente di Gruppi di risorse AWS .

Per i dettagli sull'API, vedere CreateGroupin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaredelete-group.

AWS CLI

Come aggiornare la descrizione di un gruppo di risorse

L’esempio delete-group seguente aggiorna il gruppo di risorse specificato.


aws resource-groups delete-group \
    --group-name tbq-WebServer

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:1234567890:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    }
}

Per ulteriori informazioni, consulta Eliminazione di gruppi nella Guida per l’utente di Gruppi di risorse AWS .

Per i dettagli sull'API, consulta DeleteGroup AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-group-query.

AWS CLI

Come ottenere la query associata a un gruppo di risorse

L’esempio get-group-query seguente visualizza la query associata al gruppo di risorse specificato.


aws resource-groups get-group-query \
    --group-name tbq-WebServer

Output:


{
    "GroupQuery": {
        "GroupName": "tbq-WebServer",
        "ResourceQuery": {
            "Type": "TAG_FILTERS_1_0",
            "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
        }
    }
}

Per i dettagli sull'API, consulta GetGroupQuery AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-group.

AWS CLI

Come ottenere informazioni su un gruppo di risorse

L’esempio get-group seguente visualizza i dettagli relativi al gruppo di risorse specificato. Per ottenere la query associata al gruppo, utilizza get-group-query.


aws resource-groups get-group \
    --group-name tbq-WebServer

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer",
        "Description": "A tag-based query resource group of WebServers."
    }
}

Per i dettagli sull'API, consulta GetGroup AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareget-tags.

AWS CLI

Come recuperare i tag associati a un gruppo di risorse

L’esempio get-tags seguente visualizza le coppie di chiavi di tag e valori associate al gruppo di risorse specificato (il gruppo stesso e non i relativi membri).


aws resource-groups get-tags \
    --arn arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer

Output:


{
    "Arn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
    "Tags": {
        "QueryType": "tags",
        "QueryResources": "ec2-instances"
    }
}

Per i dettagli sull'API, consulta GetTags AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-group-resources.

AWS CLI

Come elencare tutte le risorse in un gruppo di risorse

Esempio 1: l’esempio list-resource-groups seguente elenca tutte le risorse appartenenti gruppo di risorse specificato.


aws resource-groups list-group-resources \
    --group-name tbq-WebServer

Output:


{
    "ResourceIdentifiers": [
        {
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-09f77fa38c12345ab",
            "ResourceType": "AWS::EC2::Instance"
        }
    ]
}

Esempio 2: L'esempio seguente elenca tutte le risorse del gruppo che hanno anche un 'tipo di risorsa'::: :Instance'AWS EC2 . :

aws resource-groups list-group-resources --group-name tbq- WebServer --filters Nome=Tipo di risorsa, Valori=::: :Instance AWS EC2

Per i dettagli sull'API, consulta ListGroupResources AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-groups.

AWS CLI

Come elencare i gruppi di risorse disponibili

L’esempio list-groups seguente visualizza un elenco di tutti i gruppi di risorse.


aws resource-groups list-groups

Output:


{
    "GroupIdentifiers": [
        {
            "GroupName": "tbq-WebServer",
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer3"
        },
        {
            "GroupName": "cbq-CFNStackQuery",
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNStackQuery"
        }
    ],
    "Groups": [
        {
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
            "Name": "tbq-WebServer"
        },
        {
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNStackQuery",
            "Name": "cbq-CFNStackQuery"
        }
    ]
}

Per i dettagli sull'API, consulta ListGroups AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzarelist-resource-groups.

AWS CLI

Come elencare tutte le risorse in un gruppo di risorse

L’esempio list-resource-groups seguente elenca tutte le risorse appartenenti gruppo di risorse specificato.


aws resource-groups list-group-resources \
    --group-name tbq-WebServer

Output:


{
    "ResourceIdentifiers": [
        {
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-09f77fa38c12345ab",
            "ResourceType": "AWS::EC2::Instance"
        }
    ]
}

Per i dettagli sull'API, consulta ListResourceGroups AWS CLICommand Reference.

Il seguente esempio di codice mostra come utilizzareput-group-configuration.

AWS CLI

Come associare una configurazione di servizio a un gruppo di risorse

Esempio 1: l'put-group-configurationesempio seguente specifica che il gruppo di risorse deve contenere solo le prenotazioni di EC2 capacità Amazon per le istanze delle famiglie C5 orM5.


aws resource-groups put-group-configuration \
    --group MyTestGroup \
    --configuration file://config.json

Contenuto di config.json:


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

Questo comando non produce alcun output se ha esito positivo.

Per ulteriori informazioni, consulta Configurazioni dei servizi per i gruppi di risorse nella Guida di riferimento dell’API per gruppi di risorse.

Per i dettagli sull'API, consulta AWS CLI Command PutGroupConfigurationReference.

Il seguente esempio di codice mostra come utilizzaresearch-resources.

AWS CLI

Come trovare le risorse che corrispondono a una query

L'search-resourcesesempio seguente recupera un elenco di tutte le AWS risorse che corrispondono alla query specificata.


aws resource-groups search-resources \
    --resource-query file://query.json

Contenuto di query.json:


{
    "Type": "TAG_FILTERS_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Patch Group\", \"Values\":[\"Dev\"]}]}"
}

Output:


{
    "ResourceIdentifiers": [
        {
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a23bc45d67890ef",
            "ResourceType": "AWS::EC2::Instance"
        }
    ]
}

Per i dettagli sull'API, vedere SearchResourcesin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaretag.

AWS CLI

Come associare un tag a un gruppo di risorse

L’esempio tag seguente collega le coppie di chiavi di tag e valori specificate al gruppo di risorse specificato (il gruppo stesso e non i relativi membri).


aws resource-groups tag \
    --tags QueryType=tags,QueryResources=ec2-instances \
    --arn arn:aws:resource-groups:us-west-2:128716708097:group/tbq-WebServer

Output:


{
    "Arn": "arn:aws:resource-groups:us-west-2:128716708097:group/tbq-WebServer",
    "Tags": {
        "QueryType": "tags",
        "QueryResources": "ec2-instances"
    }
}

Per ulteriori informazioni, consulta Gestione dei tag nella Guida per l’utente di Gruppi di risorse AWS .

Per informazioni dettagliate sull’API, consulta Tag nella documentazione di riferimento dei comandi della AWS CLI .

Il seguente esempio di codice mostra come utilizzareuntag.

AWS CLI

Come rimuovere i tag da un gruppo di risorse

L’esempio untags seguente rimuove qualsiasi tag con la chiave specificata dal gruppo di risorse stesso e non dai relativi membri.


aws resource-groups untag \
    --arn arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer \
    --keys QueryType

Output:


{
    "Arn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
    "Keys": [
        "QueryType"
    ]
}

Per ulteriori informazioni, consulta Gestione dei tag nella Guida per l’utente di Gruppi di risorse AWS .

Per informazioni dettagliate sull’API, consulta Untag nella documentazione di riferimento dei comandi della AWS CLI .

Il seguente esempio di codice mostra come utilizzareupdate-group-query.

AWS CLI

Esempio 1: come aggiornare la query per un gruppo di risorse basato su tag

L’esempio update-group-query seguente aggiorna la query associata al gruppo di risorse basato su tag specificato.


aws resource-groups update-group-query \
    --group-name tbq-WebServer \
    --resource-query '{"Type":"TAG_FILTERS_1_0", "Query":"{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"}'

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}

Per ulteriori informazioni, consulta Aggiornamento dei gruppi nella Guida per l’utente di Gruppi di risorse AWS .

Esempio 2: Per aggiornare la query per un gruppo di risorse CloudFormation basato sullo stack

L'update-group-queryesempio seguente aggiorna la query allegata al gruppo di risorse basato sullo AWS CloudFormation stack specificato.


aws resource-groups update-group-query \
    --group-name cbq-CFNstackgroup \
    --resource-query '{"Type": "CLOUDFORMATION_STACK_1_0", "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
    }
}

Per ulteriori informazioni, consulta Aggiornamento dei gruppi nella Guida per l’utente di Gruppi di risorse AWS .

Per i dettagli sull'API, vedere UpdateGroupQueryin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzareupdate-group.

AWS CLI

Come aggiornare la descrizione di un gruppo di risorse

L’esempio update-group seguente aggiorna la descrizione del gruppo di risorse specificato.


aws resource-groups update-group \
    --group-name tbq-WebServer \
    --description "Resource group for all web server resources."

Output:


{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
        "Description": "Resource group for all web server resources."
    }
}

Per ulteriori informazioni, consulta Aggiornamento dei gruppi nella Guida per l’utente di Gruppi di risorse AWS .

Per i dettagli sull'API, consulta UpdateGroup AWS CLICommand Reference.

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

Esploratore di risorse

Resource Groups Tagging API