Key Management Service:Secrets Manager Client

ステップ 1：RAM ロールの作成と権限の構成

ステップ 2：環境変数または設定ファイルの設定

SDK は、アクセス認証情報を取得するための以下の 2 つの方法をサポートしています。

• 環境変数：オペレーティングシステムごとに設定方法が異なります。詳細については、をご参照ください。

  警告

  パラメーター名を変更しないでください。変更すると、SDK が認識できなくなります。

• 設定ファイル：デフォルトの設定ファイルは secretsmanager.properties です (ファイル名は変更できません)。アプリケーションが設定ファイルを正しくロードできるように、適切な設定ディレクトリに配置してください。言語別の一般的な設定ディレクトリは以下のとおりです。

  • Java：src/main/resources ディレクトリに設定ファイルを配置すると、コンパイル時にクラスパスに自動的に含まれます。

  • Go：プロジェクトルートディレクトリまたは専用の config ディレクトリに設定ファイルを配置し、コードを通じてロードします。

  • Python：プロジェクトディレクトリまたは特定の config ディレクトリに設定ファイルを配置し、適切な方法 (os.path や pkg_resources など) を使用してロードします。

• カスタム設定ファイルを使用する場合は、クライアント初期化時にファイルパス (#customConfigFileName#) を指定する必要があります。

ステップ 1：AccessKey の作成と権限の構成

ステップ 2：環境変数または設定ファイルの設定

SDK は、アクセス認証情報を取得するための以下の 2 つの方法をサポートしています。

• 環境変数：オペレーティングシステムごとに設定方法が異なります。詳細については、をご参照ください。

  警告

  パラメーター名を変更しないでください。変更すると、SDK が認識できなくなります。

• 設定ファイル：デフォルトの設定ファイルは secretsmanager.properties です (ファイル名は変更できません)。アプリケーションが設定ファイルを正しくロードできるように、適切な設定ディレクトリに配置してください。言語別の一般的な設定ディレクトリは以下のとおりです。

  • Java：src/main/resources ディレクトリに設定ファイルを配置すると、コンパイル時にクラスパスに自動的に含まれます。

  • Go：プロジェクトルートディレクトリまたは専用の config ディレクトリに設定ファイルを配置し、コードを通じてロードします。

  • Python：プロジェクトディレクトリまたは特定の config ディレクトリに設定ファイルを配置し、適切な方法 (os.path や pkg_resources など) を使用してロードします。

• カスタム設定ファイルを使用する場合は、クライアント初期化時にファイルパス (#customConfigFileName#) を指定する必要があります。

ステップ 1：OIDC ロール ARN の作成と権限の構成

ステップ 2：環境変数または設定ファイルの設定

SDK は、アクセス認証情報を取得するための以下の 2 つの方法をサポートしています。

• 環境変数：オペレーティングシステムごとに設定方法が異なります。詳細については、をご参照ください。

  警告

  パラメーター名を変更しないでください。変更すると、SDK が認識できなくなります。

• 設定ファイル：デフォルトの設定ファイルは secretsmanager.properties です (ファイル名は変更できません)。アプリケーションが設定ファイルを正しくロードできるように、適切な設定ディレクトリに配置してください。言語別の一般的な設定ディレクトリは以下のとおりです。

  • Java：src/main/resources ディレクトリに設定ファイルを配置すると、コンパイル時にクラスパスに自動的に含まれます。

  • Go：プロジェクトルートディレクトリまたは専用の config ディレクトリに設定ファイルを配置し、コードを通じてロードします。

  • Python：プロジェクトディレクトリまたは特定の config ディレクトリに設定ファイルを配置し、適切な方法 (os.path や pkg_resources など) を使用してロードします。

• カスタム設定ファイルを使用する場合は、クライアント初期化時にファイルパス (#customConfigFileName#) を指定する必要があります。

ステップ 1：RAM ロール ARN の作成と権限の構成

ステップ 2：環境変数または設定ファイルの設定

SDK は、アクセス認証情報を取得するための以下の 2 つの方法をサポートしています。

• 環境変数：オペレーティングシステムごとに設定方法が異なります。詳細については、をご参照ください。

  警告

  パラメーター名を変更しないでください。変更すると、SDK が認識できなくなります。

• 設定ファイル：デフォルトの設定ファイルは secretsmanager.properties です (ファイル名は変更できません)。アプリケーションが設定ファイルを正しくロードできるように、適切な設定ディレクトリに配置してください。言語別の一般的な設定ディレクトリは以下のとおりです。

  • Java：src/main/resources ディレクトリに設定ファイルを配置すると、コンパイル時にクラスパスに自動的に含まれます。

  • Go：プロジェクトルートディレクトリまたは専用の config ディレクトリに設定ファイルを配置し、コードを通じてロードします。

  • Python：プロジェクトディレクトリまたは特定の config ディレクトリに設定ファイルを配置し、適切な方法 (os.path や pkg_resources など) を使用してロードします。

• カスタム設定ファイルを使用する場合は、クライアント初期化時にファイルパス (#customConfigFileName#) を指定する必要があります。

cache_client_dkms_config_info のパラメーター

デフォルト構成の使用

SDK は、secretsmanager.properties ファイルまたは環境変数から認証情報情報を自動的に読み取ります。

import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClient;
import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClientBuilder;
import com.aliyuncs.kms.secretsmanager.client.V2.0.exception.CacheSecretException;
import com.aliyuncs.kms.secretsmanager.client.V2.0.model.SecretInfo;

public class CacheClientEnvironmentSample {

    public static void main(String[] args) {
        try {
            SecretCacheClient client = SecretCacheClientBuilder.newClient();
            SecretInfo secretInfo = client.getSecretInfo("#secretName#");
            System.out.println(secretInfo);
        } catch (CacheSecretException e) {
            e.printStackTrace();
        }
    }
}
          

カスタム設定ファイルの使用

設定ファイルがデフォルトのファイル名またはパスを使用していない場合に、この方法を使用します。設定ファイルパス (#customConfigFileName#) を指定します。

import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClient;
import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClientBuilder;
import com.aliyuncs.kms.secretsmanager.client.V2.0.exception.CacheSecretException;
import com.aliyuncs.kms.secretsmanager.client.V2.0.model.SecretInfo;
import com.aliyuncs.kms.secretsmanager.client.V2.0.service.BaseSecretManagerClientBuilder;

public class CacheClientCustomConfigFileSample {

    public static void main(String[] args) {
        try {
            SecretCacheClient client = SecretCacheClientBuilder.newCacheClientBuilder(
                    BaseSecretManagerClientBuilder.standard()
                        .withCustomConfigFile("#customConfigFileName#")
                        .build())
                    .build();
            SecretInfo secretInfo = client.getSecretInfo("#secretName#");
            System.out.println(secretInfo);
        } catch (CacheSecretException e) {
            System.out.println("CacheSecretException: " + e.getMessage());
        }
    }
}
          

ハードコーディングされた認証情報の使用

この方法では、クライアント初期化時に AccessKey およびリージョン情報を直接渡すため、設定ファイルまたは環境変数に AccessKey を書き込む必要がありません。

import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClient;
import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClientBuilder;
import com.aliyuncs.kms.secretsmanager.client.V2.0.exception.CacheSecretException;
import com.aliyuncs.kms.secretsmanager.client.V2.0.model.RegionInfo;
import com.aliyuncs.kms.secretsmanager.client.V2.0.service.BaseSecretManagerClientBuilder;
import com.aliyuncs.kms.secretsmanager.client.V2.0.utils.CredentialsProviderUtils;

public class CacheClientWithCaCertificateSample {
    public static void main(String[] args) {
        try {
            // CA 証明書パスを含む RegionInfo を作成
            RegionInfo regionInfo = new RegionInfo();
            regionInfo.setRegionId("#regionId#");
            // 専用ゲートウェイエンドポイント。共有ゲートウェイを使用する場合は省略。
            regionInfo.setEndpoint("<your_kms_instance_id>.cryptoservice.kms.aliyuncs.com");

            SecretCacheClient client = SecretCacheClientBuilder.newCacheClientBuilder(
                    BaseSecretManagerClientBuilder.standard()
                            .withCredentialsProvider(CredentialsProviderUtils.withAccessKey(
                                    System.getenv("#accessKeyId#"),
                                    System.getenv("#accessKeySecret#")))
                            .addRegion(regionInfo)
                            .build())
                    .build();
            SecretInfo secretInfo = client.getSecretInfo("#secretName#");
        } catch (CacheSecretException e) {
            e.printStackTrace();
        }
    }
}
          

Alibaba Cloud デフォルト認証情報プロバイダーチェーン の使用

デフォルト認証情報プロバイダーチェーンは、フォールバック戦略です。認証情報が見つかるまで、事前定義された順序で認証情報を検索します。すべての方法が失敗した場合、認証は失敗し、認証情報を取得できません。

import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClient;
import com.aliyuncs.kms.secretsmanager.client.V2.0.SecretCacheClientBuilder;
import com.aliyuncs.kms.secretsmanager.client.V2.0.exception.CacheSecretException;
import com.aliyuncs.kms.secretsmanager.client.V2.0.model.SecretInfo;
import com.aliyuncs.kms.secretsmanager.client.V2.0.service.BaseSecretManagerClientBuilder;

public class CacheClientDefaultCredentialChainSample {

    public static void main(String[] args) {
        try {
            SecretCacheClient client = SecretCacheClientBuilder.newCacheClientBuilder(
                    BaseSecretManagerClientBuilder.standard()
                        .withRegion("#regionId#")
                        .build())
                    .build();
            SecretInfo secretInfo = client.getSecretInfo("#secretName#");
            System.out.println(secretInfo);
        } catch (CacheSecretException e) {
            e.printStackTrace();
        }
    }
}
          

デフォルト構成の使用

SDK は、secretsmanager.properties ファイルまたは環境変数から認証情報情報を自動的に読み取ります。

from alibabacloud_secretsmanager_client_V2.0.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder

if __name__ == '__main__':
    secret_cache_client = SecretManagerCacheClientBuilder.new_client()
    secret_info = secret_cache_client.get_secret_info("#secretName#")
    print(secret_info.__dict__)
          

カスタム設定ファイルの使用

設定ファイルがデフォルトのファイル名またはパスを使用していない場合に、この方法を使用します。

from alibabacloud_secretsmanager_client_V2.0.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
from alibabacloud_secretsmanager_client_V2.0.service.default_secret_manager_client_builder import DefaultSecretManagerClientBuilder

if __name__ == '__main__':
    secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(
        DefaultSecretManagerClientBuilder.standard()
            .with_custom_config_file("#customConfigFileName#")
            .build()
    ).build()
    secret_info = secret_cache_client.get_secret_info("#secretName#")
    print(secret_info.__dict__)
          

ハードコーディングされた認証情報の使用

この方法では、クライアント初期化時に AccessKey およびリージョン情報を直接渡します。

import os

from alibabacloud_secretsmanager_client_V2.0.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
from alibabacloud_secretsmanager_client_V2.0.service.default_secret_manager_client_builder import \
    DefaultSecretManagerClientBuilder
from alibabacloud_secretsmanager_client_V2.0.model.region_info import RegionInfo

if __name__ == '__main__':
    # CA 証明書パスを含む RegionInfo を作成
    region_info = RegionInfo(
        region_id="#regionId#",
        endpoint="#kmsInstanceEndpoint#",  # 専用ゲートウェイエンドポイント。共有ゲートウェイを使用する場合は省略。
    )
    secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(
        DefaultSecretManagerClientBuilder.standard()
            .with_access_key(
                os.getenv("#accessKeyId#"),
                os.getenv("#accessKeySecret#")
            )
            .add_region_info(region_info)
            .build()
    ).build()
    # ... クライアントを使用
          

Alibaba Cloud デフォルト認証情報プロバイダーチェーン の使用

from alibabacloud_secretsmanager_client_V2.0.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
from alibabacloud_secretsmanager_client_V2.0.service.default_secret_manager_client_builder import DefaultSecretManagerClientBuilder

if __name__ == '__main__':
    secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(
        DefaultSecretManagerClientBuilder.standard()
            .with_region("#regionId#")
            .build()
    ).build()
    secret_info = secret_cache_client.get_secret_info("#secretName#")
    print(secret_info.__dict__)
          

デフォルト構成の使用

package main

import "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk"

func main() {
    client, err := sdk.NewClient()
    if err != nil {
        // 例外を処理
        panic(err)
    }
    secretInfo, err := client.GetSecretInfo("#secretName#")
    if err != nil {
        // 例外を処理
        panic(err)
    }
}
          

カスタム設定ファイルの使用

package main

import (
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk"
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk/service"
)

func main() {
    client, err := sdk.NewSecretCacheClientBuilder(
            service.NewDefaultSecretManagerClientBuilder().Standard().
                WithCustomConfigFile("#customConfigFileName#").Build()).Build()
    if err != nil {
        // 例外を処理
        panic(err)
    }
    secretInfo, err := client.GetSecretInfo("#secretName#")
    if err != nil {
        // 例外を処理
        panic(err)
    }
}
          

ハードコーディングされた認証情報の使用

package main

import (
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk"
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk/models"
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk/service"
    "os"
)

func main() {
    regionInfo := &models.RegionInfo{
        RegionId: "#regionId#",
        // 専用ゲートウェイエンドポイント。共有ゲートウェイを使用する場合は省略。
        Endpoint: "<kmsInstanceId>.cryptoservice.kms.aliyuncs.com",
    }

    client, err := sdk.NewSecretCacheClientBuilder(
        service.NewDefaultSecretManagerClientBuilder().
            Standard().
            WithAccessKey(os.Getenv("#accessKeyId#"), os.Getenv("#accessKeySecret#")).
            AddRegionInfo(regionInfo).
            Build()).Build()
    if err != nil {
        // 例外を処理
        panic(err)
    }
    secretInfo, err := client.GetSecretInfo("#secretName#")
    if err != nil {
        // 例外を処理
        panic(err)
    }
}
          

Alibaba Cloud デフォルト認証情報プロバイダーチェーン の使用

package main

import (
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk"
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-V2.0/sdk/service"
)

func main() {
    client, err := sdk.NewSecretCacheClientBuilder(
            service.NewDefaultSecretManagerClientBuilder().Standard().
                WithRegion("#regionId#").Build()).Build()
    if err != nil {
        // 例外を処理
        panic(err)
    }
    secretInfo, err := client.GetSecretInfo("#secretName#")
    if err != nil {
        // 例外を処理
        panic(err)
    }
}
          

デフォルト構成の使用

SDK は、secretsmanager.properties ファイルまたは環境変数から認証情報情報を自動的に読み取ります。

import { SecretCacheClientBuilder } from 'alibabacloud-secretsmanager-client-v2';

async function example() {
  try {
    // 環境変数またはデフォルト構成経由でクライアントをビルド
    const client = await SecretCacheClientBuilder.newClient();
    const secretInfo = await client.getSecretInfo('#secretName#');
    console.log(secretInfo);
  } catch (error) {
    console.error('Error:', error);
  }
}

example();

カスタム設定ファイルの使用

設定ファイルがデフォルトのファイル名またはパスを使用していない場合に、この方法を使用します。設定ファイルパスを指定します。

import {
  SecretCacheClientBuilder,
  BaseSecretManagerClientBuilder,
  CredentialsProviderUtils
} from 'alibabacloud-secretsmanager-client-v2';

async function example() {
  try {
    const client = await SecretCacheClientBuilder.newCacheClientBuilder(
      BaseSecretManagerClientBuilder.standard().withCustomConfigFile('#customConfigFileName#').build()
    ).build();

    const secretInfo = await client.getSecretInfo('#secretName#');
    console.log(secretInfo);
  } catch (error) {
    console.error('Error:', error);
  }
}

example();

ハードコーディングされた認証情報の使用

この方法では、クライアント初期化時に AccessKey およびリージョン情報を直接渡します。

import {
  SecretCacheClientBuilder,
  BaseSecretManagerClientBuilder,
  CredentialsProviderUtils,
  RegionInfo
} from 'alibabacloud-secretsmanager-client-v2';

async function example() {
  try {
    // CA 証明書パスを含む RegionInfo を作成
    const regionInfo = new RegionInfo();
    regionInfo.setRegionId('#regionId#');
    regionInfo.setEndpoint('#kmsInstanceEndpoint#'); // KMS インスタンスアドレスを指定
    
    const client = await SecretCacheClientBuilder.newCacheClientBuilder(
        BaseSecretManagerClientBuilder.standard()
          .withCredentialsProvider(
            CredentialsProviderUtils.withAccessKey(
              process.env['#accessKeyId#'],
              process.env['#accessKeySecret#']
            )
        )
        .addRegionInfo(regionInfo) // CA 証明書パスを含む RegionInfo を使用
        .build()
    ).build();

    const secretInfo = await client.getSecretInfo('#secretName#');
    console.log(secretInfo);
  } catch (error) {
    console.error('Error:', error);
  }
}

example();

Alibaba Cloud デフォルト認証情報プロバイダーチェーン の使用

import {
  SecretCacheClientBuilder,
  BaseSecretManagerClientBuilder,
  CredentialsProviderUtils
} from 'alibabacloud-secretsmanager-client-v2';

async function example() {
  try {
    const client = await SecretCacheClientBuilder.newCacheClientBuilder(
      BaseSecretManagerClientBuilder.standard()
        .withCredentialsProvider(CredentialsProviderUtils.withDefaultCredential())
        .withRegion('#regionId#')
        .build()
    ).build();

    const secretInfo = await client.getSecretInfo('#secretName#');
    console.log(secretInfo);
  } catch (error) {
    console.error('Error:', error);
  }
}

example();