Beispiele für Resource Groups mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS Command Line Interface with Resource Groups Aktionen ausführen und allgemeine Szenarien implementieren.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarios anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungcreate-group.

AWS CLI

Beispiel 1: Um eine tagbasierte Ressourcengruppe zu erstellen

Im folgenden create-group Beispiel wird eine Tag-basierte Ressourcengruppe von EC2 Amazon-Instances in der aktuellen Region erstellt. Es basiert auf einer Abfrage nach Ressourcen, die mit dem Schlüssel Name und dem Wert WebServers gekennzeichnet sind. Der Gruppenname isttbq-WebServer. Die Abfrage befindet sich in einer separaten JSON-Datei, die an den Befehl übergeben wird.


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

Inhalt von query.json:


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

Ausgabe:


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

Beispiel 2: So erstellen Sie eine CloudFormation stapelbasierte Ressourcengruppe

Im folgenden create-group Beispiel wird eine AWS CloudFormation stapelbasierte Ressourcengruppe mit dem Namen erstellt. sampleCFNstackgroup Die Abfrage umfasst alle Ressourcen im angegebenen CloudFormation Stack, die von AWS Resource Groups unterstützt werden.


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

Inhalt von 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\"}"
}

Ausgabe:


{
    "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\"}"}'
    }
}

Weitere Informationen finden Sie unter Create Groups im AWS Resource Groups User Guide.

Einzelheiten zur API finden Sie CreateGroupin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-group.

AWS CLI

Um die Beschreibung für eine Ressourcengruppe zu aktualisieren

Im folgenden delete-group Beispiel wird die angegebene Ressourcengruppe aktualisiert.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Gruppen löschen im AWS Resource Groups User Guide.

Einzelheiten zur API finden Sie DeleteGroupin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-group-query.

AWS CLI

Um die Abfrage an eine Ressourcengruppe anzuhängen

Im folgenden get-group-query Beispiel wird die Abfrage angezeigt, die der angegebenen Ressourcengruppe zugeordnet ist.


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

Ausgabe:


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

Einzelheiten zur API finden Sie GetGroupQueryunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-group.

AWS CLI

Um Informationen über eine Ressourcengruppe zu erhalten

Im folgenden get-group Beispiel werden Details zur angegebenen Ressourcengruppe angezeigt. Um die Abfrage an die Gruppe anzuhängen, verwenden Sieget-group-query.


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

Ausgabe:


{
    "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."
    }
}

Einzelheiten zur API finden Sie GetGroupin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-tags.

AWS CLI

Um die einer Ressourcengruppe angehängten Tags abzurufen

Im folgenden get-tags Beispiel werden die Tag-Schlüssel- und Wertepaare angezeigt, die der angegebenen Ressourcengruppe (der Gruppe selbst, nicht ihren Mitgliedern) zugeordnet sind.


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

Ausgabe:


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

Einzelheiten zur API finden Sie GetTagsunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-group-resources.

AWS CLI

Um alle Ressourcen in einer Ressourcengruppe aufzulisten

Beispiel 1: Das folgende list-resource-groups Beispiel listet alle Ressourcen auf, die Teil der angegebenen Ressourcengruppe sind.


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

Ausgabe:


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

Beispiel 2: Das folgende Beispiel listet alle Ressourcen in der Gruppe auf, die auch den 'Ressourcentyp'AWS:: EC2 :Instanz 'haben . :

aws resource-groups list-group-resources --group-name tbq- WebServer --filters name=Ressourcentyp, Values=:: :Instanz AWS EC2

Einzelheiten zur API finden Sie ListGroupResourcesin AWS CLI der Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-groups.

AWS CLI

Um die verfügbaren Ressourcengruppen aufzulisten

Im folgenden list-groups Beispiel wird eine Liste aller Ressourcengruppen angezeigt.


aws resource-groups list-groups

Ausgabe:


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

Einzelheiten zur API finden Sie ListGroupsunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-resource-groups.

AWS CLI

Um alle Ressourcen in einer Ressourcengruppe aufzulisten

Das folgende list-resource-groups Beispiel listet alle Ressourcen auf, die Teil der angegebenen Ressourcengruppe sind.


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

Ausgabe:


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

Einzelheiten zur API finden Sie ListResourceGroupsunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungput-group-configuration.

AWS CLI

Um eine Dienstkonfiguration an eine Ressourcengruppe anzuhängen

Beispiel 1: Das folgende put-group-configuration Beispiel gibt an, dass die Ressourcengruppe nur EC2 Amazon-Kapazitätsreservierungen für Instances der M5 Familien C5 oder enthalten soll.


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

Inhalt von 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" ]
            }
        ]
    }
]

Dieser Befehl erzeugt bei Erfolg keine Ausgabe.

Weitere Informationen finden Sie unter Dienstkonfigurationen für Resource Groups im API-Referenzhandbuch für Ressourcengruppen.

Einzelheiten zur API finden Sie PutGroupConfigurationunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungsearch-resources.

AWS CLI

Um Ressourcen zu finden, die einer Abfrage entsprechen

Im folgenden search-resources Beispiel wird eine Liste aller AWS Ressourcen abgerufen, die der angegebenen Abfrage entsprechen.


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

Inhalt von query.json:


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

Ausgabe:


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

Einzelheiten zur API finden Sie unter SearchResources AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungtag.

AWS CLI

Um ein Tag an eine Ressourcengruppe anzuhängen

Im folgenden tag Beispiel werden die angegebenen Tag-Schlüssel- und Wertepaare an die angegebene Ressourcengruppe angehängt (die Gruppe selbst, nicht ihre Mitglieder).


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

Ausgabe:


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

Weitere Informationen finden Sie unter Tags verwalten im AWS Resource Groups User Guide.

Einzelheiten zur API finden Sie unter Tag in der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunguntag.

AWS CLI

Um Tags aus einer Ressourcengruppe zu entfernen

Im folgenden untags Beispiel werden alle Tags mit dem angegebenen Schlüssel aus der Ressourcengruppe selbst entfernt, nicht aus ihren Mitgliedern.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Tags verwalten im AWS Resource Groups User Guide.

Einzelheiten zur API finden Sie unter Untag in der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-group-query.

AWS CLI

Beispiel 1: Um die Abfrage für eine tagbasierte Ressourcengruppe zu aktualisieren

Im folgenden update-group-query Beispiel wird die Abfrage aktualisiert, die der angegebenen tagbasierten Ressourcengruppe zugeordnet ist.


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\"]}]}"}'

Ausgabe:


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

Weitere Informationen finden Sie unter Gruppen aktualisieren im AWS Resource Groups User Guide.

Beispiel 2: So aktualisieren Sie die Abfrage für eine CloudFormation stapelbasierte Ressourcengruppe

Im folgenden update-group-query Beispiel wird die Abfrage aktualisiert, die an die angegebene AWS CloudFormation stapelbasierte Ressourcengruppe angehängt ist.


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\"}"}'

Ausgabe:


{
    "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\"}"
    }
}

Weitere Informationen finden Sie unter Gruppen aktualisieren im AWS Resource Groups User Guide.

Einzelheiten zur API finden Sie UpdateGroupQueryin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-group.

AWS CLI

Um die Beschreibung für eine Ressourcengruppe zu aktualisieren

Im folgenden update-group Beispiel wird die Beschreibung für die angegebene Ressourcengruppe aktualisiert.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Gruppen aktualisieren im AWS Resource Groups User Guide.

Einzelheiten zur API finden Sie UpdateGroupin der AWS CLI Befehlsreferenz.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Ressourcen-Explorer

Resource Groups Tagging API