Amazon OpenSearch Service ドメインのタグ付け

タグを使用すると、Amazon OpenSearch Service ドメインに任意の情報を割り当てて、その情報を分類してフィルタリングできます。タグは、 OpenSearch サービスドメインを定義して関連付けるキーと値のペアです。これらのタグを使用して、類似のタグ付けされたリソースの費用をグループ化することでコストを追跡できます。 AWS タグに意味論的意味を適用しません。タグは単なる文字列として解釈されます。タグには、次の要素があります。

タグ要素	説明	必須
タグキー	タグキーは、タグ名です。キーは、アタッチされている OpenSearch サービスドメインで一意である必要があります。タグキーと値の基本的な制限のリストについては、「ユーザー定義タグの制限」を参照してください。	はい
タグ値	タグ値は、タグの文字列値です。タグ値は null を指定できます。また、タグセット内で一意である必要はありません。例えば、project/Trinity と cost-center/Trinity のタグセット内に 1 つのキーと値のペアを使用できます。タグキーと値の基本的な制限のリストについては、「ユーザー定義タグの制限」を参照してください。	いいえ

各 OpenSearch サービスドメインにはタグセットがあり、その OpenSearch サービスドメインに割り当てられたすべてのタグが含まれています。 AWS は OpenSearch サービスドメインにタグを自動的に割り当てません。タグセットには、0～50 個のタグを含めることができます。ドメインに追加したタグのキーが既存のタグのキーと同じ場合、既存の値は新しい値によって上書きされます。

タグ付けの例

キーを使用してカテゴリを定義し、タグ値をそのカテゴリの項目にすることができます。例えば、 のタグキーprojectと のタグ値を定義してSalix、 OpenSearch サービスドメインが Salix プロジェクトに割り当てられていることを示すことができます。タグを使用して、 environment=testや などのキーを使用して、 OpenSearch サービスドメインがテスト用または本番稼働用として指定することもできますenvironment=production。 OpenSearch サービスドメインに関連付けられているメタデータの追跡が簡単になるように、一貫した一連のタグキーを使用してください。

タグを使用して、自分のコスト構造を反映するように AWS 請求書を整理することもできます。これを行うには、サインアップして、タグキー値が含まれた AWS アカウント 請求書を取得します。その後、同じタグキー値を持つリソースに従って請求情報を整理し、結合したリソースのコストを確認します。例えば、複数の OpenSearch サービスドメインにキーと値のペアをタグ付けし、請求情報を整理して、複数のサービスにわたる各ドメインの合計コストを確認できます。詳細については、https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html 請求情報とコスト管理の「AWS コスト配分タグの使用」を参照してください。

注記

タグは承認用にキャッシュに格納されます。このため、 OpenSearch サービスドメインのタグの追加と更新には数分かかることがあります。

タグの操作 (コンソール)

コンソールは、ドメインにタグを付ける最も簡単な方法です。

タグを作成するには (コンソール)

1. https://aws.amazon.com にアクセスし、[コンソールにサインイン] を選択します。

2. 分析 で、Amazon OpenSearch Service を選択します。

3. タグを追加するドメインを選択し、[タグ] タブに移動します。

4. [管理] を選択して、[新しいタグを追加] を選択します。

5. タグキーとオプションの値を入力します。

6. [保存] を選択します。

タグを削除するには、同じ手順に従って、[タグを管理] ページで [削除] を選択します。

タグを操作するコンソールを使用する方法の詳細については、AWS マネジメントコンソール入門ガイドの「タグエディター」を参照してください。

タグの操作 (AWS CLI)

--add-tags コマンド AWS CLI で を使用してリソースタグを作成できます。

[Syntax] (構文)

add-tags --arn=<domain_arn> --tag-list Key=<key>,Value=<value>

パラメータ	説明
--arn	タグがアタッチされている OpenSearch サービスドメインの Amazon リソース名。
--tag-list	スペースで区切られたキーと値のペアの以下の形式のセット: Key=<key>,Value=<value>

例

次の例では、[ログ] ドメイン用に 2 つのタグを作成します。

aws opensearch add-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-list Key=service,Value=OpenSearch Key=instances,Value=m3.2xlarge

--remove-tags コマンドを使用して、 OpenSearch サービスドメインからタグを削除できます。

構文

remove-tags --arn=<domain_arn> --tag-keys Key=<key>,Value=<value>

パラメータ	説明
--arn	タグがアタッチされている OpenSearch サービスドメインの Amazon リソースネーム (ARN)。
--tag-keys	OpenSearch サービスドメインから削除するスペース区切りのキーと値のペアのセット。

例

次の例は、[ログ] ドメインから前述の例で作成した 2 つのタグを削除します。

aws opensearch remove-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-keys service instances

--list-tags コマンドを使用して、 OpenSearch サービスドメインの既存のタグを表示できます。

[Syntax] (構文)

list-tags --arn=<domain_arn>

パラメータ	説明
--arn	タグがアタッチされている OpenSearch サービスドメインの Amazon リソースネーム (ARN)。

例

次の例は、[ログ] ドメインのすべてのリソースタグをリスト表示します。

aws opensearch list-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs

タグの操作 (AWS SDKs

AWS SDKs (Android および iOS SDKs) は、Amazon OpenSearch Service API リファレンス で定義されているすべてのアクションをサポートします。これには、AddTags、ListTags、および RemoveTagsオペレーションが含まれます。 AWS SDKs「 AWS Software Development Kits」を参照してください。

Python

この例では、AWS SDK for Python (Boto) のOpenSearchService低レベル Python クライアントを使用して、ドメインにタグを追加し、ドメインにアタッチされたタグを一覧表示し、ドメインからタグを削除します。DOMAIN_ARN、TAG_KEY および TAG_VALUE の値を指定する必要があります。

import boto3
from botocore.config import Config  # import configuration

DOMAIN_ARN = ''  # ARN for the domain. i.e "arn:aws:es:us-east-1:123456789012:domain/my-domain
TAG_KEY = ''  # The name of the tag key. i.e 'Smileyface'
TAG_VALUE = ''  # The value assigned to the tag. i.e 'Practicetag'

# defines the configurations parameters such as region

my_config = Config(region_name='us-east-1')
client = boto3.client('opensearch', config=my_config)


# defines the client variable

def addTags():
    """Adds tags to the domain"""

    response = client.add_tags(ARN=DOMAIN_ARN,
                               TagList=[{'Key': TAG_KEY,
                                         'Value': TAG_VALUE}])

    print(response)


def listTags():
    """List tags that have been added to the domain"""

    response = client.list_tags(ARN=DOMAIN_ARN)
    print(response)


def removeTags():
    """Remove tags that have been added to the domain"""

    response = client.remove_tags(ARN=DOMAIN_ARN, TagKeys=[TAG_KEY])

    print('Tag removed')
    return response