AWS CLI を使用した License Manager の例
次のコード例は、License Manager で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
トピック
アクション
次のコード例は、create-license-configuration
を使用する方法を示しています。
- AWS CLI
-
例 1: ライセンス設定を作成するには
次の
create-license-configuration
の例では、ハード制限が 10 コアのライセンス設定を作成します。aws license-manager create-license-configuration --name
my-license-configuration
\ --license-counting-typeCore
\ --license-count10
\ --license-count-hard-limit出力:
{ "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111" }
例 2: ライセンス設定を作成するには
次の
create-license-configuration
の例では、ソフト制限が 100 vCPU のライセンス設定を作成します。ルールを使用して vCPU 最適化を有効にします。aws license-manager create-license-configuration --name
my-license-configuration
--license-counting-typevCPU
\ --license-count100
\ --license-rules"#honorVcpuOptimization=true"
出力:
{ "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE2222" }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateLicenseConfiguration
」を参照してください。
-
次のコード例は、delete-license-configuration
を使用する方法を示しています。
- AWS CLI
-
ライセンス設定を削除するには
次の
delete-license-configuration
の例では、指定されたライセンス設定を削除します。aws license-manager delete-license-configuration \ --license-configuration-arn
arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE
このコマンドは何も出力しません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteLicenseConfiguration
」を参照してください。
-
次の例は、get-license-configuration
を使用する方法を説明しています。
- AWS CLI
-
ライセンス設定情報を取得するには
次の
get-license-configuration
の例では、指定されたライセンス設定の詳細を表示します。aws license-manager get-license-configuration \ --license-configuration-arn
arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE
出力:
{ "LicenseConfigurationId": "lic-38b658717b87478aaa7c00883EXAMPLE", "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE", "Name": "my-license-configuration", "LicenseCountingType": "vCPU", "LicenseRules": [], "LicenseCountHardLimit": false, "ConsumedLicenses": 0, "Status": "AVAILABLE", "OwnerAccountId": "123456789012", "ConsumedLicenseSummaryList": [ { "ResourceType": "EC2_INSTANCE", "ConsumedLicenses": 0 }, { "ResourceType": "EC2_HOST", "ConsumedLicenses": 0 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "ConsumedLicenses": 0 } ], "ManagedResourceSummaryList": [ { "ResourceType": "EC2_INSTANCE", "AssociationCount": 0 }, { "ResourceType": "EC2_HOST", "AssociationCount": 0 }, { "ResourceType": "EC2_AMI", "AssociationCount": 2 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "AssociationCount": 0 } ] }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetLicenseConfiguration
」を参照してください。
-
次のコード例は、get-service-settings
を使用する方法を示しています。
- AWS CLI
-
License Manager の設定を取得するには
次の
get-service-settings
の例では、現在のリージョンの License Manager のサービス設定を表示します。aws license-manager get-service-settings
クロスアカウントリソース検出が無効になっている場合の出力例を次に示します。
{ "OrganizationConfiguration": { "EnableIntegration": false }, "EnableCrossAccountsDiscovery": false }
クロスアカウントリソース検出が有効になっている場合の出力例を次に示します。
{ "S3BucketArn": "arn:aws:s3:::aws-license-manager-service-c22d6279-35c4-47c4-bb", "OrganizationConfiguration": { "EnableIntegration": true }, "EnableCrossAccountsDiscovery": true }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetServiceSettings
」を参照してください。
-
次の例は、list-associations-for-license-configuration
を使用する方法を説明しています。
- AWS CLI
-
ライセンス設定の関連付けを取得するには
次の
list-associations-for-license-configuration
の例では、指定されたライセンス設定の関連付けに関する詳細情報を表示します。aws license-manager list-associations-for-license-configuration \ --license-configuration-arn
arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE
出力:
{ "LicenseConfigurationAssociations": [ { "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0", "ResourceType": "EC2_AMI", "ResourceOwnerId": "123456789012", "AssociationTime": 1568825118.617 }, { "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-0abcdef1234567890", "ResourceType": "EC2_AMI", "ResourceOwnerId": "123456789012", "AssociationTime": 1568825118.946 } ] }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListAssociationsForLicenseConfiguration
」を参照してください。
-
次の例は、list-license-configurations
を使用する方法を説明しています。
- AWS CLI
-
例 1: すべてのライセンス設定を一覧表示するには
次の
list-license-configurations
の例では、すべてのライセンス設定を一覧表示します。aws license-manager list-license-configurations
出力:
{ "LicenseConfigurations": [ { "LicenseConfigurationId": "lic-6eb6586f508a786a2ba4f56c1EXAMPLE", "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE", "Name": "my-license-configuration", "LicenseCountingType": "Core", "LicenseRules": [], "LicenseCount": 10, "LicenseCountHardLimit": true, "ConsumedLicenses": 0, "Status": "AVAILABLE", "OwnerAccountId": "123456789012", "ConsumedLicenseSummaryList": [ { "ResourceType": "EC2_INSTANCE", "ConsumedLicenses": 0 }, { "ResourceType": "EC2_HOST", "ConsumedLicenses": 0 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "ConsumedLicenses": 0 } ], "ManagedResourceSummaryList": [ { "ResourceType": "EC2_INSTANCE", "AssociationCount": 0 }, { "ResourceType": "EC2_HOST", "AssociationCount": 0 }, { "ResourceType": "EC2_AMI", "AssociationCount": 0 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "AssociationCount": 0 } ] }, { ... } ] }
例 2: 特定のライセンス設定を一覧表示するには
次の
list-license-configurations
の例では、指定されたライセンス設定のみを一覧表示します。aws license-manager list-license-configurations \ --license-configuration-arns
arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListLicenseConfigurations
」を参照してください。
-
次の例は、list-license-specifications-for-resource
を使用する方法を説明しています。
- AWS CLI
-
リソースのライセンス設定を一覧表示するには
次の
list-license-specifications-for-resource
の例では、指定された Amazon マシンイメージ (AMI) に関連付けられたライセンス設定を一覧表示します。aws license-manager list-license-specifications-for-resource \ --resource-arn
arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0
出力:
{ "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE" }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListLicenseSpecificationsForResource
」を参照してください。
-
次のコード例は、list-resource-inventory
を使用する方法を示しています。
- AWS CLI
-
リソースインベントリ内のリソースを一覧表示するには
次の
list-resource-inventory
の例では、Systems Manager インベントリを使用して管理されるリソースを一覧表示します。aws license-manager list-resource-inventory
出力:
{ "ResourceInventoryList": [ { "Platform": "Red Hat Enterprise Linux Server", "ResourceType": "EC2Instance", "PlatformVersion": "7.4", "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-05d3cdfb05bd36376", "ResourceId": "i-05d3cdfb05bd36376", "ResourceOwningAccountId": "1234567890129" }, { "Platform": "Amazon Linux", "ResourceType": "EC2Instance", "PlatformVersion": "2", "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0b1d036cfd4594808", "ResourceId": "i-0b1d036cfd4594808", "ResourceOwningAccountId": "1234567890129" }, { "Platform": "Microsoft Windows Server 2019 Datacenter", "ResourceType": "EC2Instance", "PlatformVersion": "10.0.17763", "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0cdb3b54a2a8246ad", "ResourceId": "i-0cdb3b54a2a8246ad", "ResourceOwningAccountId": "1234567890129" } ] }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListResourceInventory
」を参照してください。
-
次の例は、list-tags-for-resource
を使用する方法を説明しています。
- AWS CLI
-
ライセンス設定のタグを一覧表示するには
次の
list-tags-for-resource
の例では、指定されたライセンス設定のタグを一覧表示します。aws license-manager list-tags-for-resource \ --resource-arn
arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE
出力:
{ "Tags": [ { "Key": "project", "Value": "lima" } ] }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListTagsForResource
」を参照してください。
-
次の例は、list-usage-for-license-configuration
を使用する方法を説明しています。
- AWS CLI
-
ライセンス設定で使用されているライセンスを一覧表示するには
次の
list-usage-for-license-configuration
の例では、指定されたライセンス設定のライセンスを使用するリソースに関する情報を示します。例えば、ライセンスタイプが vCPU の場合、インスタンスは vCPU ごとに 1 つのライセンスを使用します。aws license-manager list-usage-for-license-configuration \ --license-configuration-arn
arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE
出力:
{ "LicenseConfigurationUsageList": [ { "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-04a636d18e83cfacb", "ResourceType": "EC2_INSTANCE", "ResourceStatus": "running", "ResourceOwnerId": "123456789012", "AssociationTime": 1570892850.519, "ConsumedLicenses": 2 } ] }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListUsageForLicenseConfiguration
」を参照してください。
-
次の例は、tag-resource
を使用する方法を説明しています。
- AWS CLI
-
ライセンス設定にタグを追加するには
次の
tag-resource
の例では、指定されたタグ (キー名と値) を、指定されたライセンス設定に追加します。aws license-manager tag-resource \ --tags
Key=project,Value=lima
\ --resource-arnarn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE
このコマンドは何も出力しません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「TagResource
」を参照してください。
-
次の例は、untag-resource
を使用する方法を説明しています。
- AWS CLI
-
ライセンス設定からタグを削除するには
次の
untag-resource
の例では、指定されたライセンス設定から、指定されたタグ (キー名とリソース) を削除します。aws license-manager untag-resource \ --tag-keys
project
\ --resource-arnarn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE
このコマンドは何も出力しません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResource
」を参照してください。
-
次のコード例は、update-license-configuration
を使用する方法を示しています。
- AWS CLI
-
ライセンス設定を更新するには
次の
update-license-configuration
の例では、指定されたライセンス設定を更新して、ハード制限を削除します。aws license-manager update-license-configuration \ --no-license-count-hard-limit \ --license-configuration-arn
arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE
このコマンドは何も出力しません。
次の
update-license-configuration
の例では、指定されたライセンス設定を更新して、ステータスをDISABLED
に変更します。aws license-manager update-license-configuration \ --license-configuration-status
DISABLED
--license-configuration-arnarn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE
このコマンドは何も出力しません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateLicenseConfiguration
」を参照してください。
-
次のコード例は、update-license-specifications-for-resource
を使用する方法を示しています。
- AWS CLI
-
リソースのライセンス設定を更新するには
次の
update-license-specifications-for-resource
の例では、1 つのライセンス設定を削除して別のライセンス設定を追加することにより、指定された Amazon マシンイメージ (AMI) に関連付けられたライセンス設定を置き換えます。aws license-manager update-license-specifications-for-resource \ --resource-arn
arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0
\ --remove-license-specificationsLicenseConfigurationArn=arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE
\ --add-license-specificationsLicenseConfigurationArn=arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-42b6deb06e5399a980d555927EXAMPLE
このコマンドは何も出力しません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateLicenseSpecificationsForResource
」を参照してください。
-
次のコード例は、update-service-settings
を使用する方法を示しています。
- AWS CLI
-
License Manager の設定を更新するには
次の
update-service-settings
の例では、現在の AWS リージョンで License Manager のクロスアカウントリソース検出を有効にします。Amazon S3 バケットは、Systems Manager インベントリに必要なリソースデータ同期です。aws license-manager update-service-settings \ --organization-configuration
EnableIntegration=true
\ --enable-cross-accounts-discovery \ --s3-bucket-arnarn:aws:s3:::aws-license-manager-service-abcd1234EXAMPLE
このコマンドは何も出力しません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateServiceSettings
」を参照してください。
-