Tools for PowerShell V4 を使用した ACM の例 - AWS Tools for PowerShell (バージョン 4)
アクション

AWS Tools for PowerShell のバージョン 5 (V5) がリリースされました。

新しいバージョンのツールの使用を開始するには、「AWS Tools for PowerShell ユーザーガイド (V5)」、特に V5 への移行に関するトピックを参照してください。

Tools for PowerShell V4 を使用した ACM の例

次のコード例では、ACM で AWS Tools for PowerShell V4 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

次の例は、Get-ACMCertificate を使用する方法を説明しています。

Tools for PowerShell V4

例 1: この例では、証明書の ARN を使用して証明書とそのチェーンを返す方法を示します。

Get-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"

  • API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V4)」の「GetCertificate」を参照してください。

次の例は、Get-ACMCertificateDetail を使用する方法を説明しています。

Tools for PowerShell V4

例 1: 指定した証明書の詳細を返します。

Get-ACMCertificateDetail -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"

出力:

CertificateArn          : arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
CreatedAt               : 1/21/2016 5:55:59 PM
DomainName              : www.example.com
DomainValidationOptions : {www.example.com}
InUseBy                 : {}
IssuedAt                : 1/1/0001 12:00:00 AM
Issuer                  :
KeyAlgorithm            : RSA-2048
NotAfter                : 1/1/0001 12:00:00 AM
NotBefore               : 1/1/0001 12:00:00 AM
RevocationReason        :
RevokedAt               : 1/1/0001 12:00:00 AM
Serial                  :
SignatureAlgorithm      : SHA256WITHRSA
Status                  : PENDING_VALIDATION
Subject                 : CN=www.example.com
SubjectAlternativeNames : {www.example.net}

  • API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V4)」の「DescribeCertificate」を参照してください。

次の例は、Get-ACMCertificateList を使用する方法を説明しています。

Tools for PowerShell V4

例 1: すべての証明書 ARN と各 ARN のドメイン名のリストを取得します。コマンドレットは自動的にページ分割され、すべての ARN を取得します。ページ分割を手動で制御するには、-MaxItem パラメータを使用して各サービス呼び出しに対して返される証明書 ARN の数を制御し、-NextToken パラメータを使用して各呼び出しの開始点を示します。

Get-ACMCertificateList

出力:

CertificateArn                                                                      DomainName
--------------                                                                      ----------
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 www.example.com

例 2: 指定した状態に証明書の状態が一致するすべての証明書 ARN のリストを取得します。

Get-ACMCertificateList -CertificateStatus "VALIDATION_TIMED_OUT","FAILED"

例 3: この例では、キータイプが RSA_2048、拡張キーの使用法または目的が CODE_SIGNING である、us-east-1 リージョン内のすべての証明書のリストを返します。これらのフィルタリングパラメータの値については、API リファレンスの「ListCertificates Filters」トピック (https://docs.aws.amazon.com/acm/latest/APIReference/API_Filters.html) を参照してください。

Get-ACMCertificateList -Region us-east-1 -Includes_KeyType RSA_2048 -Includes_ExtendedKeyUsage CODE_SIGNING

出力:

CertificateArn                                                                      DomainName                
--------------                                                                      ----------                
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-d7c0-48c1-af8d-2133d8f30zzz *.route53docs.com
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-98a5-443d-a734-800430c80zzz nerdzizm.net               
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-2be6-4376-8fa7-bad559525zzz                           
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-e7ca-44c5-803e-24d9f2f36zzz                           
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-1241-4b71-80b1-090305a62zzz                           
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-8709-4568-8c64-f94617c99zzz                           
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-a8fa-4a61-98cf-e08ccc0eezzz                           
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-fa47-40fe-a714-2d277d3eezzz *.route53docs.com

  • API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V4)」の「ListCertificates」を参照してください。

次の例は、New-ACMCertificate を使用する方法を説明しています。

Tools for PowerShell V4

例 1: 新しい証明書を作成します。サービスは新しい証明書の ARN を返します。

New-ACMCertificate -DomainName "www.example.com"

出力:

arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

例 2: 新しい証明書を作成します。サービスは新しい証明書の ARN を返します。

New-ACMCertificate -DomainName "www.example.com" -SubjectAlternativeName "example.com","www.example.net"

出力:

arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

  • API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V4)」の「RequestCertificate」を参照してください。

次の例は、Remove-ACMCertificate を使用する方法を説明しています。

Tools for PowerShell V4

例 1: 指定された ARN で識別される証明書および関連するプライベートキーを削除します。コマンドレットは、操作を続行する前に確認を求めます。確認を表示しないようにするには、-Force スイッチを追加します。

Remove-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"

  • API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V4)」の「DeleteCertificate」を参照してください。

次の例は、Send-ACMValidationEmail を使用する方法を説明しています。

Tools for PowerShell V4

例 1: 「www.example.com」のドメイン所有権を検証する E メールの送信をリクエストします。シェルの $ConfirmPreference が「Medium」以下に設定されている場合、コマンドレットは続行する前に確認を求めます。-Force スイッチを追加すると、確認プロンプトが表示されなくなります。

$params = @{
    CertificateArn="arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
    Domain="www.example.com"
    ValidationDomain="example.com"    
}        
Send-ACMValidationEmail @params

  • API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V4)」の「ResendValidationEmail」を参照してください。